如何在serverless.yml（v2.72.3）中设置AWS API Gateway描述？

问题原因 #

你尝试的provider.apiGateway.description配置，在Serverless框架中实际对应API Gateway的阶段描述，而非API本身的描述字段，因此部署后不会生效。

解决方案 #

在serverless.yml中添加自定义CloudFormation资源，直接修改API Gateway本身的描述：

resources:
  Resources:
    ApiGatewayRestApi:
      Type: AWS::ApiGateway::RestApi
      Properties:
        Description: "你的自定义API描述"
        Name: ${self:service}-${self:provider.stage} # 与Serverless默认生成的API名称保持一致，避免创建新API

注意事项 #

• ApiGatewayRestApi是Serverless框架默认创建的API Gateway资源逻辑ID，直接覆盖该资源的属性即可修改原有API的描述，不会生成新的API实例。
• 务必保持Name字段与框架默认生成的名称格式一致（通常为服务名-部署阶段名），防止部署时出现资源冲突或重复创建API的问题。

内容的提问来源于stack exchange，提问作者user3684747