Amazon API Gateway
開発者ガイド

API Gateway の REST API 統合を設定する

API メソッドを設定したら、バックエンドのエンドポイントに統合する必要があります。バックエンドのエンドポイントは、統合エンドポイントとも呼ばれ、Lambda 関数、HTTP ウェブページ、または AWS サービスアクションとして使用できます。API メソッドと同様に、API 統合には統合リクエストと統合レスポンスがあります。統合リクエストは、バックエンドが受け取った HTTP リクエストをカプセル化します。これは、クライアントが送ったメソッドリクエストと同じ場合もあれば異なる場合もあります。統合レスポンスは、バックエンドが返した出力をカプセル化する HTTP レスポンスです。

統合リクエストの設定には、クライアントから送られたメソッドリクエストをバックエンドに渡す方法の設定、必要に応じてリクエストデータを統合リクエストデータに変換する方法の設定、呼び出す Lambda 関数の指定、受け取ったリクエストを転送する HTTP サーバーの指定、呼び出す AWS サービスアクションの指定が含まれます。

非プロキシ統合の場合のみ、統合レスポンスの設定には、バックエンドが返す結果を特定のステータスコードのメソッドレスポンスに渡す方法の設定、指定した統合レスポンスパラメータを事前設定されたメソッドレスポンスパラメータに変換する方法の設定、指定した本文マッピングテンプレートに従って統合レスポンス本文をメソッドレスポンス本文にマップする方法の設定が含まれます。

プログラムで、統合リクエストは Integration リソースにカプセル化し、統合レスポンスは API Gateway の IntegrationResponse リソースにカプセル化します。統合リクエストを設定するには、Integration リソースを作成し、そのリソースを使用して統合エンドポイント URL を設定します。次に、バックエンドにアクセスするための IAM アクセス権限を設定し、受け取ったリクエストデータをバックエンドに渡す前に変換するためのマッピングを指定します。非プロキシ統合の場合、統合レスポンスを設定するには、IntegrationResponse リソースを作成し、そのリソースを使用してターゲットメソッドレスポンスを設定します。その後、バックエンド出力をメソッドレスポンスにマップする方法を設定します。