將 rest api 端點從動詞修改為名詞

Question

我有一些 rest 端點......看起來像這樣

PUT --> /container/{vendorID}/{pluginID}/{containerName}/start
PUT --> /container/{vendorID}/{pluginID}/{containerName}/restart
PUT --> /container/{vendorID}/{pluginID}/{containerName}/stop

我看到start ， stop是一種動作/動詞。 現在確定如何將它們轉換為名詞。

尋找一些建議。

Answer 1

我看到開始，停止是一種動作/動詞。 現在確定如何將它們轉換為名詞。

認識到資源是文檔的概括。 作為操作這些文檔的副作用，我們正在觸發有用的工作。 見韋伯 2011 。

“名詞”是文檔的名稱。

您可以通過多種方式設計文檔（也稱為“資源模型”）。 您可能有一個容器的起始文檔。 對於每個要啟動它的場合，您可能有一個不同的啟動文檔。 您可能對每個容器都有一個時間表，並且您可以編輯該時間表以指示您希望什么時候開始。 您可能只有一個容器本身的文檔，然后對其進行編輯。

需要記住的一點是 REST/HTTP 非常關心緩存，所以你應該注意緩存失效的規則； 通用 HTTP 組件目前不支持任意資源的失效，因此您在設計資源 model 時可能需要考慮這些限制。