REST API 定義ファイルからの JAX-RS 2.0 クライアントの生成

Java™ Platform, Enterprise Edition (Java EE) 7 Web プロジェクトで、Java API for RESTful Web Services (JAX-RS) 2.0 クライアントを生成することができます。この JAX-RS 2.0 クライアントは、名前が swagger.json という REST API 定義ファイルに基づいています。

このタスクについて

重要: Liberty に適用可能

手順

  1. 以下のいずれかのオプションを実行して、「JAX-RS クライアントの生成」ウィザードを開きます。
    • ワークスペースで swagger.json ファイルを右クリックして、「RESTful サービス」 > 「JAX-RS クライアントの生成」を選択します。

      ツールにより、「JAX-RS クライアントの生成」ウィンドウが表示されます。

    • 以下のステップを実行して、「新規ウィザード」ウィンドウから「JAX-RS クライアントの生成」ウィザードを開きます。
      1. Eclipse ワークベンチで、「ファイル」 > 「新規」 > 「その他...」を選択します。

        ツールにより、「新規ウィザード」ウィンドウが表示されます。

      2. 「RESTful サービス」 > 「JAX-RS クライアントの生成」を選択します。
      3. 「次へ」をクリックします。

        ツールにより、「JAX-RS クライアントの生成」ウィンドウが表示されます。

  2. 「Swagger 定義」フィールドが空の場合、swagger.json ファイルの場所を入力します。

    swagger.json ファイルは、ワークスペースまたはファイル・システムにあります。HTTP または file:// 参照を指定できます。前のステップで swagger.json ファイルを右クリックした場合は、そのロケーションが既に入力されています。また、swagger.json ファイルを外部ファイル・システムからこのフィールドにドラッグすることもできます。

  3. 「プロジェクト」ドロップダウン・メニューから、ターゲット Java EE 7 Web プロジェクトを選択します。
    ヒント: swagger.json ファイルを含んでいる、サービス・プロジェクト以外の別のプロジェクトを選択します。Java EE 7 ターゲット・プロジェクトに対して、JAX-RS 2.0 ファセットが有効になっていることを確認します。
  4. 「ソース・フォルダー」フィールドに、プロジェクトで定義されたターゲット・ソース・フォルダーを入力します。
  5. 「パッケージ」フィールドに、生成されたクライアント・コードの Java パッケージを入力します。
  6. 「終了」をクリックします。

タスクの結果

ターゲットとした Web プロジェクトに、JAX-RS 2.0 クライアントが生成されました。「JAX-RS クライアントの生成」ウィザードは、接尾部が .api のパッケージを含めて、4 つのパッケージを作成します。このパッケージ内の API クラスを使用して、REST サービスを呼び出すことができます。
Icon that indicates the type of topic Task topic
Timestamp icon Last updated: last_date

File name: t_restapi_jaxrs.html