IBM App Connect Enterprise Toolkit を使用して、 OpenAPI 3.0 仕様に準拠したREST APIをゼロから作成する

OpenAPI 」 3.0 の仕様に基づき、 IBM® App Connect Enterprise Toolkit と統合された「 OpenAPI 」エディタでリソース、モデル、および操作を定義することで、REST API を一から作成できます。

このタスクの概要

OpenAPI エディター を使用して、 OpenAPI 3.0 仕様で REST API を最初から作成できます。 あるいは、 IBM App Connect Enterprise ツールキットを使用して、Swagger仕様書に基づいてREST APIを一から作成することもできます。

Swagger 文書をインポートして REST API を作成したり、 OpenAPI3 文書をインポートして REST API を作成したりすることもできます。

手順

リソース、モデル、および操作を定義することによって REST API を作成するには、以下のステップを実行します。

  1. 「ファイル」 > 新規 > REST API をクリックして、 「REST API の作成」 ウィザードを開きます。
  2. REST API の名前を入力します。
    指定した名前は、 IBM App Connect Enterprise Toolkit におけるプロジェクト名として使用されます。
  3. 「REST API を作成し、リソースと操作を自分で定義する」を選択します。
  4. メニューから OpenAPI3 を選択します。
    「API の基本パス」フィールドと「バージョン」フィールドは自動的に入力されます。
  5. REST API の作成を終了するには、 「終了」をクリックします。
    新規 REST API 用の REST API エディターが自動的に開きますが、生成された値は編集できます。 ここで、 OpenAPI エディターを使用した REST API でのリソース、モデル、および操作の定義の説明に従って、 OpenAPI エディターを使用してリソース、モデル、および操作を定義する必要があります。

結果

REST API が作成されます。

次のタスク

次のトピックのステップを実行して、REST API の操作を定義し、その後、それらの操作を実装します。
  1. OpenAPI エディターを使用した REST API でのリソース、モデル、および操作の定義
  2. OpenAPI 3.0 文書に基づく REST API の操作の実装