API Gateway での REST API のリクエスト検証
統合リクエストを進める前に API リクエストの基本的な検証を実行するよう API Gateway を設定できます。検証に失敗した場合、API Gateway はすぐにリクエストに失敗して、400 個のエラーレスポンスを発信者に返し、CloudWatch Logs で検証結果を発行します。これによりバックエンドへの不必要な呼び出すが減少します。さらに重要な点として、アプリケーション固有の検証作業に集中することができます。リクエスト本文を検証するには、必要なリクエストパラメータが有効で null でないことを確認するか、より複雑なデータ検証用のモデルスキーマを指定します。
トピック
API Gateway における基本的なリクエストの検証の概要
基本的なリクエストの検証は API Gateway で処理できるため、ユーザーはバックエンドでのアプリケーション固有の検証に集中できます。検証のために、API Gateway は以下の条件のどちらかまたは両方を確認します。
-
受信リクエストの URI、クエリ文字列、ヘッダーに必要なリクエストパラメータが含まれており、空白ではない。
-
該当するリクエストペイロードが、メソッドの設定済みの JSON スキーマ
リクエストに準拠している。
検証を有効にするには、リクエストの検証により検証ルールを指定し、この検証を API のリクエストの検証のマップに追加し、検証を個々の API メソッドに割り当てます。
注記
リクエスト本文の検証と統合パススルーの動作は、2 つの異なるトピックです。リクエストペイロードと一致するモデルスキーマがない場合、元のペイロードをパススルーするかブロックするかを選択できます。詳細については、「統合パススルーの動作」を参照してください。
