API管理系统
china_wangyu@163.com
API管理系统
首先提示一下：
API文档管理器并非是swagger扩展生成。而且我不太喜欢
swagger的构建方式需要先安装
"lazyskills/paa-thinkphp6": "dev-master",paa-thinkphp6的composer.json已经包含了此扩展，所以不需要另外安装
@Doc注解扩展参数说明
引入单个参数注解器：use paa\annotation\Doc;
| 函数参数 | 说明 | 字段类型 | 是否必传 |
|---|---|---|---|
| value | 接口名称 | string | 是 |
| group | 接口分组，支持二级分组，用.区分 | string | 否 |
| hide | 是否隐藏 | string | 否 |
@Doc注解使用案例
@Doc最好写在注解最后一行，因为注解扩展解析规则时会加入其他的参数或者验证器。
- 强烈推荐 ！！！@Doc最好写在注解最后一行
- 强烈推荐 ！！！@Doc最好写在注解最后一行
- 强烈推荐 ！！！@Doc最好写在注解最后一行
例如：
控制器 app\controller\Index的index方法
/**
* @Route(value="index",method="GET")
* @Doc(value="查询所有用户",group="管理.权限",hide="false")
*/
public function index()
{
return json([],200);
}
1
2
3
4
5
6
7
8
2
3
4
5
6
7
8
配置config/paa.php
"management"=> [ # 接口管理平台
'enable' => true, # 开关控制，true：开启｜false：关闭
'member' => [
'admin' => [ # 用户名
'password' => 'supper', # 密码
'admin' => true, # true：超级管理员｜false：浏览者
],
'web' => [ # 用户名
'password' => '123456', # 密码
'admin' => false, # true：超级管理员｜false：浏览者
]
],
]
1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
enable 一定要设置： true,
否则无法打开文档管理平台
enable 文档管理平台控制： true打开｜false关闭
member 账户列表可以增加减少，注意格式以及说明
例如：
'web' => [ # 用户名
'password' => '123456', # 密码
'admin' => false, # true：超级管理员｜false：浏览者
]
1
2
3
4
2
3
4
访问API管理系统
访问地址：http://${host}/paa/index
登陆账户
具体见 config/paa.php 配置文件中 management.member配置
管理人员可自行添加。
不过请注意设置管理员参数admin字段。
- 管理员：
admin密码：supper - 管理员：
web密码：123456
访问页面示例图
Initializing...