API Gateway への API のインポートによるエラーと警告

外部定義ファイルを API Gateway にインポートすると、API Gateway で警告やエラーが発生することがあります。以下のセクションでは、インポート中に発生する可能性のあるエラーと警告について説明します。

インポート中のエラー

インポート中に、無効な OpenAPI ドキュメントなど、大きな問題に対してエラーが生成される場合があります。エラーは、失敗のレスポンスの例外 (例: BadRequestException) として返されます。エラーが発生した場合、新しい API 定義は破棄され、既存の API は変更されません。

インポート中の警告

インポート中に、モデル参照の不足など、小規模な問題に対して警告が生成される場合があります。警告が発生した場合、リクエスト URL に failonwarnings=false クエリ式が追加されている場合、オペレーションは続行します。それ以外の場合、更新はロールバックされます。デフォルトで、failonwarnings は false に設定されています。このような場合、警告は RestApi リソースのフィールドとして返されます。それ以外の場合、警告は例外のメッセージとして返されます。