安装/升级

在安装本插件时，确保你已成功安装ThinkPHP的项目并成功运行

安装方法参考：ThinkPHP5文档 (opens new window) ThinkPHP6文档 (opens new window)

注意、注意、注意！！！

本项目已迁移至 https://github.com/HGthecode/apidoc-php ，全新Apidoc兼容ThinkPHP、Laravel、Hyperf、Webman等基于Composer的PHP框架，更多实用功能。本项目不再维护，请移步新项目。

安装插件

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

composer require hg/apidoc-thinkphp

TP5版本需手动添加apidoc所需路由，如未自动生成config/apidoc.php 配置文件，可参考 没有生成apidoc.php配置文件解决方案

添加前端页面

请根据你安装的apidoc版本 点击下载 对应的前端文件

Apidoc版本	Github	Gitee（国内推荐）
v3.1.0 - v3.1.9	v2.1.6 (opens new window)	v2.1.6 (opens new window)
v3.0.0 - v3.0.8	v2.0.11 (opens new window)	v2.0.11 (opens new window)

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

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

接下来，了解一下 基本配置 和 如何使用 吧。

如遇页面报错或无法正常使用，可参考常见问题

TP5添加路由

TP5版本需手动将apidoc所需路由添加到路由文件

// route/route.php

Route::group('apidoc', function () {
    $controller_namespace = '\hg\apidoc\Controller@';
    Route::get('config'     , $controller_namespace . 'getConfig');
    Route::get('apiData'     , $controller_namespace . 'getApidoc');
    Route::get('mdMenus'     , $controller_namespace . 'getMdMenus');
    Route::get('mdDetail'     , $controller_namespace . 'getMdDetail');
    Route::post('verifyAuth'     , $controller_namespace . 'verifyAuth');
    Route::post('generator'     , $controller_namespace . 'createGenerator');
});