1 全局控制器
1.1 全局配置
全局参数如无特殊说明,所有请求和响应都是以下格式;其他非全局参数如无特殊说明,响应参数均为data参数子键内容。
列表类型返回参数
| 参数 |
类型 |
描述 |
| currentPage |
int |
当前页数 |
| list |
json |
列表数据 |
| pageSize |
int |
分页大小 |
| pagination |
json |
分页数据 |
| startNum |
int |
开始页码 |
| totalCount |
string |
总数据 |
| totalPages |
int |
总页数 |
1.2 网站配置
用于获取网站配置
请求地址
| 环境 |
方法 |
路径 |
| 本机环境 |
GET |
/site/config |
响应参数
| 参数 |
类型 |
描述 |
| siteClose |
bool |
站点是否关闭 |
| siteCloseInfo |
string |
如果关闭,则返回关闭原因 |
| siteTitle |
string |
如果开启,则返回网站名称 |
1.3 登录
用于登录系统
请求地址
| 环境 |
方法 |
路径 |
| 本机环境 |
POST |
/oauth/login |
请求参数
| 参数 |
类型 |
是否必填 |
最大长度 |
描述 |
示例 |
| adminName |
string |
是 |
32 |
用户名 |
admin |
| password |
string |
是 |
32 |
密码 |
admin111 |
登录成功响应参数
| 参数 |
类型 |
描述 |
| accessToken |
string |
|
| accessTokenExpiresIn |
string |
|
| accessTokenUpdateAt |
string |
|
| refreshToken |
string |
|
| refreshTokenExpiresIn |
string |
|
| refreshTokenUpdateAt |
string |
|
登录失败响应参数
| 参数 |
类型 |
描述 |
| code |
string |
|
| message |
string |
提示信息 |
| name |
string |
|
| status |
string |
|
| type |
string |
|
1.4 获取刷新Token
用于获取刷新Token
请求地址
| 环境 |
方法 |
路径 |
| 本机环境 |
GET |
/oauth/refresh-token |
请求参数
| 参数 |
类型 |
是否必填 |
最大长度 |
描述 |
示例 |
| refresh-token |
string |
是 |
32 |
刷新Token |
efa60b3f3c |
获取成功响应参数
| 参数 |
类型 |
描述 |
| accessToken |
string |
|
| accessTokenExpiresIn |
string |
|
| accessTokenUpdateAt |
string |
|
| refreshToken |
string |
|
| refreshTokenExpiresIn |
string |
|
| refreshTokenUpdateAt |
string |
|
获取失败响应参数
| 参数 |
类型 |
描述 |
| code |
string |
|
| message |
string |
提示信息 |
| name |
string |
|
| status |
string |
|
| type |
string |
|