WADL を使用したサービス文書の生成

Web アプリケーション記述言語 (WADL) は、HTTP ベースのアプリケーション用の記述言語です。 これは現在、World Wide Web Consortium (W3C) のメンバーによる提案となっています。 プログラムで WADL を使用すると、マシンが処理可能な方法でサービスに関する情報を提供できます。 例えば、Extensible Stylesheet Transformation (XSLT) 文書を使用して、カスタム XSLT および XSLT プロセッサーによって WADL 文書を変換できます。

このタスクについて

デフォルトでは、任意の Java™ API for RESTful Web Services (JAX-RS) URL に対して HTTP OPTIONS 要求を呼び出すことによって、特定のリソースで WADL 文書を要求できます。 ほとんどの HTTP クライアントで OPTIONS 要求を発行できます。 要求から戻される WADL 文書は、JAX-RS アノテーションからの情報を用いてリソースを記述します。

WADL は、ユーザーが使用可能なサービスを記述するのに役立つ 1 つの開発標準となっています。 WADL 文書は XML で書かれています。 開発者は、XSTL パーサーまたは XML パーサーを使用して、サービスに関する文書を生成できます。 場合によっては、ユーザーは、WADL 文書を検査して RESTful サービスに関する理解を動的に与えるクライアントを作成することもできます。

開発者は、IBM® JAX-RS を使用して、アプリケーションで使用可能なすべてのリソースについて記述した、WADL 文書の JAXB XML 表現を生成できます。 JAX-RS リソース・メソッドから、JAXB 表現を戻せます。 その後、WADL 文書リソースは他の JAX-RS リソースと同じように処理されて、クライアントによって使用可能になります。

手順

  1. 開発環境を構成します。
    1. JAX-RS アプリケーションの開発を開始する前に、クラスパスに JAX-RS ライブラリーを追加して、 開発環境をセットアップする必要があります。
  2. JAX-RS Web アプリケーションのリソースを定義します。
    1. リソースは、RESTful サービスの基本ビルディング・ブロックです。リソースは、静的または動的な更新データを含むことができます。オンライン書店アプリケーションのリソースの例には、書籍、書店からの注文、およびユーザーのコレクションが含まれます。ご使用のアプリケーションのリソースを識別することにより、サービスをさらに便利で開発しやすいものにできます。
  3. JAX-RS アプリケーションを構成します。

    お客様のニーズに応じて、複数の方法で JAX-RS アプリケーションを構成できます。 Java Platform, Enterprise Edition (Java EE) 6 の機能を活用するには、アノテーション・スキャン機能を使用します。 アノテーション・スキャンを使用することにより、JAX-RS javax.ws.rs.core.Application サブクラス を省略したり、javax.ws.rs.core.Application サブクラスの定義を最低限にすることができます。 あるいは、IBM JAX-RS サーブレットおよびフィルターで有効な機能を 使用したい場合は、IBM JAX-RS サーブレットまたはフィルター を指定できます。

    JAX-RS バージョン 1.1 構成メソッドの 1 つを使用して、 アプリケーションで javax.ws.rs.core.Application サブクラスを省略したり、 すべての JAX-RS クラスを検索して使用するように JAX-RS ランタイム環境に通知するために 空のクラス・セットを返す javax.ws.rs.core.Application サブクラスをアプリケーションで 使用したりすることができます。 このメソッドは、アプリケーションの作成時に、関連するすべての JAX-RS クラスを javax.ws.rs.core.Application サブクラスに手動で追加する手間を省略したい場合などに使用します。

    特定の IBM JAX-RS サーブレットおよびフィルターを 指定することにより、特定の IBM JAX-RS の動作を 確実に利用することができます。例えば、IBM JAX-RS フィルターは、 同じ URL パターンの JAX-RS リソースと JavaServer Pages (JSP) ファイルを使用する Web アプリケーション を開発する際に役立ちます。

    オプションの web.xml ファイルの使用をサポートする JAX-RS V1.1 構成メソッド がありますが、セキュリティー制約またはロールを指定したい場合や、web.xml ファイルを使用して 使用可能な他の機能を利用したい場合には、web.xml ファイルに情報を指定する必要があります。

    JAX-RS アプリケーションを構成するには、以下の 3 つの方法のうち 1 つを選択します。

    • JAX-RS 1.1 メソッドを 使用して JAX-RS アプリケーションを構成する

      アノテーション・スキャン機能 または JAX-RS 1.1 構成メソッドを使用したい場合に、この方法を使用します。 アノテーション・スキャン機能を使用することにより、アプリケーションの可搬性を向上させたり、 構成コードの量を最小化したり、アプリケーション・コードを変更せずにアプリケーションを 動的に変更したりすることができます。

    • JAX-RS サーブレット用 web.xml ファイルの構成

      動作を変更するためにサーブレット初期設定パラメーターを使用して有効にする機能を指定したい場合、 および IBM JAX-RS サーブレットを確実に取得したい 場合に、この方法を使用します。サーブレットを使用する場合は、ベース URL に付加されるサーブレット・パスを web.xml ファイル内に 定義できます。

    • JAX-RS フィルター用 web.xml ファイルの構成

      さまざまな URL パターンの JSP、その他のサーブレットおよびフィルター、 および JAX-RS リソースがあり、フィルターを使用したい場合に、この方法を使用します。 有効な URL を示すフィルターを定義し、それらの URL でフィルターが起動されるように web.xml ファイルを 構成することができます。

  4. WADL を使用してサービス文書を生成します。 また、org.apache.wink.common.model.wadl.WADLGenerator を使用すると、独自の WADL 文書を作成できます。 WADLGenerator は Java Architecture for XML Binding (JAXB) アノテーション付きオブジェクト・モデルを作成し、@OPTIONS リソース・メソッドの応答エンティティーとしてこのモデルを簡単に戻すことができるようにします。
  5. JAX-RS Web アプリケーションをアセンブルします。
    1. JAX-RS Web アプリケーション用に Java クラス・ファイルを開発し、JAX-RS サーブレットを使用可能するために web.xml ファイルを編集したら、アプリケーションをアセンブルできます。Web アプリケーションを Web アーカイブ (WAR) パッケージにアセンブルします。必要に応じて、WAR パッケージをエンタープライズ・アーカイブ (EAR) パッケージにアセンブルできます。
  6. JAX-RS Web アプリケーションをデプロイします。
    1. JAX-RS Web アプリケーションをアセンブルしたら、Web アーカイブ (WAR) パッケージまたはエンタープライズ・アーカイブ (EAR) パッケージを、アプリケーション・サーバー上にデプロイする必要があります。

タスクの結果

アプリケーションに WADL サービス文書を追加し、使用しているサービスの表現をクライアントが取得できるようにしました。 デフォルトでは、リソースに対して OPTIONS 要求を発行して、個別リソースの WADL 表現を取得することもできます。 そのようにする場合には、OPTIONS 要求での WADL 文書の自動生成を使用不可にできます。


トピックのタイプを示すアイコン タスク・トピック



タイム・スタンプ・アイコン 最終更新: last_date
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=cord&product=was-nd-mp&topic=twbs_jaxrs_wink_wadl
ファイル名:twbs_jaxrs_wink_wadl.html