November 15, 2018

API 接口设计

设计使用友好，易处理的 API 。

API 接口设计

HTTP 状态码

状态码 说明 客户端建议 服务端建议
200 请求成功，查询成功
201 创建成功，并返回新的数据
202 异步处理中
204 更新成功，但无数据返回
400 查询参数错误
401 未授权 重新登录
403 未认证，无权访问
404 资源不存在
422 表单校验未通过 提供错误信息数组
429 接口调用频次达到上限
500 服务器发生未知错误 提示服务器繁忙
503 服务器维护中或服务器负载过高 提供维护信息

success 返回值

{
    "id": 1,
    "nickName": "Administrator",
    "isVIP": true,
    "createdAt": "2018-01-31T23:32:03.469+0800"
}

error 返回值

{
    "code": 400, 
    // 或者 "code": "ERR_QUERY_PARAME"
    "statusCode": 400,
    "message": "无效的查询参数"
}