API示例文档
创建于 2023-03-21 / 最近更新于 2023-03-21 /
4007
字体:
[默认]
[大]
[更大]
基本信息
接口地址:https://pescms.com/?g=Api&m=Test&a=index&key=123456
请求方式:GET
Get参数请求
| 参数 | 示例值 | 类型 | 默认值 | 是否必填 | 描述 |
|---|---|---|---|---|---|
| g | Api | string | - | 必填 | 组 |
| m | Test | string | - | 必填 | 控制器 |
| a | index | string | - | 必填 | 方法 |
| key | 123456 | string | - | 必填 | API的key值 |
Header参数请求
| 参数 | 示例值 | 类型 | 默认值 | 是否必填 | 描述 |
|---|---|---|---|---|---|
| X-Requested-With | XMLHttpRequest | string | - | 必填 | 声明XMLHttpRequest请求 |
| Accept | application/json | string | - | 必填 | 声明接口返回JSON格式 |
成功
成功时返回的结构
{
"msg": "API请求成功的示例",
"data": "数据体",
"status": 200,
"url": "",
"waitSecond": "3",
"token": "2c85ba91f429f2e644062e1ce38cc89c_17057782199220"
}返回参数说明
| 参数 | 类型 | 描述 |
|---|---|---|
| msg | string | 提示信息 |
| data | string | 数据体 |
| url | string | 跳转URL |
| waitSecond | string | 等待时间 |
| token | string | 刷新token |
| status | int | API状态码 |
失败
失败时返回的结构
{
"msg": "这是示例API示例错误提示文本",
"data": "",
"status": 0,
"url": "",
"waitSecond": "3",
"token": "033ba162f7bd2d6d28db9be59e9569d0_17057783113350"
}返回参数说明
| 参数 | 类型 | 描述 |
|---|---|---|
| msg | string | 提示信息 |
| url | string | 跳转URL |
| waitSecond | string | 等等时间 |
| token | string | 刷新TOKEN |
| status | int | API状态码 |
136 人点赞过
文档归类测试