hgthecode / thinkphp-apidoc Goto Github PK

ThinkPHP 注释自动生成API文档，在线调试，代码生成器，Markdown文档

Home Page: https://hgthecode.github.io/thinkphp-apidoc/

License: MIT License

PHP 100.00%

thinkphp-apidoc's Introduction

注意、注意、注意！！！

本项目已迁移至 https://github.com/HGthecode/apidoc-php ，全新Apidoc兼容ThinkPHP、Laravel、Hyperf、Webman等基于Composer的PHP框架，更多实用功能。本项目不再维护，请移步新项目。

ThinkPHP ApiDoc

基于 ThinkPHP 的API接口开发工具

🤷‍♀️ Apidoc是什么？

如今，前后端分离的开发模式以必不可少，基于ThinkPHP可以很方便的作为Api接口的开发。可是一个Api开发过程中需要快速调试，开发完成后需要给其它开发者对接等，这时一个功能全面的Api文档工具，就显得特别重要。

大多数开发者可能都是通过各种工具配合来达到这一目的，其各种工具的安装和配置也是繁琐。甚至还有通过word等文本工具手写api文档的，这样的开发效率与可维护性是非常差的。

综合种种Api开发中的痛点，我们专为ThinkPHP开发了Apidoc的扩展，本插件可通过简单的注解即可生成Api文档，及帮助开发者提高生产效率的在线调试、快速生成Crud、一键生成整个模块Api等，涵盖Api开发方方面面。

✨特性

开箱即用：无繁杂的配置、安装后按文档编写注释即可自动生成API文档。
在线调试：在线文档可直接调试，支持全局参数、Mock调试数据、事件执行，接口调试省时省力。
轻松使用：支持公共注释定义、业务逻辑层、数据表字段等引用，几句注释即可完成。
安全高效：支持访问密码验证、应用/版本独立密码；支持文档缓存。
多应用/多版本：可适应各种单应用、多应用、多版本的项目的Api管理。
Markdown文档：支持.md文件的文档展示。
控制器分组：支持控制器多级分组，更精细化管理接口目录。
多语言：可结合TP多语言能力，实现接口文档的语言切换。

📌兼容

ThinkPHP 5.1

ThinkPHP 6.x

📖使用文档

ThinkPHP ApiDoc V3.x文档

🏆支持我们

如果本项目对您有所帮助，请点个Star支持我们

Github ->
Gitee ->

💡鸣谢

ThinkPHP

doctrine/annotations

🔗链接

ApiDoc UI

ApiDoc Demo

thinkphp-apidoc's People

Contributors

Stargazers

Watchers

thinkphp-apidoc's Issues

在linux服务器下找不到控制器

Class "Banner" does not exist
code: -1
file: "/～～～～～～vendor/hg/apidoc/src/ParseAnnotation.php"
line: 28
message: "Class "Banner" does not exist"
name: "ReflectionException"

在调试时,调试路径多了一个目录,如何配置?

API接口地址: /shop/user.User/getChildren
访问时的路径: host/index.php/shop/shop/user.User/getChildren
正确的地址: host/index.php/shop/user.User/getChildren

这里多了一个 shop
请问如何配置
apidoc.php中的apps如下配置
[ 'title' => 'shop端', 'path' => 'app\shop\controller', 'folder' => 'shop', 'groups' => [ ['title' => '基础模块', 'name' => 'base'], ['title' => '功能模块', 'name' => 'function'], ], ]

前端 config.js
HOSTS: [ { title: "shop", host: "http://test.com" }, ],

1.1.1版本漏了全部分组

左侧分组显示不正常，漏写全部

@AddField 可以添加ref类型嘛

如题，谢谢！

如何避免和showdoc混用引发的问题

[Semantical Error] The annotation "@catalog" in method app\api\controller\appdesigner\Order::add() was never imported. Did you maybe forget to add a "use" statement for this annotation?

tp5使用v1版本没有生config/apidoc.php文件

tp5使用v1版本没有生config/apidoc.php文件，另外，下载前端页面链接失效.

配置无API 列表，多级目录

文件目录：

application
    maintain
        home
            api
               User.php

配置文件:config/apidoc.php
apps 配置
'apps' => [
['title'=>'API 接口','path'=>'app\maintain\home\api','folder'=>'api'],
]

User.php 命名空间：app\maintain\home\api;

User.php 内容:

/**
 * @Apidoc\Title("基础的注释方法")
 * @Apidoc\Desc("最基础的接口注释写法")
 * @Apidoc\Method("GET")
 * @Apidoc\Author("HG-CODE")
 * @Apidoc\Tag("测试")
 * @Apidoc\Param("username", type="abc",require=true, desc="用户名")
 * @Apidoc\Param("password", type="string",require=true, desc="密码")
 * @Apidoc\Param("phone", type="string",require=true, desc="手机号")
 * @Apidoc\Param("sex", type="int",default="1",desc="性别" )
 * @Apidoc\Returned("id", type="int", desc="用户id")
 */

public function login()
{}

api 请求地址: http:// host /maintain/api.user/login

请问如何配置，目前配置没有API列表

新版本希望还有CRUD

多版本是怎么配置的？

接口不支持分组？

接口层分组不起作用？另外DELETE请求样式有点问题。描述文字被遮住了。

调试页面post数据的方式，希望可以配置，之不是只能application/json格式

例如：application/x-www-form-urlencoded

找了很久没找到联系方式

阅读了您写的，使用Github Actions 实现TP6自动化部署，收益匪浅，准备把项目的部署方式改为 actions。

但是运行到

这里报错了，请问具体原因是什么导致的呢？

为啥安装了，api页面显示不出API列表

重新安装了，api页面显示正常，后台配置信息前台也能正常显示和使用，控制器注释按照格式写的，但是api页面就是不显示API列表，左侧空白

格式规范

深层对象的格式不规范

请求参数类型ParamType("formdata")时，全局参数获取不到值

用After(event="setGlobalParam"）事件设置一个全局参数并赋值,当请求参数类型为formdata时，调试其他接口，全局参数没有值，使用默认请求类型时有值。

是否支持restful格式接口呢

翻了几遍文档，没看到如何支持restful格式的接口，@apidoc\Param只能用query来接收

composer require hg/apidoc 安装不了提示没有包是为什么

请问有没有支持可以下载导出接口文档的功能

如题:请问有没有支持可以下载导出接口文档的功能,,这样的话,就可以直接下载给对外的人了, 或者类似swagger那种,导出文件可以离线看

多应用多域名

多应用多域名，要怎么设置呢

php >=8.0 but your php version (7.4.26) does not satisfy that requirement.

建议增加8.0版本支持

Url自动生成优化建议

多应用模式下自动生成的url总是会附带app字符，导致访问地址不正确，建议增加个配置，可以去掉自动附带app。
例如 host/nm/comm/index.php 自动生成的url为 host/app/nm/comm/index.php
在实际开发中，基本上url都是不需要重新定义的，期望自动生成时也能正确。

500错误，没有具体信息

不支持PHP8

多级控制器bug修复代码

protected function autoCreateUrl($method): string
{
    $isAuto = Config::get('controller_auto_search')||in_array('controller_auto_search',$this->config);
    $pathArr = [];
    if ($isAuto){
        $pathArr = explode("\\", $method->class );
    }else{
        $searchString = $this->controller_layer . '\\';
        $substr = substr(strstr($method->class, $searchString), strlen($searchString));
        $pathArr = explode("\\", str_replace($substr, str_replace('\\', '.', $substr), $method->class));
    }
    // 控制器地址
    $filterPathNames = array("app", $this->controller_layer);
    $classPathArr = [];
    foreach ($pathArr as $item) {
        if (!in_array($item, $filterPathNames)) {
            $classPathArr[] = $item;
        }
    }

    $classPath = implode('/', $classPathArr);

    return '/' . strtolower($classPath) . '/' . $method->name;
}