插件api的公共约定
1.返回参数的约定
返回参数说明
返回值是json,转成数组后是一个n维的数组。其中有两个公共值需要说明,其一是status,代表请求返回状态,具体状态说明见下面表格;另一个是data,代表是请求的返回的数据
| 参数 | 类型 | 说明 |
|---|---|---|
| status | int | 请求返回状态 |
| data | array/string | 返回数据 或者报错信息 |
| is_more | int | 是否还有更多(下一页) |
| current_page | int | 当前页 |
| count | int | 查询结果总共数量 |
| total_page | int | 查询结果总共页数 |
status 状态说明
如有其他报错status值,请参考data报错信息
| status状态值 | 说明 |
|---|---|
| 0 | 请求成功,没有报错 data是请求数据 |
| 1 | 请求错误,data是报错信息 |
常见几种返回
// 报错返回
{
"status": 1,
"data": "登录过期,请重新登录。"
}
//正常-没有分页返回
{
"status": 0,
"data": {
"order_id": "5b31dd4437902211470182",
"msg": "添加订单成功"
}
}
//正常-有分页返回
{
"status": 0,
"data": [],
"is_more": 0,
"current_page": 1,
"count": "6",
"total_page": 1
}