RESTアダプタの機能

「RESTアダプタ」の機能

「RESTアダプタ」は、「RESTアダプタ」接続をトリガーとして構成することで、統合をREST APIとして公開することができます。「RESTアダプタ」は、「RESTアダプタ」接続を起動として構成することによって、任意の外部REST APIを使用することもできます。このセクションでは、「RESTアダプタ」がトリガーまたは起動接続として使用される場合の機能について説明します。

ノート:

「RESTアダプタ」は、すべてのエンドポイントが公開されているときにそれを処理します。「RESTアダプタ」は、接続先のアプリケーションによって公開されているAPIをフィルタリングまたは変更しません。接続先のアプリケーションのネイティブ・アダプタがある場合は、代わりにそのアダプタを使用してください。ネイティブ・アダプタの代わりに「RESTアダプタ」を使用することを選択した場合は、それぞれのアプリケーションの資料で指定されているように、APIの制約および非推奨ポリシーが適用されます。

Oracle HCM Cloud SOAP APIに接続するには、「Oracle HCM Cloudアダプタの機能」を参照してください。

「RESTアダプタ」接続をトリガーとして構成して統合をREST APIとして公開する場合の機能

複雑なXMLスキーマ定義をzipアーカイブとしてアップロードして、「RESTアダプタ」構成中にXMLコンテンツのデータ定義を定義することをサポートします。「複雑なスキーマのサポート」を参照してください。
「RESTアダプタ」の構成中にXMLコンテンツのデータ定義を定義するサンプルXMLドキュメントをアップロードするためのサポート。スキーマの生成には、次のXMLドキュメントがサポートされています:
- 名前空間のないXML。
- 同質の名前空間を持つXML。
- XMLファイルのサイズは最大3 MBです。
次の構成をサポートします:
- 相対リソースURI。
- HTTPメソッドのGET、PUT、POST、DELETEおよびPATCHのサポート。
- テンプレートおよび問合せパラメータ
- リクエスト/レスポンス・ペイロードのサポート。
  - JSON、XML、バイナリ(インラインおよび非構造化)およびURLフォーム・エンコードのペイロードのサポート。
  - トップレベル配列を含む同種のJSON配列のサポート。
  - 多次元JSON配列のサポート(「JSONドキュメントにおける同種の多次元配列のサポート」を参照)。
- 「RESTアダプタ」を使用して公開されたREST APIは、Basic認証、OAuthトークン・ベースの認証およびJWTベースの認証を使用して保護されます。
- REST APIはHTTPSプロトコルを実装するため、すべての着信リクエストにトランスポート・レベルのセキュリティが適用されます。
- 「RESTアダプタ」を使用して公開されるREST APIは、基本認証とOAuthトークン・ベースの認証を使用して保護されます。
「構成パラメータ」を参照してください。
受信メッセージと添付サイズの制限を適用します:
- 添付のない受信(トリガー)メッセージ・リクエストのサイズが50 MBを超えないようにします。添付ファイル付きのメッセージ(multipart/mixedやmultipart/form-dataなど)は、この制約の対象ではありません。構造化メッセージのサイズ(XML/JSONなど)が50 MBを超える場合、HTTPエラー・コード・メッセージがクライアントに返されます: 413 Request entity too large。
- 着信(トリガー)JSON添付ファイルのサイズが1 GBを超えないようにします。 JSON添付ファイルのサイズが1 GBを超える場合、HTTPエラー・コード・メッセージがクライアントに返されます: 413 Request entity too large。
- クライアントからの受信(トリガー)構造化メッセージ・ペイロード・リクエスト(JSON、XML、HTML、YAMLまたはYMLを含む任意のコンテンツ・タイプ・ヘッダー)が次を超えないようにします:
  - HTML、YAMLおよびYMLのサイズが10 MB
  - JSONおよびXMLのサイズが50 MB
  構造化メッセージのサイズがこれらの値を超えると、HTTPエラー・コード・メッセージがクライアントに返されます: 413 Request entity too large。
  50 MBのペイロードのサポート、制限およびベスト・プラクティスの詳細は、「Oracle Integration Generation 2のプロビジョニングと管理」の「サービス制限」を参照してください。
「RESTアダプタ」トリガー接続でのmultipart/mixedおよびmultipart/form-dataを使用したOpenAPIの使用および公開のサポート。「マルチパート/混在およびマルチパート/フォーム・データを使用したOpenAPI文書の消費および公開」を参照してください。
ダウンストリーム処理のために標準およびカスタムのHTTPヘッダー・プロパティをOracle Integrationに公開する統合をモデル化する標準およびカスタムのHTTPヘッダーのサポート(「標準ヘッダー・サポートとカスタム・ヘッダー・サポート」を参照)。
マルチパート添付ファイル(コンテンツ・タイプ: 統合の作成時に、リクエスト/レスポンス・メッセージのmultipart/mixedおよびmultipart/form-data。マルチパート・アタッチメントを含む受信リクエスト・メッセージを受け入れるか、マルチパート・アタッチメントを含むレスポンスを送信するRESTエンドポイントを公開します(「トリガー接続と起動接続のマルチパート・アタッチメントのサポート」を参照)。
「RESTアダプタ」を使用して公開されたREST APIは、CORS準拠として構成できます(「クロス・オリジン・リソース共有(CORS)」を参照)。
リクエストを受け入れて非同期で処理できるRESTエンドポイントを公開するためのサポート。
Swagger 2.0-compliantドキュメントは、「RESTアダプタ」を使用して公開されたREST APIsに対して自動的に生成されます。このドキュメントでは、生成されたREST APIのメタデータについて説明します(「インバウンドRESTエンドポイントのメタデータのSwagger形式での表示」を参照)。
異なるリソースURIおよびHTTPアクション/動詞を使用した複数の操作エントリ・ポイントの構成のサポート。各操作は、単一のオーケストレートされた統合で異なる選択アクション・ブランチを表します。この機能により、異なる操作を実行するために複数の統合(それぞれが個別のリソースURIおよび動詞を持つ)を作成する必要がなくなります。「Oracle Integration Generation 2での統合の使用」の「単一のRESTアダプタ・トリガー接続での複数リソースのリクエストの受信」を参照してください。
RESTアダプタの接続構成時に選択した構成オプション(セキュリティ・ポリシー、ヘッダー、パラメータなど)に対するアダプタ・エンドポイント構成ウィザードのサマリー・ページでのサンプルcURL構文の生成のサポート。「サマリー・ページ」を参照してください。

「RESTアダプタ」接続を起動として構成して外部REST APIを使用する場合の機能

送信メッセージと添付ファイル・サイズの制限を適用する:
- アウトバウンドRESTリクエストの添付ファイルを含むレスポンスが1 GBを超えないようにします。これらの添付には、multipart/mixed、multipart/form-dataまたはapplication/octet-streamを使用できます。添付ファイルが1 GBを超える場合は、HTTPエラー・コード・メッセージが返されます: 413 Request entity too large
- クライアントからの非構造化ペイロード(multipart-formdataおよびbinary/octed-stream)を返す発信(起動)メッセージのサイズが1 GBを超えないようにします。
- クライアントに構造化メッセージ・ペイロード(JSON、XML、HTML、YAMLまたはYMLを含む任意のコンテンツ・タイプ・ヘッダー)を返す送信(起動)メッセージが次を超えないようにします:
  - HTML、YAMLおよびYMLのサイズが10 MB
  - JSONおよびXMLのサイズが50 MB
  50 MBのペイロードのサポート、制限およびベスト・プラクティスの詳細は、「Oracle Integration Generation 2のプロビジョニングと管理」の「サービス制限」を参照してください。
Swagger 2.0/RAML/OpenAPIドキュメントおよびOracleメタデータ・カタログを使用して記述されたREST APIの使用のサポート。「RESTアダプタ」は、構成用のドキュメントに存在する使用可能なリソースおよび操作を自動的に検出して提示できます。ドキュメントで使用可能な操作固有のリクエスト・メッセージおよびレスポンス・メッセージに関するメタデータは、マッピングおよびその他のアクティビティに対して自動的に使用可能になります(「外部REST APIの記述のためのSwaggerおよびRAMLドキュメントのサポート」を参照)。
次の構成をサポートします(「構成パラメータ」を参照):
- 相対リソースURI。
- HTTPメソッドのGET、PUT、POST、DELETEおよびPATCHのサポート。
- テンプレートおよび問合せパラメータ
- リクエスト/レスポンス・ペイロードのサポート:
  - JSON、XML、バイナリ(インラインおよび非構造化)およびURLフォーム・エンコードのペイロードのサポート。
  - 同一JSON配列のサポート。
  - 多次元JSON配列のサポート(「JSONドキュメントにおける同種の多次元配列のサポート」を参照)。
  - リクエスト本文の一部としてのフォーム・パラメータの配信。
「RESTアダプタ」の構成中にXMLコンテンツのデータ定義を定義するサンプルXMLドキュメントをアップロードするためのサポート。データ定義の生成には、次のXML文書がサポートされています:
- 名前空間のないXML。
- 同質の名前空間を持つXML。
- XMLファイルのサイズは最大3 MBです。
「RESTアダプタ」の構成時にデータ定義を定義するサンプルJSONドキュメントのアップロードをサポートします。
「RESTアダプタ」構成中にXMLコンテンツにデータ定義を定義するために、複雑なXMLスキーマ定義をzipアーカイブとしてアップロードするためのサポート。「複雑なスキーマのサポート」を参照してください。
外部REST APIによって公開される標準およびカスタムのHTTPヘッダーへのアクセスおよび設定のサポート(「標準ヘッダー・サポートとカスタム・ヘッダー・サポート」を参照)。
マルチパート添付ファイルのサポート(コンテンツ・タイプ: 統合のリクエスト/レスポンス・メッセージのmultipart/mixedおよびmultipart/form-data。マルチパート・アタッチメントを含む受信リクエスト・メッセージを受け入れる外部RESTエンドポイントにリクエストを送信したり、マルチパート・アタッチメントを含むレスポンスを送信します(「トリガー接続と起動接続のマルチパート・アタッチメントのサポート」を参照)。
Swagger/RAML/OpenAPIドキュメントを使用して記述されていない外部REST APIの使用のサポート。リクエストとレスポンス・メッセージのシェイプを記述するHTTPメソッドとサンプルJSONドキュメント/XMLスキーマを宣言的に指定することができます。
HTTP Basic認証、OAuthクライアント資格証明(2レッグ・フロー)、OAuthリソース所有者パスワード資格証明(2レッグ・フロー)、OAuth認可コード資格証明(3レッグ・フロー)、OAuthカスタム3レッグ・フロー、OAuthカスタム2レッグ・フロー、OAuthカスタム2レッグ・フロー、OAuth 1.0単一のレッグ認証、Amazon Web Services (AWS)シグネチャ・バージョン4およびOracle Cloud Infrastructure (OCI)シグネチャ・バージョン1を使用して保護されるREST APIの使用のサポート。保護されていないAPIの使用もサポートされています。
Amazon Web Services (AWS)シグネチャ・バージョン4の認証タイプをサポートする外部RESTエンドポイントの起動のサポート。
Oracle Integrationオーケストレーション・フローの中核となる部分として、Oracle関数、ストリーミング、ストレージなどのOracle Cloud Infrastructureクラウド・サービスREST APIの起動をサポートします。
共存するREST APIを最適な方法で起動するためのサポート。

Oracle Integrationランタイムは、エンドポイントURLにロード・バランサ・アドレスがあるかどうかをチェックすることによって、起動されたエンドポイントが同じ場所にあるかどうかを判断します。エンドポイントURLにロード・バランサ・アドレスがある場合、エンドポイントは同じ場所にあるとみなされ、非SSL HTTPプロトコルを使用してローカルにサービスにアクセスすることによってHTTPリクエストが最適化されます。
OAuth 2プロバイダの複数性にアクセスするための拡張性サポート(「標準ヘッダー・サポートとカスタム・ヘッダー・サポート」を参照)。
アウトバウンド・エンドポイント構成の動的な変更(起動)のサポート(「動的RESTエンドポイントのサポート」を参照)。
トランスポート・レベルのセキュリティを使用して保護された外部REST APIの使用をサポートします。「RESTアダプタ」は、一方向SSLおよび双方向SSLをサポートします。 Oracle Integrationは、あまり知られていない認証局(CA)または自己署名証明書を使用して保護されている外部APIのパブリック証明書をアップロードするための証明書管理ユーザー・インタフェースをサポートしています。

クライアント側 (Oracle Integration) アイデンティティを必要とする双方向SSLサーバーでホストされる外部REST APIのサポート。 Oracle Integrationは、外部APIをホストするサーバーとクライアント側のアイデンティティを交換するためのサポートを提供します。
RESTベースの統合のOpenAPIドキュメントとしての公開のサポート。 OpenAPIサポートは、「RESTアダプタ」を起動接続として構成する場合に使用できます。公開または使用するOpenAPIドキュメントへのリンクを指定します。
OpenAPIサポートでは、次のタスクを実行できます:
- Oracle Integration RESTエンドポイントを説明するOpenAPIドキュメントを公開します。 postmanなどのRESTクライアントを使用して、公開されたドキュメントでRESTエンドポイントを起動することができます。
  「OpenAPIドキュメントとしてのRESTベースの統合の公開」を参照してください。
- 「RESTアダプタ」を使用してOpenAPI文書を消費します。
アダプタ・エンドポイント構成ウィザードで現在無効になっている標準ヘッダーを除き、OpenAPI定義のヘッダーは自動的にサポートされます。
RESTアダプタの接続構成時に選択した構成オプション(セキュリティ・ポリシー、ヘッダー、パラメータなど)に対するアダプタ・エンドポイント構成ウィザードのサマリー・ページでのサンプルcURL構文の生成のサポート。「サマリー・ページ」を参照してください。