daodao97 / apidog Goto Github PK

View Code? Open in Web Editor NEW

151.0 151.0 29.0 689 KB

Api Watch Dog, Hyperf 框架的 Api参数校验和 swagger 生成组件

License: MIT License

PHP 94.38% HTML 5.62%

hyperf php swagger swoole

apidog's People

Contributors

Stargazers

Watchers

apidog's Issues

[bug] 使用 Hyperf 中自定义的验证规则无效

自定义验证规则文档

通过自定义的方式, 添加了验证规则, 在 Request 中是有效的, 但是在使用了 APIDOG 的时候, 会提示规则不存在

ApiResponse schema的数据data如何使用list

ApiReponse的data list 不是显示的userIInfoDetail的definition的值，而是显示的{$refs: "UserInfoDetail"}这个string

required的判定

apidog/src/Annotation/Param.php

Lines 35 to 40 in 32be225

 public function setRequire() 

 { 

 $this->required = strpos($this->rule, 'required') !== false; 

 return $this; 

 }

此处的 required 判定是否加上 | 符号比较好？因为像 required_if 之类的规则，会在 swagger-ui 前端就被拦截提交，不好做测试。不知 swagger 是否能实现这种关联检测的判定。

关于自定义错误提示

如果想对参数某一规则做地定义错误描述，是否只能通过callback的方式来检验？如 required 规则，我希望只提示说 参数错误 而不提示具体的字段名称。

这个api注解支持多server吗，在@ApiController(server="")好像没用啊

这个api注解支持多server吗，在@APIController(server="")好像没用啊

怎样配置结果示例 example

源码里面，将 example 设置成了字段 type 。。。可是需要在接口文档里显示示例数据，应该肿么写 ApiResponse？

在demo中，对于传入的header注解：@Header(key="token|接口访问凭证", rule="required")。当进行header规则验证的时候，会将该key的首字符大写。
ValidationApi.php：128
$real_headers[implode('-', array_map('ucfirst', explode('-', $key)))] = $val;
因此注解中@Header(key="token|接口访问凭证", rule="required") 如果首字母是小写的，会报错：
[ERROR] 接口访问凭证字段是必须的[69] in /var/workspace/hyperf-skeleton/vendor/daodao97/apidog/src/Middleware/ApiValidationMiddleware.php.
原因是token首字母是小写，所以找不到。
综上：
在注解header中，key的首字母必须大写。demo中是小写的。

怎么写上传文件的注解

3.0的能否搞搞

枚举问题

你好大佬，目前想使用你得插件，遇到个问题，在@ApiResponse如何定义枚举型啊

"role": { "enum": "1|2|3", "type": "string","description": "角色" },是这样写嘛

翻译问题

错误提示信息怎么要做多语言，怎么实现啊

多server 无法生成除http的其他server的api文档

是否支持apikey身份认证

如下图这样的效果

consumes不一定是application/json

formdata时就不是。

apidog/src/Swagger/SwaggerJson.php

Line 73 in aaeb046

"application/json",

你好，发现一个bug，多个server，swagger.json写入失败

当存在一个server时，swagger.json写入正常，当存在多个swagger.json时，写入失败

全局参数能否设置比如签名

@ApiController(prefix="/admin" 不起作用

@APIController(prefix="/admin" 不起作用

[BUG] 引入组件的中间件后，发送一次请求会执行两次

新创建一个项目，做好数据库配置后，仅仅require了 hyperf/db 与 daodao97/apidog 组件，做好相应配置，然后启动服务，用curl请求接口一次，发现写入了两条数据，并输出了两次var_dump
结果。

具体代码我放在了 https://github.com/jobinli/hyperf-test

[BUG]生成的文档没有内容,但接口可以访问

// 当你有多个 http server 时, 可以在输出文件的名称中增加 {server} 字面变量
// 比如 /public/swagger/swagger_{server}.json

开启多服务时必须配置成 /public/swagger/swagger_{server}.json。每个服务会生成一次wagger.json,如果是/public/swagger/swagger.json,最后一次服务会覆盖掉之前的。

能否适配下hyperf^3.0版本

适配了3.0打个tag啊，。。。

文档中field_error_msg参数名与源码不一致

文档和发布自动生成的配置文件中都是
field_error_msg

源码里是
field_error_message

麻烦统一一下吧

@GetApi(path="auths/{id}/haha") -- uri中带path参数，生成的路由不正确

自定义server name，无法生该控制器的API文档

/**
 * @ApiServer(name="admin")
 * @ApiController(prefix="admin/passport", tag="授权登录", server="admin")
 * @Middleware(CorsMiddleware::class)
 */

测试，路由是生效的，但没有生成该控制器的API文档

看了一下代码，应该是只是生成了 http 的文档：
$router = $container->get(DispatcherFactory::class)->getRouter('http');

改成这样就可以了，希望修复一下：

        /*$router = $container->get(DispatcherFactory::class)->getRouter('http');
        $data = $router->getData();*/
        $servers = $config->get('server.servers');
        if (count($servers) > 1 && !Str::contains($output, '{server}')) {
            $logger->warning('You have multiple serve, but your apidog.output_file not contains {server} var');
        }
        foreach ($servers as $server) {
            $router = $container->get(DispatcherFactory::class)->getRouter($server['name']);
            $data = $router->getData();
            $swagger = new SwaggerJson($server['name']);

            $ignore = $config->get('apidog.ignore', function ($controller, $action) {
                return false;
            });

            array_walk_recursive($data, function ($item) use ($swagger, $ignore) {
                if ($item instanceof Handler && !($item->callback instanceof \Closure)) {
                    [$controller, $action] = $this->prepareHandler($item->callback);
                    (!$ignore($controller, $action)) && $swagger->addPath($controller, $action);
                }
            });

            $swagger->save();
        }

关于 php bin/hyperf.php apidog:ui 执行的时候,直接提示 Uncaught ReflectionException: Method index does not exist报错

PHP Fatal error: Uncaught ReflectionException: Method index does not exist in /home/vagrant/hyperf-test/vendor/hyperf/di/src/ReflectionManager.php:45
Stack trace:
#0 /home/vagrant/hyperf-test/vendor/hyperf/di/src/ReflectionManager.php(45): ReflectionClass->getMethod()
#1 /home/vagrant/hyperf-test/vendor/daodao97/apidog/src/ApiAnnotation.php(22): Hyperf\Di\ReflectionManager::reflectMethod()
#2 /home/vagrant/hyperf-test/vendor/daodao97/apidog/src/Swagger/SwaggerJson.php(76): Hyperf\Apidog\ApiAnnotation::methodMetadata()
#3 /home/vagrant/hyperf-test/vendor/daodao97/apidog/src/BootAppConfListener.php(63): Hyperf\Apidog\Swagger\SwaggerJson->addPath()
#4 [internal function]: Hyperf\Apidog\BootAppConfListener->Hyperf\Apidog{closure}()
#5 /home/vagrant/hyperf-test/vendor/daodao97/apidog/src/BootAppConfListener.php(65): array_walk_recursive()
#6 /home/vagrant/hyperf-test/vendor/hyperf/event/src/EventDispatcher.php(48): Hyperf\Apidog\BootAppConfListener->process()
#7 /home/vagrant/hyperf-test/vendor/hyperf/framework/src/ApplicationFac in /home/vagrant/hyperf-test/vendor/hyperf/di/src/ReflectionManager.php on line 45

@Header的bug

@Header(key="Authorization|接口访问凭证", rule="required")
在有传Authorization的情况，依然会提示。原因是getHeaders会把得到key是小写

        if ($header_rules) {
            $headers = $request->getHeaders();
            $headers = array_map(function ($item) {
                return $item[0];
            }, $headers);
            [
                $data,
                $error,
            ] = $this->check($header_rules, $headers, $controllerInstance);
            if ($data === null) {
                return [
                    $field_error_code => $error_code,
                    $field_error_message => implode(PHP_EOL, $error),
                ];
            }
        }

Apidog 的国际化

使用apidog时为什么我的路由会冲突?

一开始这个问题其实并不严重但是当我需要使用中间件来通过token 验证用户时发现了这个问题
`
/**

@postapi(path="/refresh_token", description="刷新token")
@ApiResponse(code="200", description="请求成功", schema={
"qid":"5fe97d21bae1a-B129B32C-82F054E3",
"code":200,
"data":{
```
"token|token":"",
```
```
"exp|过期时间": 7200,
```
},
"msg":"操作成功",
"_": 1609137441
})
*/
public function refresh_token(){

}

Router::post('/refresh_token', 'App\Controller\UserController@refreshToken', ['middleware' => $middleware]);
`

代码如上

错误信息:
PHP Fatal error: Uncaught FastRoute\BadRouteException: Cannot register two routes matching "/refresh_token" for method "POST" in /home/www/apitest.qiduo.net/vendor/nikic/fast-route/src/DataGenerator/RegexBasedAbstract.php:86

当路由文件与注解指向同一个方法时候，路由解析错误

此时解析出来的controller为A。
在routers.php

Router::addRoute(['GET', 'POST', 'HEAD'], '/', 'App\Controller\IndexController@index');

同时在App\Controler\IndexController@index中用了例子中的注解

虽然这是一个不应该出现的错误用法。

如何定义字符串数组的Body参数

@Body(rules={
"apis": {"a","b","c"}
})
生成的swagger文档为
{ "apis": [{}] }

我希望的是
{ "apis": [""] }

文档外网访问

UICommand -> handle->host=>127.0.0.1 文档启动外网无法访问修改为0.0.0.0时外网能访问但是文档页面访问的0.0.0.0:9939/swagger.json 需要页面手动将0.0.0.0改成访问地址才能正常访问

Api参数校验中间件只对server名称为http的有效

    public function __construct(ContainerInterface $container, HttpResponse $response, RequestInterface $request, ValidationApi $validation)
    {
        $this->container = $container;
        $this->response = $response;
        $this->request = $request;
        $this->validationApi = $validation;
        parent::__construct($container, 'http');
    }

能像java一样将请求参数的验证及响应输出格式都提出去作为单独的一个文件吗

在方法里面写注解看着好难受

请问 jwt header认证怎么配置

如题

请问可以对 ApiResponse 下schema 里面的值进行描述的么？

/**
* @postapi(path="login", description="添加一个用户")
* @Header(key="token|接口访问凭证", rule="required")
* @formdata(key="username|用户名或者手机号", rule="required")
* @formdata(key="password|密码", rule="required")
* @ApiResponse(code="-1", description="参数错误")
* @ApiResponse(code="0", description="成功", schema={"id":1})
*/

请问可以对 ApiResponse 下schema 里面的值进行描述的么？谢谢