之前一直使用swagger等一些工具来做api文档的生成,可安装、配置都比较繁琐,有的需要编写大量的注释才能生成一个接口等原因,便有了开发一个针对Thinkphp根据注释自动生成文档的扩展的想法。如今,插件已完成,并已经在好些项目上使用,使用效果非常好,推荐给大家,希望对你有帮助。
特性
- 开箱即用,安装后按文档编写注释即可。
- 版本管理,可生成不同版本的API接口文档,任意切换。
- 多应用、单应用均兼容。
- 支持控制器分组实现多模块管理。
- 丰富的公共注释定义、业务逻辑层、模型的引用。
- 可根据引用模型,获取数据表字段注释生成参数文档。
- 支持配置,API文档页访问需密码验证。
- 支持在线调试,及设置全局请求头Authorize,接口调试省时省力。
- 支持缓存接口数据,无需每次访问都生成一次数据,更可随时切换。
- 完善的文档及使用示例。
文档与示例
GitHub地址:github.com/HGthecode/t…
官方文档地址:hgthecode.github.io/thinkphp-ap…
示例地址:apidoc.demo.hg-code.com/apidoc/
安装和使用方式以上文档已经描述得很详细了,这里就不重复了,请前往官网查看