yuanbo / apidoc
thinkphp API文档自动生成
Installs: 434
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Type:think-extend
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支持我们