Swagger PHP Thinkphp 接口文档

安装

1. 安装依赖

composer require zircote/swagger-php

2. 下载Swagger UI

git clone https://github.com/swagger-api/swagger-ui.git

3. 复制下载好的Swagger UI 中的dist目录到public目录中，修改目录名称

cp -rf swagger-ui/dist /home/htdocs/public/
mv /home/htdocs/public/dist /home/htdocs/public/swagger

4. 修改swagger.json地址

vi /home/htdocs/public/swagger/swagger-initializer.js
# 将 https://petstore.swagger.io/v2/swagger.json 更换为本地地址
# https://ip:port/swagger.json

5. 访问 https://ip:port/swagger可以正常看到界面，将Explore框中的地址换为https://petstore.swagger.io/v2/swagger.json可查看demo
6. 截止这里就安装完成了

phpstorm上使用swagger

Files -> settings -> Plugins
安装 PHP Annotations
安装 SwaggerHub

使用

这里两种使用模式都是可以，推荐第二种

1. 命令行使用

php ./vendor/zircote/swagger-php/bin/openapi ./app/controller/Test.php -o ./public/swagger.json

参数1 swagger执行命令地址
参数2 需要生成文档的接口地址
参数3 -o 表示将结果生成在 参数4这里

2. thinkphp命令行形式调用

1). 生成命令类 php think make:command Swagger

2). 修改execute方法

use OpenApi\Generator;
#路径为需要扫描生成文档的路径
$openapi = Generator::scan(['/home/htdocs/app/controller/']);
#生成地址以及生成格式
$openapi->saveAs('/home/htdocs/public/swagger.json', 'json');
#命令结束后输入语
$output->writeln('init success, please view http://ip:port/swagger/index.html');

3). 注册命令

vi /home/htdocs/config/console.php添加刚生成的命令类

'commands' => [
   'swagger' => \app\command\Swagger::class
],

4). 执行命令

php think swagger

3. 其他框架或者php原生，直接使用下面代码即可

use OpenApi\Generator;
#路径为需要扫描生成文档的路径
$openapi = Generator::scan(['/home/htdocs/app/controller/']);
#生成地址以及生成格式
$openapi->saveAs('/home/htdocs/public/swagger.json', 'json');

swagger注解模板及常用语法

请参考