5.3. API プロバイダーインテグレーションの作成
API プロバイダーインテグレーションを作成するには、インテグレーションが実行できるオペレーションを定義する OpenAPI ドキュメント (.json
、9.yaml
、または .yml
ファイル) を提供します。Fuse Online は各オペレーションの実行フローを作成します。各オペレーションのフローを編集し、そのオペレーションの要件に応じてインテグレーションデータを処理するコネクションおよびステップを追加します。
前提条件
インテグレーションが実行する REST API オペレーションの OpenAPI ドキュメントを提供または定義できる必要があります。
検証するには、API プロバイダークイックスタート の OpenAPI ドキュメントである
task-api.json
ファイルの raw バージョンをダウンロード します。Fuse Online が OpenAPI ドキュメントの提供を要求したときに、このファイルをアップロードできます。または、raw のtask-api.json
ファイルである https://raw.githubusercontent.com/syndesisio/syndesis-quickstarts/1.11/api-provider/task-api.json を指定できます。- 各 OpenAPI オペレーションのフローが計画されている必要があります。
- オペレーションのフローを追加する各アプリケーションまたはサービスのコネクションが作成済みである必要があります。
手順
- Fuse Online の左ナビゲーションパネルで Integrations をクリックします。
- Create Integration をクリックします。
- Choose a connection ページで API Provider をクリックします。
Start integration with an API call ページで以下を行います。
- REST API オペレーションを定義する OpenAPI ドキュメントがある場合は、OpenAPI ドキュメントをアップロードします。
- OpenAPI ドキュメントを定義する必要がある場合は、Create a new OpenAPI 3.x document または Create a new OpenAPI 2.x document を選択します。
Next をクリックします。
ドキュメントをアップロードした場合は、これを確認または編集します。
- Review/Edit をクリックして API Designer エディターを開きます。
必要に応じて確認や編集を行います。
任意の手順: ドキュメントによって OpenAPI 2 仕様が使用される場合に、API Designer でドキュメントを変換して OpenAPI 3 仕様に準拠するようにするには、Convert to OpenAPI 3 をクリックします。
- 右上の Save または Cancel をクリックし、エディターを閉じます。
- Next をクリックします。
ドキュメントを作成する場合は、Fuse Online で起動される API Designer エディターで以下を行います。
- API Designer を使用した API 定義の設計および開発 の説明どおりに OpenAPI ドキュメントを定義します。
- 右上の Save をクリックし、エディターを閉じます。
- Next をクリックします。
結果
Fuse Online は OpenAPI ドキュメントが定義するオペレーションの一覧を表示します。
次のステップ
それぞれのオペレーションでは、そのオペレーションを実行するフローを定義します。