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

REST API のデータ変換の設定

API Gateway では、API のメソッドリクエストは、バックエンドで必要となる、該当する統合リクエストペイロードとは異なる形式のペイロードを受け取ることができます。同様に、バックエンドは、フロントエンドで予期されるメソッドレスポンスペイロードとは異なる統合レスポンスペイロードを返す場合があります。API Gateway では、マッピングテンプレートを使用して、ペイロードをメソッドリクエストから該当する統合リクエストにマッピングしたり、統合レスポンスから該当するメソッドレスポンスにマッピングしたりできます。

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

ペイロードでは、JSON スキーマのドラフト 4 に基づくデータモデルを使用できます。このモデルは、API Gateway で SDK を生成する際や、API で基本的なリクエストの検証を有効にする際に定義する必要があります。マッピングテンプレートを作成する際にモデルを定義する必要はありません。ただし、API Gateway では指定されたモデルに基づいてテンプレート設計図が生成されるため、モデルを定義するとテンプレート作成に役立ちます。

このセクションでは、モデルとマッピングテンプレートを使用して、API リクエストとレスポンスペイロードをマッピングする方法を説明します。