The thinkphp-apidoc from hgthecode

在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"

markdown文档配置docs不支持{:version}么？配置了好像不生效

thinkphp6框架下app同级目录下添加一个插件目录addon的话，访问 http://你的域名/apidoc/ 没有出现预期页面

thinkphp6框架下app同级目录下添加一个插件目录addon的话，那么配置好前端页面和config下的apidoc.php后，访问：thinkphp6框架下app同级目录下添加一个插件目录addon的话，没有打开预期页面,而是会跳转到addon目录里面去，报错如下：控制器不存在:addon\apidoc\controller\Index

如何在基类或者控制器统一加上@Apidoc\Header("Authorization", require=true, desc="Token")

比如说，我的控制器有很多方法，有什么办法可以不用每个方法都加上
@apidoc\Header("Authorization", require=true, desc="Token")

找了很久没找到联系方式

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

但是运行到

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

深层对象的格式不规范

多级控制器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;
}

配置无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列表

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

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

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

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" }, ],

这个路径有问题多了个apidoc

执行提交的时候，这个路径有问题多了个apidoc
http://tp2021:8888/apidoc/admin_api/Login/index 错误
应该是
http://tp2021:8888/admin_api/Login/index

错误URL
http://tp2021:8888/apidoc/admin_api/Login/index?username=teset&password=123456&phone=111111&sex=1

怎么没token方式效验

看见访问api目前只是密码效验，这个固定的密码不安全吧，抓包一下获取就完了，应该用token效验，

Url自动生成优化建议

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

同一个控制器下,进行方法分类

如题,有时候同一个模块功能,方法都写在同一个控制器里,可是该模块下,有多个子模块,想要进行继续分组, ,好像除了新建多一个控制器之外,没办法实现了,.有一些旧的控制器,想要补充注释 ,新增加文档,变得很难,,因为已经写在一个控制器里面了,除非要前后端改动,,,获取新方法

自定义目录生成控制器配置无效

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

父类方法生成url有bug

父类方法生成url的bug。我直接传$refClass autoCreateUrl($refClass,$method)解决url生成bug

接口不支持分组？

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

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

建议增加8.0版本支持

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

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

1.1.1版本漏了全部分组

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

建议新增Header通用注释

复制文档的代码也生成不了文档，改配置文件却有用

500错误，没有具体信息

是否支持restful格式接口呢

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

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

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

多应用多版本应用名称为下划线会存在问题。

如题，ooxx_aaa_vvv
[ 'title'=>'xxxxx子系统', 'folder'=>'ooxx_aaa_vvv', 'items'=>[ ['title'=>'V1.0','path'=>'app\ooxx_aaa_vvv\controller\v1','folder'=>'v1'], ['title'=>'V2.0','path'=>'app\ooxx_aaa_vvv\controller\v2','folder'=>'v2'] ] ],
版本切换时会有问题读不到配置

代码之前带有注释会解析错误

因为是老项目，接口文档都是慢慢补

调试需要token认证的接口时，token认证错误

调试需要token认证的接口（get方式）时，请求header中 Authorization使用Bearer token时，token中的空格被转码为%20导致接口认为token格式错误：

Mock调试数据，增加手机号、身份证号自动生成规则

希望 Mock调试数据，能增加手机号、身份证号自动生成规则，更加方便调试。谢谢

切换分组时会报404错误，应该切换时关闭tab保证不加载不存在页面

如图所示

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

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

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

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

如何避免和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?

hgthecode / thinkphp-apidoc Goto Github PK

thinkphp-apidoc's People

Stargazers

Watchers

Forkers

thinkphp-apidoc's Issues

深层对象的格式不规范

如下图,我不想让别人看到我的控制器名称

Recommend Projects

Recommend Topics

Recommend Org