跳到主要内容
uencoder

JSON:API

JSON:API 是 REST API 响应格式规范,约定资源对象、关系、分页与错误的标准结构,减少 API 设计分歧。

用途

为 REST API 提供统一的响应结构约定,使客户端可通用处理资源、关系与错误。

机制

响应含 data(资源对象数组/对象)、included(关联资源侧载)、meta、errors。资源对象含 id、type、attributes、relationships。关系用 links 或 data 引用。

用例

  • REST API 响应标准化
  • 前后端数据契约
  • 分页与关联合载

相关工具

参考链接