一套后端对接管理后台、移动端H5、小程序等各种终端…前后端分离的开发模式再正常不过了。在开发的过程中,与前后端对接的api接口文档、在线接口调试、开发相关的文档说明等都通常采用多个工具来实现,甚至还有用word来手动写接口文档的…这样耗费的时间和维护性都很差…
如果你有此困扰,想找一个能够根据注释自动生成Api接口、在线调试、书写markdown文档等功能的工具,不妨试试这个TP6扩展插件吧!
先来看看官方的示例吧,颜值还是不错的
特性
- 开箱即用:安装后按文档编写注释即可。
- 在线调试:及设置全局请求头Authorize,接口调试省时省力。
- 轻松编写:支持公共注释定义、业务逻辑层、数据表字段注释的引用。
- 版本管理:可生成不同版本的API接口文档,任意切换。
- 控制器分组:可通过控制器分组实现多模块/应用的接口分组。
- Markdown文档:支持读取.md文件展示文档。
- 安全验证:支持密码验证访问接口文档。
- 高效缓存:支持缓存接口数据,无需每次都生成数据。
- 完善的文档及使用示例。
文档与示例
GitHub地址:https://github.com/HGthecode/thinkphp-apidoc
官方文档地址:https://hgthecode.github.io/thinkphp-apidoc/
示例地址:https://apidoc.demo.hg-code.com/apidoc/
安装和使用方式以上文档已经描述得很详细了,这里就不重复了,请前往官网查看