通過向另一個（相關）資源發送POST請求來創建/修改資源

Question

我正在爲測試和測試運行元數據設計一個RESTful API。我有兩個資源：Test和TestRun。在數據庫中他們有一對一的關係。

首先，我通過發送POST到api/v1/test創建一個Test資源。

然後我必須開始這個測試。我通過發送POST到api/v1/test/{id}/run來創建TestRun資源，該資源與該Test資源相關。

然後，我還可以通過發送POST到api/v1/test/{id}/finish，該修改對應TestRun資源停止測試（設置一些領域，如finish_time，result等）。

API的用戶將永遠不會有GET訪問TestRun資源，並且只會通過其相關的Test資源訪問它們。

雖然看起來這個設計對於API用戶來說非常簡單，但我懷疑這對開發人員來說也很簡單。這個設計是否足夠好？它是否違反任何REST原則或最佳實踐？我將不勝感激這方面的任何投入。

整個API的擴展設計說明：https://gist.github.com/Ch00k/27724e29ec1bf044ebbfdabef9e842d5

Answer 1

您的API不會允許訪問testrun，所以testrun似乎不是一個REST資源。實際上，就測試而言，您的URL是REST的混合體，而RPC是特別是/run和/finish路徑的混合體。

RPC不休息，所以我想這返工一點點：

• 僅使用一個類型的資源，測試，在api/v1/test/{id}。
• 測試具有可以使用retrievd狀態的GET請求api/v1/test/{id}：
  • status：stopped，started，finished，...
  • finish_time
  • result
  • ...
• 測試狀態改變使用包含新狀態的JSON主體唱出PATCH請求api/v1/test/{id}：{"status": "started"}開始測試等。這取代了RPC調用。