Restful-jax-rs
RESTful Webサービス-Java(JAX-RS)
*JAX-RS* は、RESTful Webサービス用のJAVA APIの略です。 JAX-RSは、作成されたRESTful Webサービスのサポートを提供するJAVAベースのプログラミング言語APIおよび仕様です。 2.0バージョンは2013年5月24日にリリースされました。 JAX-RSは、Java SE 5から利用可能な注釈を使用して、JAVAベースのWebサービスの作成と展開の開発を簡素化します。 また、RESTful Webサービスのクライアントを作成するためのサポートも提供します。
仕様
以下は、リソースをWebサービスリソースとしてマップするために最も一般的に使用される注釈です。
Sr.No. | Annotation & Description |
---|---|
1 |
@Path リソースクラス/メソッドの相対パス。 |
2 |
@GET リソースを取得するために使用されるHTTP Get要求。 |
3 |
@PUT リソースの更新に使用されるHTTP PUT要求。 |
4 |
@POST 新しいリソースを作成するために使用されるHTTP POSTリクエスト。 |
5 |
@DELETE リソースの削除に使用されるHTTP DELETE要求。 |
6 |
@HEAD メソッドの可用性のステータスを取得するために使用されるHTTP HEADリクエスト。 |
7 |
@Produces Webサービスによって生成されたHTTP応答を示します。 たとえば、APPLICATION/XML、TEXT/HTML、APPLICATION/JSONなど。 |
8 |
@Consumes HTTP要求タイプを示します。 たとえば、application/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。 |
注意-link:/restful/restful_first_application [RESTful Web Services-First Application]およびlink:/restful/restful_methods [RESTful Web Services-Methods]でOracleによるJAX-RS 2.0のリファレンス実装であるJerseyを使用しました章。