JSON API问题。 包含与关系

Question

我读这个构建的API端点之前。 我阅读了有关复合文件的报价：

为了减少HTTP请求的数量，服务器可以允许包含相关资源以及所请求的主要资源的响应。 这样的响应称为“复合文档”。

这是使用JSON API规范的示例JSON响应：

{
  "data": [{
    "type": "articles",
    "id": "1",
    "attributes": {
      "title": "JSON API paints my bikeshed!"
    },
    "links": {
      "self": "http://example.com/articles/1"
    },
    "relationships": {
      "author": {
        "links": {
          "self": "http://example.com/articles/1/relationships/author",
          "related": "http://example.com/articles/1/author"
        },
        "data": { "type": "people", "id": "9" }
      },
      "comments": {
        "links": {
          "self": "http://example.com/articles/1/relationships/comments",
          "related": "http://example.com/articles/1/comments"
        },
        "data": [
          { "type": "comments", "id": "5" },
          { "type": "comments", "id": "12" }
        ]
      }
    }
  }],
  "included": [{
    "type": "people",
    "id": "9",
    "attributes": {
      "first-name": "Dan",
      "last-name": "Gebhardt",
      "twitter": "dgeb"
    },
    "links": {
      "self": "http://example.com/people/9"
    }
  }, {
    "type": "comments",
    "id": "5",
    "attributes": {
      "body": "First!"
    },
    "relationships": {
      "author": {
        "data": { "type": "people", "id": "2" }
      }
    },
    "links": {
      "self": "http://example.com/comments/5"
    }
  }, {
    "type": "comments",
    "id": "12",
    "attributes": {
      "body": "I like XML better"
    },
    "relationships": {
      "author": {
        "data": { "type": "people", "id": "9" }
      }
    },
    "links": {
      "self": "http://example.com/comments/12"
    }
  }]
}

因此，从我所见，关系部分提供了有关articles表和其他表之间的关联的基本/稀疏信息。 看起来一篇文章属于作者，拥有has_many条评论。

链接将用于什么目的？ API是否必须使用链接才能接收有关该关系的更详细的JSON？ 这不需要额外的API调用吗？ 这样有效吗？

“包含”部分似乎包含有关关系/关联的更详细信息？

“包含”和“关系”都是必需的吗？ 同时需要这两个部分的直觉是什么？

Answer 1

想法是， resource中的relationship只是给出链接数据（即唯一标识相关resource基本数据-这些数据是id和type ），以便将其最小化。

另一方面，如果您想发送有关某些相关resources详细信息（例如，以最小化HTTP请求的数量），则此处included部分。 需要注意的是， included部分预计将只包含resources这都涉及到无论是primary resource （内即data部分），或included资源（此约束被称为full linkage的规格）。

简而言之， resource的“ relationships部分告诉您哪些 resources与给定resource相关，而included部分则告诉您这些resources是什么 。

就链接而言，当您具有has_many关系时，它们可能会派上用场，对于它们，链接数据本身可能包含数千个id / type记录，因此使您的响应文档很大。 如果客户在请求基本resource时不一定需要这些resource ，则可以决定通过link使它们可用。