使用 API Gateway 主控台設定 REST API 的閘道回應

使用 API Gateway 主控台自訂閘道回應

1. 在以下網址登入 API Gateway 主控台：https://console.aws.amazon.com/apigateway。

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 標頭以允許 API 的 CORS 存取；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 部署到新的或現有的階段。