将现有项目添加到REST API中的集合的最佳模式是什么？

我正在设计一个实用的REST API，并且对如何最好地将现有实体添加到集合中有些困惑。我的域模型包括一个具有站点集合的项目。这是一个严格的多对多关系，我无需创建一个显式建模该关系的实体（即ProjectSite）。

我的API将允许使用者将现有站点添加到项目中。我挂断电话的地方是，我真正需要的唯一数据是ProjectId和SiteId。我最初的想法是：

1. POST myapi/projects/{projectId}/sites/{siteId}

但是我也想过

2. POST myapi/projects/{projectId}/sites

与作为JSON内容发送的Site实体。

选项1简单易用，但感觉不太正确，而且我还有其他关系无法遵循此模式，因此它增加了我的API的不一致性。

选项2感觉更好，但引起两个问题：

• 如果发布了新网站（SiteId = 0），我应该创建一个网站还是引发异常？
• 因为我只需要ProjectId和SiteId来创建关系，所以该站点可能发布的其他属性数据有误或缺失。

第三种选择是提供一个仅用于创建和删除关系的简单端点。该端点将期望仅包含ProjectId和SiteId的JSON有效负载。

你怎么看？

POST是“追加”动词，也是“处理”动词。PUT是“创建/更新”动词（用于已知标识符），在这里看起来几乎是正确的选择，因为已知完整的目标URI。projectId并且siteId已经存在，因此您无需“ POST to a collection”即可生成新的ID。

PUT的问题在于它要求主体是您要放入的资源的表示形式。但是这里的目的是要添加到“项目/站点”集合资源，而不是更新站点资源。

如果有人对现有站点进行完整的JSON表示怎么办？您应该更新集合并更新对象吗？您可以支持这一点，但这听起来并不是目的。如你所说，

我真正需要的唯一数据是ProjectId和SiteId

而是，我尝试siteId将POST到集合中，并依赖于POST的“追加”和“处理”性质：

POST myapi / projects / {projectId} / sites

{'ID'： '...' }

由于您要修改的是网站集资源而不是Site 资源，因此您需要的URI。POST可以知道“附加/处理”并将具有该ID的元素添加到项目的网站集中。

通过充实JSON并省略id，仍然为创建项目的全新站点打开了大门。“ No id” ==“从头开始创建”。但是，如果集合URI得到一个id，而没有其他任何东西，那么很清楚需要发生什么。

有趣的问题。:)

我们将这种Patch方法用于这样的事情。您要做的是修改现有项目以向其添加站点。

所以这样的事情会起作用

PATCH myapi/projects/{id} 

在请求正文中将Site实体作为JSON / JSONArray使用。

这样，您可以根据需要使用相同的URL来修改Project的不同部分-实现中的代码必须足够智能，以处理资源的部分修改。