JSON 在 REST API 中的应用

现代 Web 开发中,前后端之间几乎都在用 JSON 传递数据。REST API 的请求和响应,默认格式就是 JSON。本文讲清 JSON 在 API 开发中怎么用。

为什么 API 都选 JSON

在 JSON 之前,API 常用 XML,但 XML 冗长、解析慢。JSON 凭借三个优势取代了它:

  1. 体积小:同样的数据,JSON 比 XML 短得多,传输快。
  2. 易解析:几乎所有语言都原生支持 JSON 解析。
  3. 贴近对象:JSON 的结构和编程语言里的对象/字典天然对应。

请求体(Request Body)

前端向后端提交数据时,Content-Type 设为 application/json,请求体就是 JSON:

POST /api/users
Content-Type: application/json

{
  "name": "Tom",
  "age": 30,
  "email": "tom@example.com"
}

响应体(Response Body)

后端返回数据时,同样用 JSON:

{
  "code": 0,
  "message": "success",
  "data": {
    "id": 1,
    "name": "Tom",
    "tags": ["前端", "后端"]
  }
}

常见的响应结构是「状态码 + 消息 + 数据」三段式,data 里放真正的业务数据。

API 返回的 JSON 长什么样

实际接口返回的 JSON 往往层级很深,比如:

{
  "data": {
    "list": [
      { "id": 1, "user": { "name": "Tom", "profile": { "city": "北京" } } },
      { "id": 2, "user": { "name": "Jerry", "profile": { "city": "上海" } } }
    ],
    "total": 2
  }
}

这种数据直接看文本很费劲,推荐用 JSON 在线格式化工具 的三个视图处理:

开发 API 时的 JSON 常见坑

遇到「接口返回解析失败」,第一步先确认返回的 JSON 是否合法——把返回内容粘到 JSON 在线校验工具 里检查,能秒级定位是格式问题还是字段问题。

延伸阅读