APIゲートウェイ互換性モード - Cloud

Talend Cloud API Designerユーザーガイド

EnrichVersion
Cloud
EnrichProdName
Talend Cloud
EnrichPlatform
Talend API Designer
task
ジョブデザインと開発 > Designing APIs

Talend Cloud API Designerでは、定義を AWS API Gatewayおよび Azure API ManagementにインポートするためのAPIゲートウェイ互換性モードが提供されます。

ゲートウェイ互換モードでAPIをエクスポートする場合、Talend Cloud API Designer定義を変更して、選択したゲートウェイに正しくインポートできます。

場合によっては変更の必要はないものの、エクスポートした定義で発生するかもしれない互換性の問題を通知するメッセージが表示されることがあります。

AWS APIゲートウェイのOAS 3.0定義のエクスポート

次の表では、Talend Cloud API Designer定義のエクスポート時にAWS API Gatewayによってサポートされないフィーチャー、および定義をインポートする時のAWS API Gatewayでの処理方法について説明します。

サポートされないOpenAPIフィーチャー Talend Cloud API Designerエクスポート時の動作 インポート時のAWS APIゲートウェイの動作
[example] (サンプル)属性はサポートされていません。 属性は保持されます。 属性がスキーマから削除されます。
[readOnly] (読み取り専用)属性はサポートされていません。 属性は保持されます。 属性がスキーマから削除されます。
[additionalProperties] (追加プロパティ)属性はサポートされていません。 属性が保持され、情報メッセージが表示されます。 警告メッセージが表示されますが、無視して、定義を正しくインポートできます。
セキュリティ定義の種類:
  • oauth2はサポートされていません、
  • httpはサポートされていません、
  • openIdConnectはサポートされていません。
セキュリティスキームが保持され、情報メッセージが表示されます。 警告メッセージが表示されますが、無視して、定義を正しくインポートできます。
レスポンスのプリミティブデータ型はサポートされていません。 プリミティブ型がコンポーネントスキーマにラップされ、警告メッセージが表示されます。 インポートは正しく完了します。
メディアタイプの範囲はサポートされていません。 リクエストまたはレスポンスが保持され、情報メッセージが表示されます。 インポートが失敗し、警告メッセージが表示されます。
デフォルトレスポンスはサポートされていません。 レスポンスが保持され、情報メッセージが表示されます。 インポートが失敗し、警告メッセージが表示されます。
範囲レスポンスはサポートされていません。 レスポンスが保持され、情報メッセージが表示されます。 インポートが失敗し、警告メッセージが表示されます。
パス変数、クエリーパラメーター、およびヘッダーは、一意の名前を持つ必要があります。 パラメーターが保持され、エラーメッセージが表示されます。 インポートが失敗します。

Azure API Management用のOAS/Swagger 2.0定義のエクスポート

以下の表では、Talend Cloud API Designer定義をエクスポートする時にAzure API Managementによってサポートされないフィーチャー、および定義をインポートする時にAzure API Managementで発生することを処理する方法について説明します。

サポートされないOpenAPIフィーチャー Talend Cloud API Designerエクスポート時の動作 インポート時のAzure API Managementの動作
パスとクエリーの両方で必要なパラメーターは、一意の名前である必要があります。 エラーメッセージが表示されます。 インポートが失敗します。