服务端 统一api 格式

议定的格式如下:

{
"code":0,
"message":"message",
"data ":"returnData",
"extra":"extraData",
"type":"errorType",
"status":200
}

字典说明:

  • status http状态码
  • code 业务码(错误码)
  • message 提示信息
  • data 数据体
  • extra 额外数据
  • type 错误类型

服务端一般有两种情况返回:

  1. 以httpStatusCode来标记响应状态,比如2xx,400,500 前端顶层根据状态码处理响应体
  2. 不使用http状态码,直接以业务码code标记,状态码一直200,。

返回响应体:

  1. 以状态码响应结果状态时,错误时,按照以上响应体返回,正确直接返回数据体;
  2. 不管正确与否都按照以上响应体返回;

前端识别格式体的时候,建议检查存在 code、status 两个字典,以区分巧合的数据体。

你可能感兴趣的:(api设计)