PHP使用swagger-php自动生成api文档（详细附上完整例子）
PHP使用swagger-php自动生成api文档（详细附上完整例子）
thinkphp5结合swagger自动生成接口文档
整体介绍
swagger-php、swagger-ui、swagger-editor
- swagger-ui：主要就是放到tp项目public目录下，配置yaml文件url后访问可以展示swagger的主页面
- swagger-php：将有swagger规定注释的php文件打包生成一个yaml文件
- swagger-editor：就是可以直接左侧在线写yaml文件,右侧生成页面展示，实时的
安装swagger-ui前端
可以使用git 获取swagger-ui，也可以去github上下载压缩包
如果是使用 git 克隆 swagger-ui，可以在当前项目的public目录下执行如下命令
git clone https://github.com/swagger-api/swagger-ui.git
也可以在其github官网上下载
https://github.com/swagger-api/swagger-ui.git
其实，这里面真正用到的是dist目录，所以如果下载过一次之后，再用时，只需要将 dist 目录拷贝到项目的 public 目录下，改名为swagger-ui即可。
安装swagger-php
在你的tp项目目录下执行composer命令：
composer require zircote/swagger-php
提示安装成功后会在tp项目的verdor中生成一个zircote的组件文件夹，说明已经安装插件成功了。最新的版本在bin目录下是一个openapi文件，生成yaml文件，这个对应@OA\啥啥啥的
使用composer命令安装其他版本，bin目录下面是一个swagger文件，生成json文件，可以让我们小白更容易读懂，这个json对应注释是@SWG\啥啥啥的
composer require "zircote/swagger-php:2.0.13"
因为生成yaml文件比较难看懂，所以使用的生成json的，就是安装swagger-php版本换一下，执行的步骤是一样的，只是生成的yaml文件换成了json
例子
swagger-ui中的url：
url: "http://tpswagger.com:86/doc/swagger.json",
test.php中的内容如下：
<?php
namespace app\index\controller;
use think\Request;
use think\Db;
use think\Controller;
/**
* @SWG\Swagger(
* @SWG\Info(
* title="API文档",
* version="版本1.0",
* description="本文档仅限于测试"
* )
* )
*/
class Test extends Controller
{
/**
* @SWG\Post(
* path="/index/test/getstudent",
* tags={"后台管理"},
* summary="更新用户的信息",
* description="传入用户的id为参数",
* @SWG\Parameter(name="id", type="integer", in="formData", description="学生id",required=true),
* @SWG\Response(response="200", description="请求成功"),
* @SWG\Response(response="201", description="请求失败")
* )
*/
public function getstudent(Request $request)
{
$id = input('id');
//var_dump($id);
$res = Db::name('student')->where('id',$id)->select();
//var_dump($res);
if ($res) {
return json_encode(['code'=>200,'msg'=>'查询成功']);
} else {
return json_encode(['code'=>201,'msg'=>'查询失败']);
}
}
/**
* @SWG\Get(
* path="/index/test/index",
* tags={"后台管理"},
* summary="后台管理员列表",
* description="显示管理员列表,不需要任何的参数",
* @SWG\Response(response="200", description="请求成功"),
* @SWG\Response(response="201", description="请求失败")
* )
*/
public function index()
{
return json_encode(['code'=>201,'msg'=>'查询失败']);
}
}php ./vendor/zircote/swagger-php/bin/swagger ./application/index/controller/ -o ./public/doc/
解释：用的swagger-php中的bin/swagger命令，将index下的控制器的注释生成到项目public/doc/目录下面，可以看到swagger.json文件
swagger-edit的使用
在线使用也可下载使用，在线链接地址：
https://editor.swagger.io/
PHP文件中的注释写法
一些注解写法官方：
https://zircote.github.io/swagger-php/Getting-started.html#array-parameters-in-query
直接使用swagger-editor
官方例子，点击标题下面的swagger.json链接，将json数据复制到在线swagger-editor中，就可看到相应效果，改就行了
https://petstore.swagger.io/?_ga=2.227855901.16440062.1624960400-390335495.1624960400#/
在线swagger-editor
https://editor.swagger.io/
yaml语法介绍
菜鸟教程，就一些规定
https://www.runoob.com/w3cnote/yaml-intro.html
基本语法
- 大小写敏感
- 使用缩进表示层级关系
- 缩进不允许使用tab，只允许空格
- 缩进的空格数不重要，只要相同层级的元素左对齐即可
- '#'表示注释
数据类型
YAML 支持以下几种数据类型：
- 对象：键值对的集合，又称为映射（mapping）/ 哈希（hashes） / 字典（dictionary）
- 数组：一组按次序排列的值，又称为序列（sequence） / 列表（list）
- 纯量（scalars）：单个的、不可再分的值
YAML 对象
对象键值对使用冒号结构表示 key: value，冒号后面要加一个空格。
也可以使用 key:{key1: value1, key2: value2, ...}。
还可以使用缩进表示层级关系；
key:
child-key: value
child-key2: value2较为复杂的对象格式，可以使用问号加一个空格代表一个复杂的 key，配合一个冒号加一个空格代表一个 value：
?
- complexkey1
- complexkey2
:
- complexvalue1
- complexvalue2意思即对象的属性是一个数组 [complexkey1,complexkey2]，对应的值也是一个数组 [complexvalue1,complexvalue2]
YAML 数组
以 - 开头的行表示构成一个数组：
- A
- B
- CYAML 支持多维数组，可以使用行内表示：
key: [value1, value2, ...]数据结构的子成员是一个数组，则可以在该项下面缩进一个空格。
-
- A
- B
- C一个相对复杂的例子：
companies:
-
id: 1
name: company1
price: 200W
-
id: 2
name: company2
price: 500W意思是 companies 属性是一个数组，每一个数组元素又是由 id、name、price 三个属性构成。
数组也可以使用流式(flow)的方式表示：
companies: [{id: 1,name: company1,price: 200W},{id: 2,name: company2,price: 500W}]复合结构
数组和对象可以构成复合结构，例：
languages:
- Ruby
- Perl
- Python
websites:
YAML: yaml.org
Ruby: ruby-lang.org
Python: python.org
Perl: use.perl.org转换为 json 为：
{
languages: [ 'Ruby', 'Perl', 'Python'],
websites: {
YAML: 'yaml.org',
Ruby: 'ruby-lang.org',
Python: 'python.org',
Perl: 'use.perl.org'
}
}纯量
纯量是最基本的，不可再分的值，包括：
- 字符串
- 布尔值
- 整数
- 浮点数
- Null
- 时间
- 日期
使用一个例子来快速了解纯量的基本使用：
boolean:
- TRUE #true,True都可以
- FALSE #false，False都可以
float:
- 3.14
- 6.8523015e+5 #可以使用科学计数法
int:
- 123
- 0b1010_0111_0100_1010_1110 #二进制表示
null:
nodeName: 'node'
parent: ~ #使用~表示null
string:
- 哈哈
- 'Hello world' #可以使用双引号或者单引号包裹特殊字符
- newline
newline2 #字符串可以拆成多行，每一行会被转化成一个空格
date:
- 2018-02-17 #日期必须使用ISO 8601格式，即yyyy-MM-dd
datetime:
- 2018-02-17T15:02:31+08:00 #时间使用ISO 8601格式，时间和日期之间使用T连接，最后使用+代表时区引用
& 锚点和 * 别名，可以用来引用:
defaults: &defaults
adapter: postgres
host: localhost
development:
database: myapp_development
<<: *defaults
test:
database: myapp_test
<<: *defaults相当于:
defaults:
adapter: postgres
host: localhost
development:
database: myapp_development
adapter: postgres
host: localhost
test:
database: myapp_test
adapter: postgres
host: localhost& 用来建立锚点（defaults），<< 表示合并到当前数据，* 用来引用锚点。
下面是另一个例子:
- &showell Steve
- Clark
- Brian
- Oren
- *showell 转为 JavaScript 代码如下:
[ 'Steve', 'Clark', 'Brian', 'Oren', 'Steve' ]