关于api设计:服务端-统一api-格式

33次阅读

共计 318 个字符,预计需要花费 1 分钟才能阅读完成。

议定的格局如下:

{
"code":0,
"message":"message",
"data":"returnData",
"status":200
}

字典阐明:

  • status http 状态码
  • code 业务码 (错误码)
  • message 提示信息
  • data 数据体

服务端个别有两种状况返回:

  1. 以 httpStatusCode 来标记响应状态,比方 2xx,400,500 前端顶层依据状态码解决响应体
  2. 不应用 http 状态码,间接以业务码 code 标记,状态码始终 200,。

返回响应体:

  1. 以状态码响应后果状态时,谬误时,依照以上响应体返回,正确间接返回数据体;
  2. 不论正确与否都依照以上响应体返回;

前端辨认格局体的时候,倡议查看存在 code、status 两个字典,以辨别偶合的数据体。

正文完
 0