アダプタ定義ドキュメントについて
アダプタをOracle Integrationに公開するには、アダプタ定義ドキュメントと呼ばれるJSONメタデータ・ファイルでアダプタの仕様と関数を定義する必要があります。
アダプタ定義ドキュメントでは、通常、アダプタの設計と実装について説明します。 アダプタの動作とプロパティに関する情報が含まれています。 この文書を手動で作成する必要はありません。 Rapid Adapter BuilderのVS Code拡張機能は、次のいずれかのソースからアダプタ定義ドキュメントを迅速に作成できます:
- アプリケーションのAPIのPostmanコレクション
- アプリケーションのAPIのセットを記述するOpenAPIドキュメント
VS Code拡張は、アダプタ定義ドキュメントの様々なコンポーネントを、可能なかぎりPostmanコレクションまたはOpenAPIファイルのデータから自動的に移入します。 ただし、必要な動作を実装するには、ドキュメントを確認し、アダプタに必要な変更を加える必要があります。
アダプタ定義ドキュメントには、必要に応じてカスタマイズできる次の機能があります:
- 接続定義
- エンドポイント構成
- フローのアクティブ化
- 実行時実行
アダプタ定義ドキュメントは、次のセクションで構成されています。 これらは、VS Codeで編集できます:
| セクション | 説明 |
|---|---|
info |
アダプタの一般情報とブランディングについて説明します。 |
schemas |
Oracle Integrationのマッパーに表示される構造を定義します。 |
connection |
アダプタでサポートされている接続パラメータおよびセキュリティ・ポリシーを定義します。 |
triggers |
アダプタが統合を開始するために受信できるイベントを定義します。 |
actions |
ターゲット・アプリケーションに対して実装できる操作を定義します。 アクションは、ターゲット・アプリケーションで使用可能な操作および公開される操作のユーザー中心のカプセル化を提供します。 |
categories |
より優れたユーザー・エクスペリエンスを実現するためのアクションとトリガーのグループ化を定義します。 |
flows |
アダプタを実行する実装ロジックを定義します。 フローは、Cloud Native Computing Foundation (CNCF)プロジェクトのサーバーレス・ワークフロー仕様でサポートされている構成のサブセットを使用してモデル化されます。 |
アダプタ定義ドキュメントの様々なセクションの更新についてさらに学習するには、「アダプタ定義ドキュメントの使用」を参照してください。