如何使用Serverless Framework修改待创建的API Gateway名称

Hey there! 要修改Serverless Framework自动创建的API Gateway名称，有两种实用的配置方式，你可以根据需求选择：

方法一：全局统一设置API Gateway名称 #

如果希望这个Serverless服务下所有HTTP事件关联的API Gateway都用同一个自定义名称，直接在provider区块里添加apiGateway配置段即可：

provider:
  name: aws
  runtime: nodejs18.x # 替换成你实际使用的运行时
  apiGateway:
    name: My-Custom-API-Gateway # 这里填写你想要的API Gateway名称

functions:
  hello:
    name: hello-handler
    description: blablabla
    handler: /lambda-functions/hello-handler.handler
    role: HelloRole
    package:
      include:
        - lambda-functions/hello-handler.js
    events:
      - http: GET hello

方法二：针对单个HTTP事件单独设置 #

如果需要给不同的HTTP事件指定不同的API Gateway名称（或者只想单独修改某一个API的名称），可以在对应的http事件里展开配置，添加apiName字段：

functions:
  hello:
    name: hello-handler
    description: blablabla
    handler: /lambda-functions/hello-handler.handler
    role: HelloRole
    package:
      include:
        - lambda-functions/hello-handler.js
    events:
      - http:
          path: hello
          method: GET
          apiName: Hello-Service-API # 这里自定义该事件对应的API Gateway名称

小提示 #

• 如果同时配置了全局apiGateway.name和单个事件的apiName，单个事件的配置会优先覆盖全局设置
• API Gateway的名称要符合AWS的命名规范：只能包含字母、数字、连字符和下划线，长度不能超过128个字符

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