itaustin / thinkphp-apidoc

基于ThinkPHP 根据注释自动生成API接口文档

ThinkPHP ApiDoc

基于ThinkPHP 根据注释自动生成API接口文档

文档

ThinkPHP ApiDoc V2.x文档

ThinkPHP ApiDoc V1.x文档

特性

• 开箱即用：安装后按文档编写注释即可。
• 在线调试：支持设置全局请求头Authorize，接口调试省时省力。
• 轻松编写：支持公共注释定义、业务逻辑层、数据表字段注释的引用。
• 多应用/多版本：适应各种项目结构、实现良好的应用/版本管理。
• 控制器分组：可通过控制器分组实现多模块接口分组。
• Markdown文档：支持读取.md文件展示文档。
• 快速生成Curd：可通过可视化配置快速生成Crud代码与数据表创建。
• 安全验证：支持密码验证访问接口文档。
• 高效缓存：支持缓存接口数据，无需每次都生成数据。
• 完善的文档及使用示例。

兼容

• ThinkPHP 6.x

如需在 ThinkPHP 5.x 版本中使用，请安装 V1.x版本 V1.x版本安装说明

安装

进入ThinkPHP 项目根目录，执行如下命令：

composer require hg/apidoc

添加前端页面

方式一 (推荐)

点击下载 ，下载完成后解压，将apidoc文件夹拷贝到你的项目 public 目录下

方式二 GitHub 下载

1、执行以下命令下载UI

git clone https://github.com/HGthecode/apidoc-ui.git

2、下载完成后，将apidoc目录放到你的项目public目录下

安装插件完成后 打开浏览器访问 http://你的域名/apidoc/ ，出现接口文档页面，表示安装成功

支持我们

如果本项目对您有所帮助，请点个Star支持我们

鸣谢

ThinkPHP

doctrine/annotations

链接

ApiDoc UI前端

ApiDoc Demo 示例项目