介绍
2022年10月25日大约 2 分钟使用指南
介绍
🤷♀️ Apidoc 是什么？
Apidoc 是一个通过解析注解生成 Api 接口文档的 PHPcomposer 扩展；兼容 Laravel、ThinkPHP、Hyperf、Webman 等框架；
全面的注解引用、数据表字段引用，简单的注解即可生成 Api 文档，而 Apidoc 不仅于接口文档，在线接口调试、Mock 调试数据、调试事件处理、Json/TypeScript 生成、批量测试、接口分享、代码生成器等诸多实用功能，致力于提高 Api 接口开发效率。
✨ 特性
- 开箱即用：无繁杂的配置、安装后按文档编写注释即可自动生成 API 文档。
- 轻松编写：支持通用注释引用、业务逻辑层、数据表字段的引用，几句注释即可完成。
- 在线调试：在线文档可直接调试，并支持全局请求/Mock 参数/事件处理，接口调试省时省力。
- 安全高效：支持访问密码验证、应用/版本独立密码；支持文档缓存。
- 多应用/多版本：可适应各种单应用、多应用、多版本的项目的 Api 管理。
- 分组/Tag：可对控制器/接口进行多级分组或定义 Tag。
- Markdown 文档：支持.md 文件的文档展示。
- Json/TypeScript 生成：文档自动生成接口的 Json 及 TypeScript。
- 代码生成器：配置+模板即可快速生成代码及数据表的创建，大大提高工作效率。
- 接口分享：支持自由指定应用/接口生成分享链接、导出 swagger.json 文件。
📌 兼容
以下框架已内置兼容，可开箱即用
| 框架 | 版本 | 说明 |
|---|---|---|
| ThinkPHP | >=5.1 | |
| Webman | >=1.x | |
| Laravel | >=8.x | 低于 Laravel8 版本未测试，可自行尝试 |
| Hyperf | >=2.x |
🏆 支持我们
如果本项目对您有所帮助，请点个 Star 支持我们
🌐 交流群
