json - REST 资源的 JSON 表示是否应该使用相关资源的 URI？

Question

例如，在 REST 资源的 JSON(或 XML)表示中使用 URI 是最佳实践吗？

例如，对于具有附件列表的资源，其中每个附件都有一个 id，可用于使用类似 http://myserver.com/resources/attachments/ 的 URL 来检索它。 :

{
    fileName: "screenshot.png"
    contentType: "application/octet-stream"
    id: 52004
}

我是否还应该添加一个 uri 元素，例如

{
    fileName: "screenshot.png"
    contentType: "application/octet-stream"
    id: 52004
    uri: /resources/attachments/52004
}

Answer 1

是的，我认为您应该包含指向集合中每个项目的链接。没有链接的 API 不是 RESTful(更重要的是，没有那么有用)。如果您认为人类客户更喜欢链接而不是关于如何通过 ID 请求项目的说明，那么这同样适用于非人类客户。您还应该通过提供链接关系让客户了解项目与当前资源的关系:

link : { uri: "/resources/attachments/52004", rel: "/rels/file-attachment" }

约翰