如何阅读和调试 JSON 格式的 API 响应
接口对接出问题时,答案通常就在响应体里。本指南介绍如何获取响应、让它易于阅读,并找到能说明问题原因的字段。
1. 获取完整的响应
网页发出的请求用开发者工具的“网络”面板查看,其他情况用 curl。curl -i 除了响应体还会显示状态码和响应头,往往不用看 JSON 就能找到错误原因。
请复制完整的响应。日志或终端中被截断的响应缺少右括号,无法格式化。
2. 先看状态码
| 状态码 | 含义 | 在响应体中查找 |
|---|---|---|
| 200、201 | 成功 | 请求或创建的数据 |
| 400、422 | 请求无效 | 字段列表和校验信息 |
| 401、403 | 缺少权限或权限不足 | 关于令牌或权限范围的提示 |
| 404 | 未找到 | 路径或 ID 是否有误 |
| 429 | 请求过多 | 重试等待时间或限流详情 |
| 500–504 | 服务器或网关错误 | 可提供给 API 提供方的请求 ID |
3. 让响应易于阅读
把响应粘贴到 JSON 格式化工具中。如果开头是响应头或 JSONP 回调,会被自动去除。如果看到很多 \",说明 JSON 被编码了两次,工具会自动解码。
切换到树形视图并折叠大数组。大多数 API 会把结果放在 data、items 或 results 等字段中,分页信息则放在 meta、links 或 next 中。
4. 跟随分页
列表通常分成多页。查找 next、next_cursor、page 和 total 等字段。请使用 API 返回的游标或 URL 请求下一页,不要自己拼接,因为游标在每次调用之间可能会变化。
5. 注意数字和日期
超过 15 到 16 位的 ID 在 JavaScript 中可能被四舍五入。如果 API 提供字符串形式的 ID,请优先使用。日期通常是 2026-01-15T09:30:00Z 这样的 ISO 8601 字符串,其中 Z 表示 UTC,只在显示时再转换为本地时间。