インポートした OpenAPI 3.0 文書からの REST API の作成

IBM® App Connect Enterpriseで REST API を作成するには、 IBM App Connect Enterprise Toolkitを使用して、 OpenAPI 3.0 文書をインポートします。

始める前に

REST API で必要なリソースと操作を記述した OpenAPI 3.0 文書を作成します。 OpenAPI 3.0 文書が OpenAPI 3.0 仕様のガイドラインに準拠しており、 IBM App Connect Enterpriseの要件を満たしていることを確認してください。 詳しくは、「 https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.0.md and Restrictions on OpenAPI 3.0 documents」を参照してください。

このタスクの概要

IBM App Connect Enterpriseで REST API を作成するには、 IBM App Connect Enterprise Toolkit「REST API の作成」 ウィザードを使用して、 OpenAPI 3.0 文書をインポートします。 次に、新しい REST API の実装とデプロイに必要な REST API およびその他のプロジェクト成果物を作成する必要があります。 あるいは、 IBM App Connect Enterprise Toolkit を使用した OpenAPI 3.0 仕様による最初からの REST API の作成で説明されているように、モデル、リソース、および操作を最初から定義して REST API を作成することもできます。

手順

OpenAPI 3.0 文書をインポートして REST API を作成するには、以下の手順を実行します。

  1. 「ファイル」 > 新規 > REST API をクリックして、 「REST API の作成」 ウィザードを開きます。
  2. REST API の名前を入力します。
    指定する名前は、 IBM App Connect Enterprise Toolkitでプロジェクトの名前として使用されます。
  3. 「RESTAPI 文書で定義されたリソースおよび操作のインポート (Import resources and operations defined in a RESTAPI document)」 を選択し、 「次へ」をクリックします。
  4. 「次へ」をクリックします。
  5. REST API で必要なリソースと操作について説明している OpenAPI 3.0 文書へのパスを選択します。
    OpenAPI 3.0 文書は、ファイル・システムからインポートすることも、ワークスペース内の既存のプロジェクトからインポートすることもできます。
    REST API での使用に関してファイルの妥当性が検査されます。 選択した OpenAPI 3.0 文書の検証中にエラーが検出されると、それらの検証エラーがウィザードの上部に表示されます。 選択した OpenAPI 3.0 文書で検証エラーが検出された場合は、続行できません。
  6. オプション: 選択した OpenAPI 3.0 文書に含まれているリソースと操作のリストを確認するには、 「次へ」をクリックします。
  7. REST API の作成を終了するには、 「終了」をクリックします。
    新しい REST API の REST API の説明 が自動的に開きます。これを使用して、 OpenAPI 3.0 文書に基づく REST API の操作の実装の説明に従って操作を実装できます。

結果

REST API が作成されます。

次のタスク

REST API の各操作をサブフローとして実装します。 OpenAPI 3.0 文書に基づく REST API の操作の実装を参照してください。