REST API-如何設計Rest API？

Question

我對何時創建一個新實體感到困惑。 我在節點中實現了這個其余的api：

GET api/v1/services獲取所有服務

GET api/v1/services/{serviceId}/suppliers獲取所有供應商的服務ID

現在，我想添加另一個API以獲取所有供應商，無論使用哪種服務。

以下方法是否是好的做法？

GET api/v1/services/suppliers -獲取所有供應商

PUT api/v1/services/suppliers/{supplierId} -按供應商ID編輯

還是我們需要創建一個新的供應商實體？

Answer 1

我希望@wizard已經找到他的問題的答案。 但是，這是我的想法。

據我了解，資源“ api / v1 / services /供應商”不是收回所有供應商的正確方法。 我們可以使用REST子資源來表示這些關系，從而使其更具可讀性。 但是，此處的供應商資源不能在父資源（服務）之外使用。

但是在這種情況下，我們希望獲取所有供應商詳細信息，並更新特定的供應商信息。 因此，我們需要一個靈活的API。 因此，我們必須創建另一個端點（/ api / v1 / suppliers）來處理供應商詳細信息。

（/ api / v1 / suppliers-獲取所有供應商詳細信息（GET）和/ api / v1 / suppliers / {supplierId} [PUT]以更新特定的供應商。