通过 
搜索
搜索源博 / apidoc
ThinkPHP API文档自动生成
v3.2.2
2022-07-19 06:49 UTC
Requires
- php: >=7.1.0
- doctrine/annotations: ^1.6
- symfony/class-loader: ~3.2.0
README
ThinkPHP ApiDoc
基于ThinkPHP，根据注释自动生成API接口文档🤷♀️ Apidoc是什么？
现在，前后端分离的开发模式已经成为标配，基于ThinkPHP可以很方便地进行后端API的开发。但是在API开发过程中，快速调试和开发完成后与其他开发者对接时，一份详细的API文档就变得尤为重要。
大多数开发者可能都是通过各种工具配合来完成这一目的，而各种工具的安装和配置过程也相当繁琐。甚至还有通过Word等文本工具手动编写API文档的，这样的开发效率与可维护性都是非常差的。
针对API开发中的各种痛点，我们专门为ThinkPHP开发了Apidoc的扩展插件。这个插件可以通过简单的注解生成API文档，并帮助开发者提高生产效率，实现在线调试、快速生成CRUD、一键生成整个模块的API等功能，覆盖了API开发的方方面面。
✨特性
- 开箱即用：无需繁琐的配置，安装后按照文档编写注释即可自动生成API文档。
- 在线调试：在线文档可直接调试，支持设置全局参数，接口调试省时省力。
- 轻松编写：支持公共注释定义、业务逻辑层、数据表字段的引用，几句注释即可完成。
- 安全高效：支持访问密码验证、应用/版本独立密码；支持文档缓存。
- 多应用/多版本：可适应各种单应用、多应用、多版本的项目的API管理。
- Markdown文档：支持.md文件的文档展示。
- 快速生成CRUD：配置+模板即可快速生成CRUD接口代码及数据表的创建，大大提高工作效率。
- 控制器分组：更精细化的对控制器接口进行分组展示。
📌兼容
ThinkPHP 5.x
ThinkPHP 6.x
📢 2.6.0版本开始全面兼容TP5了啦~~~
📖使用文档
🏆支持我们
如果本项目对您有所帮助，请点个Star支持我们