安装/升级

2022年11月10日 14:34 指南大约 2 分钟

# 安装/升级

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

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

# 安装插件

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

composer require hg/apidoc

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

# 添加前端页面

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

Apidoc版本	Github	Gitee（推荐）
`v2.6.0`	v1.3.6 (opens new window)	v1.3.6 (opens new window)-
`v2.5.0` - `v2.5.3`	v1.3.5 (opens new window)	v1.3.5 (opens new window)-
`v2.4.2`	v1.2.1 (opens new window)	-
`v2.4.0` - `v2.4.1`	v1.2.0 (opens new window)	-
`v2.0.0` - `v2.3.0`	v1.1.0 (opens new window)	-
`v1.x`	v1.0.0 (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('mdDetail'     , $controller_namespace . 'getMdDetail');
    Route::post('verifyAuth'     , $controller_namespace . 'verifyAuth');
    Route::post('createCrud'     , $controller_namespace . 'createCrud');
});

1
2
3
4
5
6
7
8
9
10

# 升级插件

1、如果你之前已经安装过，那么切换到你的应用根目录下面，然后执行下面的命令进行更新。

composer update hg/apidoc

2、更新前端页面，可通过安装时的添加前端页面方式下载最新的前端文件，覆盖/public/apidoc的文件夹即可。

介绍更新日志