RESTful Webサービス-Java(JAX-RS)
JAX-RSRESTfulWebサービス用のJAVAAPIの略です。JAX-RSは、作成されたRESTfulWebサービスのサポートを提供するJAVAベースのプログラミング言語APIおよび仕様です。その2.0バージョンは2013年5月24日にリリースされました。JAX-RSはJavaSE 5から入手可能なアノテーションを使用して、JAVAベースのWebサービスの作成とデプロイメントの開発を簡素化します。また、RESTfulWebサービスのクライアントを作成するためのサポートも提供します。
仕様
以下は、リソースをWebサービスリソースとしてマップするために最も一般的に使用されるアノテーションです。
シニア番号 | 注釈と説明 |
---|---|
1 |
@Path リソースクラス/メソッドの相対パス。 |
2 |
@GET リソースをフェッチするために使用されるHTTPGetリクエスト。 |
3 |
@PUT リソースの更新に使用されるHTTPPUTリクエスト。 |
4 |
@POST 新しいリソースを作成するために使用されるHTTPPOSTリクエスト。 |
5 |
@DELETE リソースを削除するために使用されるHTTPDELETEリクエスト。 |
6 |
@HEAD メソッドの可用性のステータスを取得するために使用されるHTTPHEADリクエスト。 |
7 |
@Produces Webサービスによって生成されたHTTP応答を示します。たとえば、APPLICATION / XML、TEXT / HTML、APPLICATION / JSONなどです。 |
8 |
@Consumes HTTPリクエストタイプを示します。たとえば、アプリケーション/ x-www-formurlencodedは、POSTリクエスト中にHTTPボディのフォームデータを受け入れます。 |
9 |
@PathParam メソッドに渡されたパラメーターをパスの値にバインドします。 |
10 |
@QueryParam メソッドに渡されたパラメーターをパス内のクエリパラメーターにバインドします。 |
11 |
@MatrixParam メソッドに渡されたパラメーターをパス内のHTTPマトリックスパラメーターにバインドします。 |
12 |
@HeaderParam メソッドに渡されたパラメーターをHTTPヘッダーにバインドします。 |
13 |
@CookieParam メソッドに渡されたパラメーターをCookieにバインドします。 |
14 |
@FormParam メソッドに渡されたパラメーターをフォーム値にバインドします。 |
15 |
@DefaultValue メソッドに渡されるパラメーターにデフォルト値を割り当てます。 |
16 |
@Context リソースのコンテキスト。たとえば、コンテキストとしてのHTTPRequest。 |
Note−RESTfulWebサービス-最初のアプリケーションとRESTfulWebサービス-メソッドの章で、OracleによるJAX-RS2.0のリファレンス実装であるJerseyを使用しました。