API 概览
在此记录项目对外暴露的接口、参数说明与返回值格式。
响应格式
所有接口遵循统一的信封格式:
json
{
"success": true,
"data": { },
"error": null,
"meta": {
"total": 100,
"page": 1,
"limit": 20
}
}| 字段 | 类型 | 说明 |
|---|---|---|
success | boolean | 请求是否成功 |
data | any | null | 业务数据,失败时为 null |
error | string | null | 错误信息,成功时为 null |
meta | object | null | 分页元数据,非列表接口可省略 |
错误码
| 状态码 | 含义 |
|---|---|
| 400 | 参数校验失败 |
| 401 | 未认证 |
| 403 | 无权限 |
| 404 | 资源不存在 |
| 500 | 服务器内部错误 |