在 API REST 中获取资源的不同端点

Question

我有一个带有GET端点的 REST API 来根据 ID 检索产品。 现在我需要基于另一个属性检索产品，我不知道我是否必须使用相同的端点并在那里处理多个案例或编写不同的端点，每个案例一个。

谢谢！

Answer 1

假设你有

GET /product/{id}

并且您希望能够通过其他属性查找产品。 如果该属性唯一标识了您可以执行的产品：

GET /product?someOtherAttribute=foo

返回

302 FOUND
Location: /product/5

如果您想避免往返，您可以直接返回产品的内容，但正如您指出的那样，您的 controller 中可能需要额外的逻辑。

如果该属性不能唯一标识产品，我建议使用分页集合响应：

GET /products?someOtherAttribute=foo

返回

200 OK
{
   products: [{
       url: "/product/5"
   }, {
       url: "/product/6"
   }]
}