为 API Gateway lambda 授权者设置 CORS 标头时出错

Question

我的 API 网关授权有一个 lambda 授权方。当授权方返回 401 或 403 时，我没有在响应标头中返回 CORS。我正在使用AWS::Serverless::Api 资源，经过一些研究发现here 我需要设置GatewayResponses 以返回4XX 响应的自定义标头。

我的 Api 网关定义如下：

resApiGateway:
Type: AWS::Serverless::Api
Properties:
  StageName: !Sub "${env}"
  EndpointConfiguration: !If [IsLocal, "REGIONAL", "EDGE"]
  Cors:
    AllowMethods: "'OPTIONS,GET,POST,PUT,DELETE'"
    AllowHeaders: "'Content-Type,X-Amz-Date,Authorization'"
    AllowOrigin: "'*'"
  GatewayResponses:
    DEFAULT_4XX:
      ResponseParameters:
        "gatewayresponse.header.Access-Control-Allow-Origin": "'*'"
  ...
  ...

但我在 cfn 堆栈部署时遇到错误：

Transform AWS::Serverless-2016-10-31 failed with: Invalid Serverless Application Specification document. Number of errors found: 1. Resource with id [resApiGateway] is invalid. Invalid gateway response parameter 'gatewayresponse.header.Access-Control-Allow-Origin'

Answer 1

此功能随 SAM v1.11.0 发布。 release notes 有一个指向 this sample application template 的链接，用于演示该功能。

不幸的是，亚马逊自己的 SAM 文档（您链接到该文档）只会将您指向他们的 OpenAPI extension docs。

这些文档似乎展示了如何配置 API Gateway 以将此功能与 OpenAPI 规范一起使用，而不是与 SAM 模板一起使用。

---

要在 SAM 模板中指定 GatewayResponses，请使用示例应用程序中的语法：

Resources:
  restApiGateway:
    Type: AWS::Serverless::Api
    Properties:
      GatewayResponses:
        DEFAULT_4XX:
          ResponseParameters:
            Headers:
              Access-Control-Allow-Origin: "'*'"