5.5. API プロバイダークイックスタートインテグレーションの例のインポートおよびパブリッシュ

Fuse Online は、Fuse Online 環境にインポートできる API プロバイダークイックスタートインテグレーションを提供します。このクイックスタートには、タスク管理 API の OpenAPI ドキュメントが含まれています。クイックスタートインテグレーションをインポートした後、フローを確認し、インテグレーションをパブリッシュします。以下の手順の完了後、TaskAPI インテグレーションは稼働状態になり、実行される準備が整います。

API プロバイダークイックスタートは、API プロバイダーインテグレーションを設定、パブリッシュ、およびテストする方法を短時間で理解するのに役立ちます。しかし、API プロバイダーインテグレーションが便利であることを実証する実際の例ではありません。実例として、Fuse Online をすでに使用して、複数のシンプルなインテグレーションをパブリッシュしている場合に、このようなインテグレーションの実行をトリガーするために、OpenAPI ドキュメントを定義できます。これには、パブリッシュ済みのシンプルなインテグレーションとほぼ同じになるように、各 OpenAPI オペレーションのフローを編集します。

前提条件

手順

  1. TaskAPI クイックスタートインテグレーションをインポートします。

    1. https://github.com/syndesisio/syndesis-quickstarts/tree/1.14/api-provider にアクセスし、TaskAPI-export.zip をダウンロードします。
    2. Fuse Online の左側のナビゲーションパネルで Integrations をクリックします。
    3. 右上の Import をクリックします。
    4. ダウンロードした TaskAPI-export.zip ファイルを Import ページにドラッグします。Fuse Online は、ファイルが正常にインポートされたことを示します。
    5. 左側のナビゲーションパネルで Integrations をクリックし、先ほどインポートした TaskAPI インテグレーションのエントリーを表示します。設定が必要であるとエントリーに表示されますが、このインテグレーションをパブリッシュする準備は整っています。
  2. TaskAPI エントリーで Three Vertical Dots をクリックした後、Edit をクリックしてこの API によって提供されるオペレーションのリストを表示します。

  3. 各オペレーションのフローを確認するには、以下を行います。

    1. Edit flow ボタンをクリックし、そのフローのビジュアライゼーションを表示します。

      各フローにはすでに 1 つのデータベースコネクション、1 つ以上のデータマッパーステップ、およびフローを終了する 1 つの Provided API Return Path ステップが存在します。

    2. Invoke SQL ステップでは Configure をクリックし、コネクションが実行する SQL ステートメントを表示します。その後、Cancel をクリックし、オペレーションのビジュアライゼーションフローに戻ります。
    3. データマッパーステップでは、Configure をクリックし、マッピングを表示します。その後、Cancel をクリックしてビジュアライゼーションに戻ります。
    4. 各オペレーションのフローの最終ステップである Provided API Return Path ステップでは、Configure をクリックし、オペレーションによって呼び出し元に送信された可能性がある HTTP リターンコードを表示します。Cancel をクリックしてビジュアライゼーションに戻ります。
    5. オペレーションのフローの確認後、ドロップダウンメニューで Integrations> TaskAPI> Operation の順にクリックし、別のオペレーションを選択します。
    6. この手順を繰り返し、各フローを確認します。

  4. フローの確認後、Publish をクリックします。必要な場合はインテグレーション名を編集し、Save and publish をクリックします。

    Fuse Online は、このインテグレーションの概要ページを表示し、アセンブル、ビルド、デプロイ、およびインテグレーションの実行中にパブリッシュの進捗を表示します。

  5. TaskAPI インテグレーション概要ページに Running が表示されると、Fuse Online は Task API サービスの外部 URL を表示します。以下のような URL が表示されます。

    https://i-task-api-proj319352.6a63.fuse-ignite.openshiftapps.com/api/

    これは、Task API サービスを利用できる場所を示しています。REST API 呼び出しは、このベース URL で始まる URL を指定します。

    Fuse Online を OpenShift Container Platform で使用し、外部 URL がインテグレーションの概要ページにない場合、Red Hat 3scale の検出は有効になっています。これは、Red Hat 3scale によってインテグレーションの API へのアクセスが制御され、API プロバイダーインテグレーションもパブリッシュされることを意味します。インテグレーションをテストするには、3scale ダッシュボードを開き、インテグレーションの URL を取得します。

    インテグレーションの API へのアクセスを 3scale が制御しないようにするには、検出を無効にします。これは、Fuse Online でインテグレーションの概要ページを表示して行います。このページの Disable discovery をクリックします。インテグレーションが Fuse Online によって再パブリッシュされ、インテグレーションの実行を呼び出すための外部 URL が提供されます。

    各 API プロバイダーインテグレーションの検出を有効または無効にすることができます。