success / data / meta / traceId 这几个,只有 data 内部的业务结构因接口而异。这意味着你可以在客户端封装一个统一的响应解析层,而不必为每个接口单独写判断逻辑。
成功响应
data 的形态取决于接口类型
- 列表类接口(如
/countries、/matches、/players):data是数组,即使只有一条结果也会包成数组。 - 详情类接口(如
/matches/{match_id}/situation、/lineups):data是单个对象。
data 里包含哪些字段,请查阅该接口自己的文档页;这里只约定外层信封的通用结构。
分页字段怎么用
支持分页的接口,meta 中会带上 page(当前页码,从 1 开始)、limit(本页条数上限)与 total_pages(总页数,由 total 和 limit 计算得出)。翻页逻辑很直接:
page 超出 total_pages 时,data 会返回空数组而不是报错,客户端据此判断是否已翻到最后一页。
失败响应
请求失败时,success 为 false,业务数据字段被替换为 error 对象:
具体每个错误码对应的 HTTP 状态与触发场景,见 错误码。