读者查阅参考资料，通常是为了快速回答具体的格式问题。这个页面很适合用来定义请求包裹结构，以及那些会在多个端点中重复出现的命名规则。

示例载荷

{
  "data": {
    "id": "doc_123",
    "attributes": {
      "title": "Welcome",
      "status": "draft"
    }
  }
}

字段约定

把整个 API 中都成立的规则记录在这里：

  • 标识符格式
  • 时间戳格式
  • 枚举值大小写
  • optional 字段与 nullable 字段的区别

校验说明

如果平台会稳定地拒绝不合法请求，就应该在这里写明，并链接到 错误 页面，给出精确的响应约定。