API Gateway コンソールを使用して REST API のゲートウェイレスポンスをセットアップする

API Gateway コンソールを使用してゲートウェイレスポンスをカスタマイズするには

1. https://console.aws.amazon.com/apigateway で API Gateway コンソールにサインインします。

2. REST API を選択します。

3. メインナビゲーションペインで、[ゲートウェイレスポンス] を選択します。

4. レスポンスタイプを選択し、[編集] を選択します。このチュートリアルでは、[認証トークンが見つかりません] を例として使用します。

5. API Gateway で生成された [ステータスコード] を変更し、API の要件を満たす別のステータスコードを返すことができます。この例では、カスタマイズにより、ステータスコードがデフォルト値 (403) から 404 に変更されます。これは、見つからないと見なすことができるサポートされていないリソースや無効なリソースをクライアントが呼び出したときに、このエラーメッセージが発生するためです。

6. カスタムヘッダーを返すには、[レスポンスヘッダー] で [ヘッダーの追加] を選択します。例として、以下のカスタムヘッダーを追加します。

   Access-Control-Allow-Origin:'a.b.c'
   x-request-id:method.request.header.x-amzn-RequestId
   x-request-path:method.request.path.petId
   x-request-query:method.request.querystring.q
   

   前述のヘッダーマッピングで、静的ドメイン名 ('a.b.c') は Allow-Control-Allow-Origin ヘッダーにマッピングされて、CORS から API へのアクセスが許可されます。x-amzn-RequestId パス変数はレスポンスの request-id にマッピングされます。受信リクエストの petId パス変数はレスポンスの request-path ヘッダーにマッピングされます。元のリクエストの q クエリパラメータはレスポンスの request-query ヘッダーにマッピングされます。

7. [レスポンステンプレート] で、[コンテンツタイプ] を application/json にしたまま、[テンプレートの本文] エディタに次の本文マッピングテンプレートを入力します。

   {
        "message":"$context.error.messageString",
        "type": "$context.error.responseType",
        "statusCode": "'404'",
        "stage": "$context.stage",
        "resourcePath": "$context.resourcePath",
        "stageVariables.a": "$stageVariables.a"
   }

   この例では、$context プロパティと $stageVariables プロパティを、ゲートウェイレスポンス本文のプロパティにマッピングする方法を示しています。

8. [Save changes] (変更の保存) をクリックします。

9. 新規または既存のステージに API をデプロイします。