RESTful POSTS，您是否将对象 POST 到单数或复数 Uri？

Question

这些 URI 中哪一个更“适合”接收 POST（添加产品）？是否有任何可用的最佳实践或者只是个人偏好？

/product/（单数）

或

/products/（复数）

目前我们使用 /products/?query=blah 进行搜索和 /product/{productId}/ 用于 GET、PUT 和删除单个产品。

Answer 1

由于 POST 是“追加”操作，因此 POST 到 /products可能更加英国化，因为您会将新产品追加到现有产品列表中。

只要您对 API 中的某些内容进行了标准化，我认为就足够了。

由于 REST API 应该是超文本驱动的，因此 URI 无论如何都是相对无关紧要的。客户端应该从返回的文档中提取 URI，并在后续请求中使用这些 URI；通常，应用程序和人们不需要猜测或直观地解释 URI，因为应用程序将明确指示客户端哪些资源和 URI 可用。

Answer 2

通常，当您事先不知道资源的标识符时，您可以使用 POST 创建资源，而当您知道时，则使用 PUT。因此，您可以 POST 到 /products，或 PUT 到 /products/{new-id}。

使用这两种方法，您将返回 201 Created，并且使用 POST 还会返回一个 Location 标头，其中包含新创建资源的 URL（假设已成功创建）。

Answer 3

在 RESTful 设计中，有一些围绕创建新资源的模式。您选择的模式很大程度上取决于谁负责为新创建的资源选择 URL。

如果客户端负责选择 URL，则客户端应 PUT 到资源的 URL。相反，如果服务器负责资源的 URL，则客户端应 POST 到“工厂”资源。通常，工厂资源是正在创建的资源的父资源，并且通常是复数的集合。

因此，就您而言，我建议使用 /products

Answer 4

您发布或获取单一事物：单一产品。

有时您会在没有特定产品（或有查询条件）的情况下获取。但你还是用单数说。

你很少使用复数形式的名字。如果您有一个集合（产品目录），那么它就是一个目录。

Answer 5

我只会发布到单数 /product。很容易混淆这两个 URL，从而造成混淆或犯错误。

Answer 6

正如很多人所说，你可以选择任何你喜欢的风格，只要保持一致即可，但我想指出双方的一些论点；我个人偏向于单数

支持复数资源名称：

• URL 方案的简单性，因为您知道资源名称始终为复数，
• 许多人认为这种约定类似于数据库表的寻址方式，并认为这是一个优势
• 似乎更广泛采用

赞成使用单数资源名称（在处理多个资源时不排除复数），

• URL 方案更复杂，但您可以获得更多的表达能力，
• 当您根据资源名称处理一个或多个资源时，您总是知道，如反对检查资源是否有额外的 Id 路径组件
• 复数对于非母语人士来说有时会更困难（当不是简单的“s”时）
• URL 较长
• ，“s”似乎是多余的
• 从程序员的角度来看 将路径参数视为集合的子资源而不是考虑它的本质是很尴尬的：只是它标识的资源的 ID，
• 您可以仅在需要的地方应用过滤参数（具有复数资源名称的端点） ）

Answer 7

您可以对所有这些内容使用相同的 url，并使用 MessageContext 来确定 Web 服务的调用者想要执行的操作类型。
没有指定语言，但在 Java 中你可以做这样的事情。

WebServiceContext ws_ctx;
MessageContext ctx = ws_ctx.getMessageContext();
String action = (String)ctx.get(MessageContext.HTTP_REQUEST_METHOD);
if(action.equals("GET")
  // do something
else if(action.equals("POST")
  // do something

这样您就可以检查发送到 Web 服务的请求类型，并根据请求方法执行适当的操作。