通过 
搜索
搜索czh9527 / apidoc
ThinkPHP API文档自动生成
v4.0
2022-04-13 09:26 UTC
Requires
- php: >=7.1.0
- doctrine/annotations: ^1.6
- symfony/class-loader: ~3.2.0
This package is auto-updated.
Last update: 2024-09-13 14:37:09 UTC
README
ThinkPHP ApiDoc
基于 ThinkPHP 的API接口开发工具🤷♀️ Apidoc是什么？
如今，前后端分离的开发模式已成为必要，基于ThinkPHP可以方便地进行API接口开发。但在API开发过程中，需要快速调试，开发完成后还需要其他开发者进行对接等，这时一个功能全面的API文档工具就显得尤为重要。
大多数开发者可能都是通过各种工具配合来达到这一目的，而各种工具的安装和配置过程也是繁琐的。甚至还有通过word等文本工具手写API文档的，这样的开发效率与可维护性非常差。
针对API开发中的各种痛点，我们为ThinkPHP开发了Apidoc扩展，本插件可以通过简单的注解生成API文档，帮助开发者提高生产效率，支持在线调试、快速生成CRUD、一键生成整个模块API等功能，涵盖API开发的各个方面。
✨特性
- 开箱即用：无需复杂配置，安装后按照文档编写注释即可自动生成API文档。
- 在线调试：在线文档可直接调试，支持全局参数、Mock调试数据、事件执行，接口调试省时省力。
- 轻松使用：支持公共注释定义、业务逻辑层、数据表字段等引用，只需几句注释即可完成。
- 安全高效：支持访问密码验证、应用/版本独立密码；支持文档缓存。
- 多应用/多版本：可适应各种单应用、多应用、多版本的项目的API管理。
- Markdown文档：支持.md文件的文档展示。
- 控制器分组：支持控制器多级分组，更精细化管理接口目录。
- 多语言：可结合TP多语言能力，实现接口文档的语言切换。
📌兼容
ThinkPHP 5.1
ThinkPHP 6.x
📖使用文档
🏆支持我们
如果本项目对您有所帮助，请点个Star支持我们