REST API URL 設計最佳實踐

Question

我正在為具有大量設置參數的系統開發 REST API。 所有這些參數都應該能夠改變。 這些參數按類別分組並具有唯一名稱。 參數有不同的測量單位，它們是不同的類型（布爾值、數字或具有多個屬性的對象）。 例如，我有屬於類別“過程”的參數“流”和“閾值”和屬於類別“一般”的一個參數“名稱”。 定義 URL 的常用方法是什么？ 是嗎：

/process/flow

/process/threshold

/general/name 

或者每個參數都有一個唯一的數字（id）更好。 在不使用類別的情況下，URL 可以簡單地定義如下：

/param/{id}

Answer 1

REST API URL 設計最佳實踐

REST 不關心 URL 設計。 只要您使用的標識符符合RFC 3986描述的產生式規則，您就可以使用您喜歡的任何拼寫。

/general/name
/param/12345
/3eaa7b95-c46b-4290-9614-546dc17c1f2d

這些都很好。 從通用組件（如 Web 瀏覽器或緩存）的角度來看，URI 是不透明的——我們從不“解析”URI 以從中提取語義信息。

這意味着服務器可以在 URI 中嵌入識別資源所需的任何信息——無論是人類可讀的令牌、代理鍵還是散列......都很好。