Question

我确定此主题必须已被覆盖，所以我很高兴能够指出我在搜索时可能遗漏的任何文章等。

我需要实现一个非常简单的REST API来添加和检索主/明细关系中的记录。我的两个选项如下：

选项1

POST /master
POST /master/[id]/details
GET  /master/[id]
GET  /master/[id]/details

赞成

感觉更多＆＃39; RESTful＆＃39;
可以检索细粒度数据以提高性能

CONS

没有至少一个细节，主人没有意义。如何处理原子性？如果在添加时细节失败，则在主服务器上补偿DELETE？
检索主/明细集所需的多次调用

选项2

POST /master_and_details
GET  /master_and_details/[master id]

赞成

易于管理原子性

CONS

更复杂的管理结构
GET必须返回整个结构（并不总是有效）
感觉不太安静＆＃39;

谢谢，约翰

Answer 1

REST或多或少地决定了选项1，选项2只是一个普通的旧的api。

如果没有至少一个细节，主人没有意义的声明可能是错误的。你不知道聪明的开发人员将来如何使用你的api。你可以猜，但你真的不知道。

如果你真的需要自己的复合解决方案，你总是可以在更高级别添加一个接口，调用两个独立的接口并返回一个复合对象。

选项1允许微服务实现的可能性 - 或者至少将关注点分离为两个可分离的对象。仅选项2不会。

Answer 2

至少为了争论，冒着我微薄的声誉，我会尝试第三种方法。

你有两个资源：主人和细节。（不是“细节”，除非你想完全复数，在这种情况下你会有“主人”和“细节”）。主人的表示将包括细节的集合，或（更好）与细节的链接关系。考虑http://tools.ietf.org/html/rfc6573该链接关系。

因此，主人的GET包括（直接或间接通过关系）细节的集合。主人的POST / PUT也可以通过他们在表单数据中的存在来POST / PUT详细信息成员。

任何细节也可以独立于主人进行GET / PUT / POSTED。在这里，设计在某种程度上取决于细节是否具有自己的主键，而使用复合键与其主键。如果它有自己的主键，那么你可以：

GET /detail/{detailKey}  - gets specific detail
POST /detail  - creates new detail
GET /master/{masterkey}/detail  -- gets all details for master
GET /master{masterkey}/detail/{detailkey} -- get specific detail

显然，在POST上，数据必须包含master的密钥。

您会看到有多个URI可用于获取详细信息。我不认为那是错的，但它确实引入了一些含糊之处：如果detailKey实际上不是masterKey的孩子，那么你是404吗？我会说是的。

如果详细信息使用复合键，则无法独立于主设备进行GET，因此无法支持上面显示的第一个表单。此外，上面最后一个示例中使用的{detailKey}将是主服务器中详细信息项的标识符（通常是序列号）。

Answer 3

我肯定会选择选项1 ，因为选项2 与REST无关。但这并不意味着您需要使用多个查询来获取Master + Detail。
由于Detail属于Master（因此它是其中的一部分），我认为在查询时Master和Detail完全可以。 Master。
您也可以考虑使用参数来控制是否发送Detail 因此，您可以使用GET /master/1而不是执行GET /master/1?detail=true 对于POST和PUT或多或少，同样可行。只是没有查询参数，你有一个＆＃34;部分＆＃34;关于Detail。使用JSON的示例：

{
  "data": {
    "name": "master",
    "detail": [
      {
        "name": "detail1"
      },
      {
        "name": "detail2"
      }
    ]
  }
}

包含此数据的POST可以使用Master＆＃34; master＆＃34;创建name和Detail的2 Master s。

正如@ElroyFlynn之前所述，Detail也可以在没有Master的情况下访问，如果这样做的话。想想有Thread和Post的论坛。通常，Thread为Master，每Post为Detail。但是如果你想搜索过去一小时的所有Post，你肯定想直接查询帖子（查询可能类似于GET /post?max_age=1h）。

另外，我不同意，Master没有Detail的情况不会发生。可能会出现这样的情况，但是在论坛的情况下，Thread就自己提出了这种情况。
对于atomicity：
这取决于具体情况：如果删除User，通常会保留Post s（即使在StackOverflow上）。如果您改为删除Thread，我猜您可以将Post删除为。

REST的主/细节

3 个答案: