使用OpenAPI Components配置AWS API Gateway集成响应遇错求助

我来帮你搞定这个问题！你遇到的报错是因为AWS API Gateway的集成响应结构有明确要求：每个匹配后端响应的条目必须显式指定要返回给客户端的状态码，直接引用整个全局响应组件的写法不符合API Gateway对集成响应的格式规范。

问题根源 #

你的全局响应组件BAD_REQUEST确实定义了statusCode: "400"，但当你在集成响应的responses字段中用正则（.*"BadRequest".*）作为键，并直接把$ref放在下面时，API Gateway无法从引用中自动提取状态码——它需要在集成响应的条目里单独声明statusCode，再复用组件里的其他配置（比如响应模板）。

解决方案 #

有两种可行的写法，选一种适合你的场景：

方案1：拆分引用，显式指定状态码

保留你已定义的全局响应组件，在集成响应中明确设置statusCode，再单独引用组件里的responseTemplates：

components:
  responses:
    BAD_REQUEST:
      statusCode: "400"
      responseTemplates:
        application/json: "#set($inputRoot = $input.path('$'))
{ 
 \"message\" : \"Invalid Request Body\"
}"

# 集成部分的正确写法
x-amazon-apigateway-integration: <API_GATEWAY_CONFIG_GOES_HERE>
responses:
  .*"BadRequest".*:
    statusCode: "400"
    responseTemplates:
      $ref: '#/components/responses/BAD_REQUEST/responseTemplates'

方案2：调整组件结构，适配集成响应

如果你希望更灵活地复用配置，可以把响应模板单独抽成组件，然后在集成响应中组合使用：

components:
  templates:
    BAD_REQUEST_TEMPLATE:
      application/json: "#set($inputRoot = $input.path('$'))
{ 
 \"message\" : \"Invalid Request Body\"
}"

# 集成部分的写法
x-amazon-apigateway-integration: <API_GATEWAY_CONFIG_GOES_HERE>
responses:
  .*"BadRequest".*:
    statusCode: "400"
    responseTemplates:
      $ref: '#/components/templates/BAD_REQUEST_TEMPLATE'

额外注意事项 #

• 确保你的正则.*"BadRequest".*确实能匹配后端返回的响应内容（比如Lambda函数抛出的错误信息），API Gateway会根据这个正则来触发对应的集成响应。
• 如果你的集成是Lambda代理集成，可能不需要手动配置响应模板，但非代理集成场景下，这个配置是必要的。

内容的提问来源于stack exchange，提问作者m.y.m