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 リソースと同じように処理されて、クライアントによって使用可能になります。
手順
タスクの結果
アプリケーションに WADL サービス文書を追加し、使用しているサービスの表現をクライアントが取得できるようにしました。 デフォルトでは、リソースに対して OPTIONS 要求を発行して、個別リソースの WADL 表現を取得することもできます。 そのようにする場合には、OPTIONS 要求での WADL 文書の自動生成を使用不可にできます。