使用 API Gateway 控制台为 REST API 设置网关响应

使用 API Gateway 控制台自定义网关响应

1. 通过以下网址登录到 Amazon 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 标头以允许 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. 选择保存更改。

9. 将 API 部署到新阶段或现有阶段。