JSON 表示形式中的链接关系

Question

我正在设计一个基于 JSON 表示的 RESTful API。为了遵守 HATEOAS，我广泛使用资源之间的链接。因此，我遵循此建议以与 ATOM 非常相似的方式序列化链接链接。

现在，我有时在识别正确的链接关系类型时遇到问题。当资源包含指向其自身的链接时，self 关系就很明显。当资源是子资源的集合和聚合，或者包含许多相关资源的链接时，它会变得更加复杂。

以一篇博客文章为例，考虑一个返回博客文章快照的资源——包括该博客文章的作者、标签和评论。 显然，该资源包含许多子资源，当然还应该提供指向它们的单独链接：

示例资源：

{
   "blogpost":{
      "link":{
         "rel":"self",
         "href":"http://blog/post/4711"
      },
      "author":{
         "name":"Bob",
         "link":{
            "rel":"???",
            "href":"http://author/uri"
         }
      },
      "title":"foobar",
      "content":"A long article here…",
      "comments":[
         {
            "comment":"great article",
            "link":{
               "rel":"???",
               "href":"http://blog/post/4711/comment/1"
            },
            "author":{
               "name":"John Doe",
               "link":{
                  "rel":"???",
                  "href":"http://author/uri"
               }
            }
         }
      ],
      "tags":[
         {
            "value":"foo",
            "link":{
               "rel":"???",
               "href":"http://blog/post/4711/tag/foo"
            }
         }
      ]
   }
}

那又怎样给定的链接是否有适当的关系？我知道存在诸如 tag 之类的关系类型，但并非所有资源都与现有关系类型匹配。或者在引用作者/标签/评论时使用 self 是否可以，因为它与封闭的 JSON（子）对象的上下文相关？ self 所指的语义实体是什么？

RFC 5988 规定：

链接的上下文可以是提要 IRI 或条目 ID，具体取决于它出现的位置

如何用 JSON 来解释它？每个新对象 {…} 都是一个新上下文吗？

谢谢！

Answer 1

这是一个很好的问题。如果您查看 Hal 的示例，您将看到 rel 是在子上下文中定义的资源。
我不知道有关 rel 何时与整个资源或包含的子资源相关的任何明确指南。
我可以向您指出的唯一额外信息是 RFC5988 中的锚参数，它允许您使用片段或全新的 URI 重新定义上下文 IRI。

理想情况下，您的媒体类型应说明嵌套资源的上下文 IRI 是否不同，或者上下文 IRI 是否需要显式更改。这将是使用像 application/vnd.hal+json 这样的媒体类型而不是像 Hal 规范所述的普通旧 application/json 的另一个优点：

@rel - 用于识别目标 URI 与“主题”的关系
资源”。主题资源是最接近的父资源
元素。

Answer 2

LSON-LD

您也许可以看看 JSON-LD （链接数据。它看起来比 HAL但您可以用它做更多事情。JSON

-LD 正在 W3C 内部进行标准化，这里是 。

提案推荐

• 马努 回答Sporny，JSON-LD 的创建者）
• JSON-LD 文章和演示文稿
• 九头蛇 (控制台)

抱歉我没有时间提供示例..

Answer 3

现在回答这个问题有点晚了，但为了将来的参考，这就是我解决这个问题的方法：

{
   "blogpost":{
      "title":"foobar",
      "content":"A long article here…",
      "link":{
         "rel":"self",
         "href":"http://blog/post/4711"
      },
      "link":{
         "rel": "author",
         "href": "http://author/uri",
         "alt":"Bob"
      },
      "link":{
        "rel": "comment",
        "alt": "great article",
        "href":"http://blog/post/4711/comment/1"
      },
      "link": {
        "rel":"tag",
        "href":"http://blog/post/4711/tag/foo",
        "alt":"foo"
      }
   }
}

当你想到它时，评论、标签等都是链接到你的帖子的不同资源......为什么不把它们全部变成什么他们是..链接！您甚至可以节省回复的大小；）