メニュー
Amazon API Gateway
開発者ガイド

API Gateway で API の基本的なリクエストの検証を有効にする

統合リクエストを進める前に API リクエストの基本的な検証を実行するよう API Gateway を設定できます。検証に失敗した場合、API Gateway はすぐにリクエストに失敗して、400 個のエラーレスポンスを呼び出し元に返し、CloudWatch ログで検証結果を発行します。これによりバックエンドへの不必要な呼び出すが減少します。さらに重要な点として、アプリケーション固有の検証作業に集中することができます。

API Gateway における基本的なリクエストの検証の概要

API Gateway は、基本的な検証を実行できます。これにより、API 開発者はアプリケーション固有の詳細な検証にバックエンドで集中できます。基本的な検証の場合、API Gateway は以下のいずれかまたは両方の条件を確認します。

  • URI、クエリ文字列、受信リクエストのヘッダーの必須のリクエストパラメーターが含まれており、空白でない。

  • 該当するリクエストペイロードが、メソッドの設定済みの JSON スキーマリクエストモデルに従っている。

基本的な検証を有効にするには、リクエストの検証で検証ルールを指定して、検証を API のリクエストの検証のマップに追加し、検証緒を個々の API メソッドに割り当てます。

注記

リクエスト本文の検証と「リクエスト本文のパススルー」は、それぞれ別の問題です。一致するモデルスキーマがないことが原因で、リクエストペイロードを検証できない場合は、元のペイロードをパススルーまたはブロックすることができます。たとえば、メディアタイプ (application/json) のマッピングテンプレートを使用してリクエスト検証を行う場合は、有効なリクエスト検証が失敗した場合でも、XML ペイロードをバックエンドに渡す場合があります。このような場合、この XML ペイロードが今後メソッドのサポート対象になるように希望されるかもしれません。XML ペイロードでリクエストをフェイルオーバーするには、コンテンツのパススルー動作に対して、NEVER オプションを明示的に選択する必要があります。