
RESTful Web 服務 - 定址
定址是指在伺服器上找到一個或多個資源。這類似於找到一個人的郵政地址。
REST 架構中的每個資源由其 URI(統一資源識別符號)標識。一個 URI 具有以下格式 -
<protocol>://<service-name>/<ResourceType>/<ResourceID>
一個 URI 的目的是在託管 Web 服務的伺服器上找到一個或多個資源。請求的另一個重要屬性是 VERB,它標識要在資源上執行的操作。例如,在 RESTful Web 服務 - 第一個應用程式 一章中,URI 是 https://:8080/UserManagement/rest/UserService/users,VERB 是 GET。
構造標準 URI
設計 URI 時,需要考慮以下重要事項 -
使用複數名詞 - 使用複數名詞來定義資源。例如,我們使用 users 來標識 users 作為資源。
避免使用空格 - 在使用較長的資源名稱時,請使用下劃線 (_) 或連字元 (-)。例如,使用 authorized_users 而不是 authorized%20users。
使用小寫字母 - 儘管 URI 不區分大小寫,但最好只將 url 保持為小寫字母。
保持向後相容性 - 由於 Web 服務是一種公共服務,因此一旦公開 URI,該 URI 就應該始終可用。如果 URI 得到更新,請使用 HTTP 狀態程式碼 300 將較舊的 URI 重定向到新的 URI。
使用 HTTP Verb - 始終使用像 GET、PUT 和 DELETE 這樣的 HTTP Verb 來對資源進行操作。最好不要在 URI 中使用操作名稱。
示例
下面是一個獲取使用者的較差 URI 的示例。
https://:8080/UserManagement/rest/UserService/getUser/1
下面是一個獲取使用者的良好 URI 的示例。
https://:8080/UserManagement/rest/UserService/users/1
廣告