OpenAPI 2.0 の機能の制限事項

以降のセクションでは、API Gateway での OpenAPI 2.0 機能の制限について説明します。

スコープは無視される

API Gateway は、セキュリティ スキーム オブジェクトでスコープが定義された OpenAPI ドキュメントを受け入れますが、これらのスコープはチェックまたは適用されません。

複数のセキュリティ要件

  • API キーの要件: スキームの 1 つが API キーである場合、API Gateway は択一的(論理 OR)セキュリティ要件をサポートしません。ただし、連結(論理 AND)はサポートされてい��ため、API キーと OAuth2 トークンの両方を必須にできます。
  • OAuth2 の要件: さまざまな OAuth2 セキュリティ スキームで択一的(論理 OR)セキュリティ要件がサポートされています。
  • 異なる OAuth2 セキュリティ スキームの連言(論理 AND)セキュリティ要件はサポートされていません。
  • 省略可能なセキュリティ: 空のセキュリティ要件(- {})を使用して、API キーのセキュリティを省略可能にできますが、OAuth ではサポートされていません。

セキュリティ定義の検証

API Gateway は、securityDefinitions セクションに対応する定義のないセキュリティ要件を使用する OpenAPI 3.x 仕様を拒否します。

URL パス テンプレート

API Gateway は、パスセグメント全体を表す URL パス テンプレート パラメータ(/items/{itemId})。セグメントの一部に対応するパラメータ(/items/prefix_{id}_suffix など)はサポートされておらず、拒否されます。

パラメータ、スキーマ、型

API Gateway は、さまざまなパラメータと型の定義(required パラメータ、配列形式など)をサポートしていますが、それらを強制しません。受信リクエストは、これらの定義に関係なく API に転送されます。

外部型参照

API Gateway は、指定された OpenAPI ドキュメントの外部にある型への参照をサポートしていません。たとえば、外部 URL を指す $ref は許可されず、拒否されます。

ホスト アドレスのカスタムポート

API Gateway では、OpenAPI ドキュメントの host フィールドにカスタムポートを使用できません。

YAML エイリアスの制限事項

API Gateway に送信される OpenAPI ドキュメントには、最大 200 個の YAML エイリアス ノードを含めることができます。