接口约定
请求约定
Post 方法提交；所有 Body 参数使用
multipart/form-data 的格式提交；所有接口调用，必须经过签名，签名逻辑见：接口签名。
基础响应结构
{
"success": bool, // 请求是否被成功处理
"code": string, // 状态码
"message": string, // 状态消息
"data": null|object|string|any // 数据体
}分页响应结构
{
"success": bool, // 请求是否被成功处理
"code": string, // 状态码
"message": string, // 状态消息
"data": { // 数据体
"list": [], // 数据列表
"current_page": int, // 当前页数
"page_count": int, // 总页数
"has_more": bool // 是否还有更多
"total_count": int // 总记录行数
}
}状态码设计
| 状态码 | 状态说明 | 状态 | 备注 |
|---|---|---|---|
| 2000 | 接口处理成功 | 在用 | 可靠 |
| 4000 | 客户端通用错误 | 在用 | 可靠 |
| 4001 | 鉴权失败 | 当前未使用 | - |
| 5000 | 服务器端通用错误 | 当前未使用 | - |
请求 Header 设计
| Header Key | 是否必填 | 中文说明 | 值说明，值范围 | 值案例 |
|---|---|---|---|---|
| Content-Type | 是 | 内容编码方式 | multipart/form-data | multipart/form-data |
签名方法
修改于 2024-12-10 06:39:57