RESTfulWebサービス-アドレス指定

アドレス指定とは、サーバー上にある1つまたは複数のリソースを見つけることです。これは、人の住所を見つけるのに似ています。

RESTアーキテクチャの各リソースは、そのURI(Uniform Resource Identifier)によって識別されます。URIは次の形式です-

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

URIの目的は、Webサービスをホストしているサーバー上のリソースを見つけることです。リクエストのもう1つの重要な属性は、リソースで実行される操作を識別するVERBです。たとえば、RESTful Webサービス-最初のアプリケーションの章では、URIはhttp://localhost:8080/UserManagement/rest/UserService/users 動詞はGETです。

標準URIの構築

URIを設計する際に考慮すべき重要な点は次のとおりです。

  • Use Plural Noun−複数形の名詞を使用してリソースを定義します。たとえば、ユーザーを使用してユーザーをリソースとして識別しました。

  • Avoid using spaces−長いリソース名を使用する場合は、アンダースコア(_)またはハイフン(-)を使用します。たとえば、authorized%20usersの代わりにauthorized_usersを使用します。

  • Use lowercase letters − URIでは大文字と小文字は区別されませんが、URLは小文字のみにすることをお勧めします。

  • Maintain Backward Compatibility− Webサービスはパブリックサービスであるため、一度パブリックにされたURIは常に利用可能である必要があります。URIが更新された場合は、HTTPステータスコード300を使用して、古いURIを新しいURIにリダイレクトします。

  • Use HTTP Verb−リソースの操作を行うには、常にGET、PUT、DELETEなどのHTTP動詞を使用します。URIで操作名を使用するのは適切ではありません。

以下は、ユーザーをフェッチするための不十分なURIの例です。

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

以下は、ユーザーをフェッチするための適切なURIの例です。

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