Skip to content

API 概览

在此记录项目对外暴露的接口、参数说明与返回值格式。

响应格式

所有接口遵循统一的信封格式:

json
{
  "success": true,
  "data": { },
  "error": null,
  "meta": {
    "total": 100,
    "page": 1,
    "limit": 20
  }
}
字段类型说明
successboolean请求是否成功
dataany | null业务数据,失败时为 null
errorstring | null错误信息,成功时为 null
metaobject | null分页元数据,非列表接口可省略

错误码

状态码含义
400参数校验失败
401未认证
403无权限
404资源不存在
500服务器内部错误

Released under the MIT License.