在 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"
   }]
}