API使用说明

说明

认证

请求

请求方法

POST/PATCH/DELETE方法统一使用application/json类型进行请求，这几种拒绝其他请求类型

接受以下方法：

名称	说明
GET	获取数据
POST	添加数据
PATCH	更新数据
DELETE	删除数据

响应

HTTP状态码

表示成功执行：

名称	说明
200	请求成功
201	资源已创建
204	资源已创建

表示失败：

名称	说明
400	请求解析失败
401	认证失败
403	无权限访问对应资源
404	指定资源不存在
415	POST/PATCH 没用application/json格式进行请求
422	数据验证错误
50x	Web服务器内部错误

响应结构

成功响应：

{
    data: any,

    // params bellow only exists when listing resource
    page?: number,
    pageSize?: number,
    nextPage?: string,
    prevPage?: string,
    totalPages?: number
    totalRecords? number
}

失败响应：

{
    error: string,  // [A-Z\-] error code
    message?: string // human readable error message
    payload?: any // your request payload without sensitive thing will be discarded.
    validation?: any  // if params validation fails and response 400 status
}

访问频次限制

// 应该暂时不用考虑

分页

请求

分页需要指定两个参数，limit用来指定每页输出的数据量，page为页面id

响应

// TODO

数据排序