一个 Hyperf 框架的 Api 参数校验及 swagger 文档生成组件

一个 Hyperf 框架的 Api 参数校验及 swagger 文档生成组件

组件代码地址

apidog/README.md at master · daodao97/apidog · GitHubApi Watch Dog, Hyperf 框架的 Api参数校验 和 swagger 生成组件. Contribute to daodao97/apidog development by creating an account on GitHub.https://github.com/daodao97/apidog/blob/master/README.md

一个 Hyperf 框架的 Api 参数校验及 swagger 文档生成组件

1. 根据注解自动进行Api参数的校验, 业务代码更纯粹.
2. 根据注解自动生成Swagger文档, 让接口文档维护更省心.

Swagger UI启动

本组件提供了两种方式来启用SwaggerUI , 当config/autoload/apidog.php enable = true 时

方式一

系统启动时, swagger.json 会自动输出到配置文件中定义的 output_file中, 此时我们到swagger ui的前端文件结合nginx启动web服务

方式二

也可以使用组件提供的快捷命令, 快速启动一个 swagger ui.

php bin/hyperf.php apidog:ui

php bin/hyperf.php apidog:ui --port 8888