overview

Response

HTTP resonde code

• http 状态码，遵循规范：rfc7231

Header

自定义header

• Auth-Token: 鉴权用token，随每个需要授权的请求返回，客户端应缓存，供下次请求使用，更多见授权

Body

成功的Response

一个标准的body 如下：

{
  "user": {
     "id": 1,
     "name": "大白菜"
  }
}
{
  "posts": [
    { "id": 1, "title": "app1" },
    { "id": 2, "title": "title2" }
  ]
}

一般情况下，response返回的数据包含

• 单个对象，键值为资源名，包含该对象的一系列属性；
• 列表类数据，包含多个对象（数组），资源名为复数；

资源名可作为客户端建模型参考；

失败的Response

非正常响应的response 分为两类，一类是客户端错误，错误码为4开头，一类是服务端错误，错误码为5开头；

错误响应的response body 会包含如下几个对象：

{
  "error": {
      "base": [
        "账号或者密码错误"
      ]
  },
  "message": "账号或者密码错误"
}

• message: 字符串类型，适合阅读的错误提示消息，建议客户端可直接弹出提示框展示该消息；
• error: json对象。
  • base: 非特异性针对具体属性的错误；
  • name: 属性名，具体错误或不符合要求的提示内容；

对于error对象，客户端可根据实际情况确定处理策略。