Restful-addressing
提供:Dev Guides
RESTful Webサービス-アドレス指定
アドレス指定とは、サーバー上にある1つまたは複数のリソースを見つけることです。 これは、個人の住所を見つけることに似ています。
RESTアーキテクチャの各リソースは、そのURI(Uniform Resource Identifier)によって識別されます。 URIは次の形式です-
<protocol>://<service-name>/<ResourceType>/<ResourceID>
URIの目的は、Webサービスをホストするサーバー上のリソースを見つけることです。 リクエストの別の重要な属性は、リソースで実行される操作を識別するVERBです。 たとえば、link:/restful/restful_first_application [RESTful Web Services-First Application]の章では、URIは http://localhost:8080/UserManagement/rest/UserService/users で、VERBはGETです。
標準URIの構築
以下は、URIを設計する際に考慮すべき重要な点です-
- 複数名詞を使用-複数名詞を使用してリソースを定義します。 たとえば、ユーザーをリソースとして識別するためにユーザーを使用しました。
- スペースの使用を避ける-長いリソース名を使用するときは、アンダースコア(_)またはハイフン(-)を使用します。 たとえば、authorized%20usersの代わりにauthorized_usersを使用します。
- 小文字を使用-URIは大文字と小文字を区別しませんが、小文字のみでURLを保持することをお勧めします。
- 下位互換性の維持-Webサービスはパブリックサービスであるため、一度公開されたURIは常に利用可能でなければなりません。 URIが更新された場合、HTTPステータスコード300を使用して古いURIを新しいURIにリダイレクトします。
- * HTTP Verbを使用する-GET、PUT、DELETEなどのHTTP Verbを常に使用して、リソースに対する操作を実行します。 URIで操作名を使用するのは良くありません。
例
以下は、ユーザーを取得するための貧弱なURIの例です。
http://localhost:8080/UserManagement/rest/UserService/getUser/1
以下は、ユーザーを取得するのに適したURIの例です。
http://localhost:8080/UserManagement/rest/UserService/users/1