api - REST:处理计算的和相关的资源属性

Question

假设我有一个类似 Wordpress 的博客系统，其资源包括用户、帖子和评论资源。这些资源中的每一个都作为一个单独的集合存储在 MongoDB 数据库中，并且它们通过 ObjectID 值字段相互关联。具体来说:一个 Post 有一个 author 字段，其中包含其相关用户资源的 ObjectID，一个 Comment 有一个用于相关用户的 author 字段和一个 relatedPost 评论适用的帖子的 ObjectID 字段。

显然，在许多情况下，单独检索这些资源效率不高。一个示例是在客户端显示特定的 Post 资源:理想情况下，该帖子作者的姓名应显示在帖子标题和正文旁边，但 Post 文档本身仅包含相关用户文档的 ObjectID。

简单的解决方案是在服务器端检索这些相关属性并将附加数据发送到客户端。虽然这对于像我正在描述的博客这样简单的事情来说是一个很好的解决方案，但它会为更复杂的系统带来一些问题。具体来说:

• 如果 GET/api/posts/#{postID} 返回一个 JSON 对象，其属性并非给定 Post 文档的真正属性，我该如何通知客户端？
• 作为第一个问题的扩展:如何通知客户端尝试使用 POST 更新该文档的给定字段到相同的 URI 实际上不会更新资源？<
• GET/api/posts/#{postID} 是否更适合仅返回该文档中真正存在的属性，并带有辅助 URI，如 /api/posts/#{postID}/withauthor 返回文档及相关信息？

更具体地说，假设这些资源由以下 Mongoose.js 样式的模式定义:

User: {
  _id: ObjectID,
  username: String,
  name: {
    first: String,
    last: String
  }
}

Post: {
  _id: ObjectID,
  author: ObjectID,
  title: String,
  body: String,
  timestamp: Date
}

Comment: {
  _id: ObjectID,
  author: ObjectID,
  relatedPost: ObjectID,
  title: String,
  body: String,
  timestamp: Date
}

我想要一个可GET 的资源，它返回一个 Post 文档的完整表示以及相关作者的名字和姓氏，所以像这样:

request: GET /api/posts/529635f828ab08e00d000084

response: {
  _id: "529635f828ab08e00d000084",
  title: "A Post",
  body: "It turns out I have very little to say.",
  author: {
    _id: "928495a321cf09c11d198001",
    name: {
      first: "John",
      last: "Smith"
    }
  }

我不想让客户相信更新 author.name.first 和 POST 将 JSON 转换为相同的 URI 会有任何影响文档在后端的 author 属性。只有更新 author._id 才能更改文档的作者。对此是否有通用的“RESTful”方法？

我知道这里没有唯一的正确答案，我之前描述的简单方法适用于这个特定问题。但我很好奇其他人是如何在更复杂的 API 中解决这个问题的。

(注意:很有可能是我想多了。)

Answer 1

这是设计 RESTful 服务时非常常见的问题。我发现处理此问题的最佳方法是正确记录您的 RESTful 服务(甚至可能为客户提供一个 Playground 环境来试用 api)。以下是我将如何处理您的用例。

我将对给定的 blog_post 发出 GET 请求，该请求只会返回 blog_post 实体

GET /api/posts/abcd1234

返回带有作者 ID 的基本 blog_post。

现在，我将对与此相同的 GET 请求进行变体:

GET /api/posts/abcd1234?comments=true&authors=true&startIndex=0&offset=10&sortDirection=Ascending&sortBy=comment_date

上面的 api 将返回作者的帖子和作者的评论列表以及与分页等相关的一些其他过滤器。客户端可以在此 api 过滤器上使用他们喜欢的任何排列组合，并且根据过滤器，您返回数据返回，类似于

blog_post:{

your normal blog_post fields here ...

full author object here ...

comments: [{

list of comments (with author for each comment and applied filter) here ...

}]

}

这还将为同一博客文章中的其他请求维护您的 RESTful 方法。例如，更新 blog_post 的作者

POST /api/posts/abcd1234

仍然只会更新 blog_post 中的 authorId，因为记录此 POST 请求的方式只是让客户知道您在这里唯一期望的是一个 blog_post 对象，其中包含 id、标题、正文、authorId 和所有其他字段他们可能作为 blog_post 请求的一部分发送给您的信息将被丢弃/忽略。

客户将如何使用您的 REST 服务，在很大程度上取决于您对 REST 服务的记录情况。