第6章 REST API 呼び出しによってトリガーされるインテグレーションの作成

手順

1. Fuse Online の左ナビゲーションパネルで Integrations をクリックします。
2. 右上の Create Integration をクリックします。
3. Choose a connection ページで API Provider をクリックします。

4. Start integration with an API call ページで以下を行います。

   • REST API オペレーションを定義する OpenAPI 2.0 ドキュメントがある場合は、OpenAPI ドキュメントをアップロードします。
   • OpenAPI 2.0 ドキュメントを定義する必要がある場合は、Create を選択します。

5. Next をクリックします。

   • ドキュメントをアップロードした場合は、これを確認または編集します。

     1. Review/Edit をクリックして Apicurito エディターを開きます。
     2. 必要に応じて確認や編集を行います。
     3. 右上の Save または Cancel をクリックし、エディターを閉じます。
     4. Next をクリックします。

   • ドキュメントを作成する場合は、Fuse Online が開く Apicurito エディターで以下を行います。

     1. OpenAPI ドキュメントを定義します。
     2. 右上の Save をクリックし、エディターを閉じます。
     3. Next をクリックします。

   Apicurito エディターの使用に関する詳細は、「Design and develop an API definition with API Designer」を参照してください。

手順

1. Operations リストページで、編集するフローのオペレーションに対して Create flow をクリックします。

2. このフローに追加する各コネクションに対して以下を行います。

   1. フロービジュアライゼーションで、プラス記号をクリックしてその場所にコネクションを追加します。
   2. 使用するコネクションをクリックします。
   3. コネクションが実行するアクションを選択します。
   4. ラベルが付いたフィールドにデータを入力して、アクションを設定します。
   5. Next をクリックします。

   フローに必要なコネクションをすべて追加してから、続行します。

3. このオペレーションフローでコネクション間のデータを処理するには、以下を行います。

   1. フロービジュアライゼーションで、ステップを追加する場所にあるプラス記号をクリックします。
   2. 追加するステップをクリックします。
   3. ラベル付が付いたフィールドにデータを入力して、ステップを設定します。

   4. Next をクリックします。

      ヘルプは「コネクション間のステップの追加」を参照してください。

   コネクションの間のデータを処理する別のステップを追加する場合は、この手順のサブセットを繰り返します。

4. データを次のコネクションのフィールドにマップします。

   1. フロービジュアライゼーションで、コネクションが受信データを処理できないことを示す、データタイプ不一致の アイコンを確認します。ここでは、データマッパーステップを追加する必要があります。

   2. フロービジュアライゼーションの各データ不一致アイコンに対して以下を行います。

      1. そのステップの直前にあるプラスマークをクリックします。
      2. Data Mapper をクリックします。
      3. 必要なマッピングを定義します。詳細は「インテグレーションデータを次のコネクションのフィールドにマッピング」を参照してください。
      4. Done をクリックして、データマッパーステップをフローに追加します。

5. フロービジュアライゼーションの、Provided API Return Path ステップで Configure をクリックします。

   すべての API プロバイダーインテグレーションは、オペレーションフローの実行をトリガーした REST API の呼び出し元に応答を送信することで、各オペレーションフローを終了します。応答には、ここで設定される戻りコードが含まれます。

   本リリースでは、API 呼び出しによってこのフローの実行がトリガーされる場合は、戻りコードはこのステップで指定されるコードになります。エラー処理は、今後のリリースでサポートされる予定です。

   フローのデフォルトの戻りコードである 501 Not implemented を使用するか、以下のように別の戻りコードを指定します。

   1. Return Code 入力フィールドをクリックすると、可能な戻りコードのリストが表示されます。
   2. 該当の戻りコードまでスクロールし、クリックします。
   3. Next をクリックします。

6. このフローに、必要なコネクションとステップがすべてあり、データの不一致アイコンがない場合や、フローを編集しない場合は、以下の 1 つを行います。

   • Publish: インテグレーションの実行を開始するには、右上の Publish をクリックします。これにより、インテグレーションがビルドされ、REST API サービスが OpenShift にデプロイされます。さらにインテグレーションが実行できるようになります。オペレーションフローの作成を完了するときやオペレーションフローを編集するときに、インテグレーションをパブリッシュできます。
   • Save: オペレーションのリストを表示するには、右上の Save をクリックします。
   • Operation :  別のオペレーションフローを編集するには、ページ上部のパンくずリストで Operation ドロップダウンメニューを表示し、編集するフローのオペレーションをクリックします。Fuse Online は、編集しているフローの現在の状態を保存します。

手順

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

   1. https://github.com/syndesisio/syndesis-quickstarts/tree/1.6/api-provider にアクセスし、TaskAPI-export.zip をダウンロードします。
   2. Fuse Online の左側のナビゲーションパネルで Integrations をクリックします。
   3. 右上の Import をクリックします。
   4. ダウンロードした TaskAPI-export.zip ファイルをドラッグアンドドロップします。Fuse Online は、ファイルが正常にインポートされたことを示します。
   5. 左側のナビゲーションパネルで Integrations をクリックし、先ほどインポートした Task API インテグレーションのエントリーを表示します。このエントリーは、設定が必要であることを示します。

2. Task API インテグレーションを設定します。

   1. Task API エントリーをクリックして、インテグレーションの概要を表示します。
   2. 右上にある Edit Integration をクリックし、この API が提供するオペレーションのリストを表示します。

   3. Create Task オペレーションのフローで、1 つのステップを更新します。

      1. Task オペレーションの POST エントリーで、Create flow をクリックし、そのフローのビジュアライゼーションを表示します。

         コネクションとステップはすでにこのフローに追加されています。オペレーションフロービジュアライゼーションで、ステップの設定を表示するには、その Configure ボタンをクリックします。Cancel または Next をクリックしてフロービジュアライゼーションに戻ります。1 つのステップの設定を確認したら、別のステップの Configure をクリックし、その設定を確認します。データベースコネクションをクリックすると、実行する SQL ステートメントを確認できます。

      2. オペレーションフロービジュアライゼーションで、フローの最後のステップである Provided API Return Path ステップの Configure をクリックします。スクロールダウンして確認する必要がある場合があります。
      3. Return Code 入力フィールドをクリックし、スクロールして 201 Created を選択します。
      4. Next をクリックします。
      5. 右上の Save をクリックします。

   4. Delete Task for ID オペレーションのフローで、1 つのステップを更新します。

      1. Delete Task for ID オペレーションの Delete エントリーで、Create flow をクリックし、そのフローのビジュアライゼーションを表示します。

         このオペレーションフローには、データマッパーステップと Fuse Online によって提供されるサンプルデータベースへのコネクションがあります。オペレーションフロービジュアライゼーションで、データベースコネクションの Configure をクリックし、実行する SQL ステートメントを表示します。

      2. Next または Cancel をクリックします。
      3. オペレーションフロービジュアライゼーションで、フローの最後のステップである Provided API Return Path ステップの Configure をクリックします。
      4. Return Code 入力フィールドをクリックし、スクロールして 200 OK を選択します。
      5. Next をクリックします。
      6. 右上の Save をクリックします。

   5. Get Task by ID オペレーションのフローで、1 つのステップを更新します。

      1. Get Task by ID オペレーションの GET エントリーで、Create flow をクリックし、そのフローのビジュアライゼーションを表示します。

         このオペレーションフローには、2 つのデータマッパーステップ、Fuse Online によって提供されるサンプルデータベースへのコネクション 1 つ、および 1 つのログステップがあります。

      2. オペレーションフロービジュアライゼーションで、ステップの Configure ボタンをクリックし、その設定を表示します。ステップの設定を確認したら、Next または Cancel をクリックします。この作業を必要なステップすべてに行います。
      3. オペレーションフロービジュアライゼーションで、フローの最後のステップである Provided API Return Path ステップの Configure をクリックします。
      4. Return Code 入力フィールドをクリックし、スクロールして 200 OK を選択します。
      5. Next をクリックします。

3. 右上の Publishをクリックし、Save and publish をクリックします。

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

4. Task API インテグレーション概要ページに 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 がインテグレーションの概要ページにない場合、CONTROLLERS_EXPOSE_VIA3SCALE 環境変数が true に設定されています。この API プロバイダーインテグレーションをテストする場合は、3scale の管理者に協力を依頼してください。

手順

1. Fuse Online の左側のナビゲーションパネルで Integrations をクリックします。
2. Task API インテグレーションをクリックし、その概要を表示します。
3. インテグレーションの外部 URL をコピーします。

4. ターミナルで以下のようなコマンドを実行し、インテグレーションの外部 URL を externalURL 環境変数に割り当てます。必ず、このサンプルコマンドの URL を、コピーした URL に置き換え、末尾に /api を追加するようにしてください。

   export externalURL="https://i-task-api-proj319352.6a63.fuse-ignite.openshiftapps.com/api"`

   Copy to Clipboard

5. Create Task オペレーションに対してフローの実行をトリガーする curl コマンドを実行します。

   curl -k --header "Content-Type: application/json" --request POST --data '{ "task":"my new task!"}' $externalURL/todo

   Copy to Clipboard
   • -k を指定すると、サーバーコネクションがセキュアでなくても curl は続行および動作します。
   • --header は、コマンドが JSON 形式のデータを送信することを示します。
   • --request は、データを格納する HTTP POST コマンドを指定します。
   • --data は、保存する JSON 形式のコンテンツを指定します。この例では、クォータは { "task":"my new task!"} です。

   • $externalURL/todo は呼び出す URL です。

     このコマンドは、HTTP POST リクエストを、Create Task オペレーションのフローの実行をトリガーする Task API サービスに送信します。フロー実行により、新しいタスクがサンプルデータベースに追加され、以下のようなメッセージを返して実行された内容を示します。

   {"completed":false,"id":1,"task":"my new task!"}

   Copy to Clipboard

6. Get Task by ID オペレーションに対してフローの実行をトリガーする curl コマンドを実行します。

   curl -k $externalURL/todo/1

   Copy to Clipboard

   タスクを取得するには、curl コマンドに URL のみを指定する必要があります。HTTP GET コマンドはデフォルトのリクエストです。URL の最後の部分は、取得するタスクの ID を指定します。

7. Delete Task for ID オペレーションのフローの実行をトリガーする curl コマンドを実行します。

   curl -k -X DELETE $externalURL/todo/1

   Copy to Clipboard

   このコマンドは、ID でタスクを取得したコマンドと同じ URL で HTTP DELETE コマンドを実行します。