REST API のデータ変換の設定 - Amazon API Gateway

REST API のデータ変換の設定

API Gateway の場合、API のメソッドリクエストは、統合リクエストペイロードとは異なる形式のペイロードを受け取ることができます。同様に、バックエンドは、メソッドレスポンスペイロードとは異なる統合レスポンスペイロードを返す場合があります。マッピングテンプレートを使用して、URL パスパラメータ、URL クエリ文字列パラメータ、HTTP ヘッダー、およびリクエスト本文を API Gateway 全体にマッピングできます。

マッピングテンプレートは、Velocity Template Language (VTL) で表現されるスクリプトであり、JSONPath 式を使用してペイロードに適用されます。

ペイロードでは、JSON スキーマのドラフト 4 に基づくデータモデルを使用できます。モデルの詳細については、「データモデルを理解する」を参照してください。

注記

マッピングテンプレートを作成するためにモデルを定義する必要はありませんが、API Gateway で SDK を生成したり、API のリクエスト本文の検証を有効にしたりするには、モデルを定義する必要があります。