REST API 定義ファイルの作成

ウィザードを使用して、テンプレート swagger.json ファイルを生成し、Representational State Transfer (REST) アプリケーション・プログラミング・インターフェース (API) を指定することができます。ウィザードは、Liberty サーバーをターゲットとしていて Web 2.5 以上を使用するプロジェクトに対応しています。

このタスクについて

重要: Liberty、Liberty Core に適用可能

手順

  1. Liberty サーバーをターゲットとする Web プロジェクトを作成します。

    Web プロジェクトの作成について詳しくは、Web プロジェクトの作成を参照してください。

  2. 以下のいずれかのオプションを実行して、Swagger REST API 定義ファイルを作成します。
    • 「ファイル」 > 「新規」 > 「その他」を選択してから、「REST API 定義 (REST API definition)」セクションで「Swagger REST API 定義ファイル (Swagger REST API definition file)」を選択します。
    • プロジェクトを右クリックして、「新規」 > 「Swagger REST API 定義ファイル (Swagger REST API definition file)」を選択します。
  3. 以下のいずれかを実行して、作成する JavaScript Object Notation (JSON) ファイルのタイプを選択します。
    • 必要なすべての最上位の Swagger 要素を使用してファイルを作成するには、「swagger.json テンプレート・ファイルの作成 (Create a swagger.json template file)」を選択します。
    • 一般的な定義 (GET、PUT、および POST など) のサンプル・コンテンツを使用してファイルを作成するには、「swagger.json サンプル・ファイルの作成 (Create a swagger.json sample file)」を選択します。
  4. 以下のいずれかを実行して、作成するファイルのロケーションを選択します。
    • Swagger 注釈を処理する場合は、「スタブ文書として生成 (META-INF/stub ディレクトリー) (Generate as stub document (META-INF/stub directory))」を選択します。
    • Swagger 注釈を処理しない場合は、「最上位文書として生成 (META-INF ディレクトリー) (Generate as top level document (META-INF directory))」を選択します。
      注: デフォルトでは、このオプションが選択されます。
  5. 「終了」をクリックします。

タスクの結果

ツールにより、Web プロジェクトの WebContent/META-INF フォルダー内に swagger.json ファイルが生成されます。ファイルは、デフォルトの JSON エディターで開きます。

Icon that indicates the type of topic Task topic
Timestamp icon Last updated: last_date

File name: t_restapi_create.html