OpenAPIドキュメント・パターン

「RESTアダプタ」を使用して、OpenAPIドキュメントを使用して次の共通パターンを実装できます。

トピック:

OpenAPIドキュメントとしてのRESTベースの統合の公開

Oracle Integration RESTエンドポイントを記述するOpenAPIドキュメントを公開し、「RESTアダプタ」を使用してOpenAPIドキュメントを使用できます。この項では、構成ステップの概要を説明します。

「RESTアダプタ」接続を作成します。接続では任意のセキュリティ・ポリシーを使用できます。
統合ページで、アプリケーション駆動のオーケストレーション統合を作成します。
ステップ1で作成した「RESTアダプタ」をトリガー接続として追加します。
統合を設計します。
Integrationsページで、統合をアクティブ化します。
アクティブ化された統合の行にカーソルを合わせると、追加オプションが表示されます。
をクリックして、統合の実行、テストおよびトラッキングの詳細を含むメッセージを表示します。
「メタデータURL」値をクリックします。

これは、RESTエンドポイントのエンドポイントURL、SwaggerおよびOpenAPIの説明へのリンクを含むメッセージを示しています。
「オープンAPI」をクリックして、起動するサーバー、公開されたリソース、セキュリティの詳細など、このエンドポイントの説明を表示します。
統合を起動するには、postmanなどのクライアントにドキュメントをインポートします。
起動するリソースを選択し、「送信」をクリックします。この例では、getEmployeeが選択されます。これは、「アダプタ・エンドポイント構成ウィザード」の「操作選択」ページで選択した内容と一致します。

「図postman_invoke.pngの説明」

マルチパート/混在およびマルチパート/フォーム・データを使用したOpenAPI文書の消費および公開

「RESTアダプタ」トリガー接続で、multipart/mixedおよびmultipart/form-dataを使用してOpenAPIドキュメントを使用および公開できます。この項では、Oracle Integrationでこのタイプのシナリオを構成する方法について説明します。

HTMLフォーム・データを使用または生成するエンドポイントによるOpenAPI文書の消費

「RESTアダプタ」接続を作成し、「トリガーと起動」ロールを選択します。
「接続プロパティ」セクションで、OpenAPI 1.0/2.0/3.0 URLを選択し、接続URLを指定します。
オーケストレーション統合を作成します。
「RESTアダプタ」トリガー接続を追加します。
「リソース構成」ページで、「このエンドポイントのリクエスト・ペイロードの構成」および「レスポンスを受信するようにこのエンドポイントを構成」を使用してPOSTアクションを選択します。
リクエスト・ページで、「リクエストはペイロードでマルチパートです」および「マルチパート・リクエストのタイプはmultipart/form-dataで、HTMLフォーム・ペイロードがあります」を選択します。
レスポンス・ページで、「リクエストはペイロードでマルチパートです」および「マルチパート・リクエストのタイプはmultipart/form-dataで、HTMLフォーム・ペイロードがあります」を選択します。
別の「RESTアダプタ」を起動接続として追加して、OpenAPIエンドポイントを起動します。
「操作選択」ページで、「リソース」リストから/formdata_htmlを選択してエンドポイントを呼び出します。
2つの「RESTアダプタ」接続間のリクエスト・マッパーで、トリガー接続に送信されたデータを起動接続のアウトバウンド・リクエストにマップします。ソースとターゲットの両方の「パラメータ・リスト」 > 「パラメータ」 > 「名前」要素には、HTMLフォーム・データが含まれます。
次の「RESTアダプタ」接続の後のレスポンス・マッパーで、アウトバウンド呼出しからのレスポンスに対して同じマッピングを実行します。
実行時に統合を追跡するためのビジネス識別子を構成します。
統合を保存してアクティブ化します。
統合を起動し、結果を表示します。

マルチパート/混合コンテンツ・タイプのエンドポイントでのOpenAPIドキュメントの使用

「RESTアダプタ」接続を作成し、「トリガーと起動」ロールを選択します。
「接続プロパティ」セクションで、OpenAPI 1.0/2.0/3.0 URLを選択し、接続URLを指定します。
オーケストレーション統合を作成します。
「RESTアダプタ」トリガー接続を追加します。
「リソース構成」ページで、「このエンドポイントのリクエスト・ペイロードの構成」および「レスポンスを受信するようにこのエンドポイントを構成」を使用してPOSTアクションを選択します。
リクエスト・ページで、次を選択します:
1. 「リクエストはペイロードでマルチパートです」を選択します。
2. ドロップダウンで「JSONサンプル」を選択し、有効なJSONサンプル・オブジェクトを指定します。
3. multipart/mixedを選択します。
レスポンス・ページで、次を選択します:
1. 「リクエストはペイロードでマルチパートです」を選択します。
2. ドロップダウンで「JSONサンプル」を選択し、有効なJSONサンプル・オブジェクトを指定します。
3. multipart/mixedを選択します。
別の「RESTアダプタ」を起動接続として追加して、OpenAPIエンドポイントを起動します。
操作選択ページで、「リソース」リストから/mixed_jsonを選択してエンドポイントをコールします。
2つの「RESTアダプタ」接続間のリクエスト・マッパーで、トリガー接続に送信されたデータを起動接続のアウトバウンド・リクエストにマップします。「担当者処分」は、"form-data"の具体的な値に設定されます。マルチパート混合が機能するには、フォーム・データである必要があります。「Json Postリクエストとマルチパートの混合データの混在」ターゲット・ノードはペイロードを表します。
次の「RESTアダプタ」接続の後のレスポンス・マッパーで、アウトバウンド呼出しからのレスポンスに対して同じマッピングを実行します。
実行時に統合を追跡するためのビジネス識別子を構成します。
統合を保存してアクティブ化します。
統合を起動し、結果を表示します。

multipart/form-dataによるエンドポイントでのOpenAPIドキュメントの使用

「RESTアダプタ」接続を作成し、「トリガーと起動」ロールを選択します。
「接続プロパティ」セクションで、OpenAPI 1.0/2.0/3.0 URLを選択し、接続URLを指定します。
オーケストレーション統合を作成します。
「RESTアダプタ」トリガー接続を追加します。
「リソース構成」ページで、「このエンドポイントのリクエスト・ペイロードの構成」および「レスポンスを受信するようにこのエンドポイントを構成」を使用してPOSTアクションを選択します。
リクエスト・ページで、次を選択します:
1. 「リクエストはペイロードでマルチパートです」を選択します。
2. ドロップダウンで「JSONサンプル」を選択し、有効なJSONサンプル・オブジェクトを指定します。
3. multipart/form-dataを選択します。
レスポンス・ページで、次を選択します:
1. 「リクエストはペイロードでマルチパートです」を選択します。
2. ドロップダウンで「JSONサンプル」を選択し、有効なJSONサンプル・オブジェクトを指定します。
3. multipart/form-dataを選択します。
別の「RESTアダプタ」を起動接続として追加して、OpenAPIエンドポイントを起動します。
操作選択ページで、「リソース」リストから/formdata_jsonを選択してエンドポイントをコールします。
2つの「RESTアダプタ」接続間のリクエスト・マッパーで、トリガー接続に送信されたデータを起動接続のアウトバウンド・リクエストにマップします。「Formdata Json Postリクエスト・マルチパート・フォーム・データ」ターゲット・ノードはペイロードを表します。
次の「RESTアダプタ」接続の後のレスポンス・マッパーで、アウトバウンド呼出しからのレスポンスに対して同じマッピングを実行します。
実行時に統合を追跡するためのビジネス識別子を構成します。
統合を保存してアクティブ化します。
統合を起動し、結果を表示します。