接口数据结构

通用数据结构

所有的接口需固定返回以下数据结构, 包含code、msg、data

{
  "code": "",
  "msg": "",
  "data": null
}

code：接口响应编码，如200成功，500错误，404接口不存在等。

msg：接口失败时的错误信息

data：接口返回的数据内容

如返回结果是一个学生信息

{
  "code": "200",
  "msg": "success",
  "data": {
    "studentName": "小明",
    "studentAge": "16"
  }
}

分页数据结构

所有的分页接口需固定返回以下数据结构

{
  "code": "",
  "msg": "",
  "data": {
    "total": 20,
    "size": 10,
    "current": 1,
    "records": [
      {},
      {}
    ]
  }
}

code：接口响应编码，如200成功，500错误，404接口不存在等。

msg：接口失败时的错误信息

data：接口返回的数据分页内容

total：接口返回的数据总共条数，如共20条

size：每页的数据条数，如每页10条

current：当前页数，如当前第1页

records：接口返回的当前页的数据对象集合

如返回结果是一批学生信息，可以进行分页展示的数据

{
  "code": "200",
  "msg": "success",
  "data": {
    "total": 20,
    "size": 10,
    "current": 1,
    "records": [
      {
        "studentName": "小明",
        "studentAge": "16"
      },
      {
        "studentName": "小红",
        "studentAge": "17"
      }
    ]
  }
}

错误数据结构

接口请求错误时的数据结构统一如下

{
  "code": "404",
  "msg": "请求接口不存在",
  "data": null
}

响应结果code区分

• 返回统一参数code默认 200 表示接口请求成功，code 不等于 200 表示接口请求失败
• 具体code值含义可以根据不同的业务进行自定义