RESTful Web服務地址


地址是指查詢資源或多個資源位於伺服器上。它類似於定位的人的郵寄地址。

REST架構中的每個資源都由其URI,統一資源識別符號。 URI是以下格式:

<protocol>://<service-name>/<ResourceType>/<ResourceID>

一個URI的目的是要找到承載Web服務的伺服器上的資源。請求的另一個重要屬性是動詞,標識要在資源上執行的操作。例如,在REST Web服 第一應用教學, URI 就是http://localhost:8080/UserManagement/rest/UserService/users 和動詞是GET。

構建一個標準的URI

以下是要考慮在設計一個URI要點:

  • 使用複數名詞 - 使用複數名詞來定義的資源。例如,我們已經使用的使用者識別使用者的資源。

  • 避免使用空格 - 利用下劃線(_)或連字元( - ),使用一個長的資源的名稱,例如,使用authorized_users代替authorized%20users。

  • 使用小寫字母 - 雖然URI是區分大小寫,這是很好的做法,以保持網址只有小寫字母。

  • 保持向後相容 - 由於Web服務是一種公共服務,URI一旦做出公開應始終可用。在某些情況下URI更新,使用HTTP狀態碼,300表示舊的URI重定向到新的URI。

  • 使用HTTP動詞 - 始終使用HTTP動詞像GET,PUT和DELETE做業務上的資源。這是不好用操作名字URI。

例子

下面是一個URI的例子來獲取的使用者。

http://localhost:8080/UserManagement/rest/UserService/getUser/1

以下是良好的URL的一個例子來獲取的使用者。

http://localhost:8080/UserManagement/rest/UserService/users/1