使用SAM模板与LocalStack时，如何为API Gateway生成自定义静态ID？

可以实现，核心是利用LocalStack对CloudFormation的扩展支持，直接在AWS::ApiGateway::RestApi资源中指定自定义ID，具体有两种方式：

方式一：直接在Properties中添加RestApiId字段 #

修改你的SAM模板，在RestApi资源的Properties里加上RestApiId字段，填入你想要的自定义ID：

Resources:
  MyCustomRestApi:
    Type: AWS::ApiGateway::RestApi
    Properties:
      Name: MyRestApi
      RestApiId: "my-api-id-001"  # 替换为你的自定义ID

方式二：通过Metadata字段配置 #

如果不想直接修改Properties（避免和AWS原生模板冲突），可以用LocalStack专属的Metadata配置：

Resources:
  MyCustomRestApi:
    Type: AWS::ApiGateway::RestApi
    Metadata:
      LocalStack:
        Properties:
          RestApiId: "my-api-id-001"  # 自定义ID
    Properties:
      Name: MyRestApi

验证效果 #

部署后，执行以下命令确认API ID是否生效：

samlocal list apis
# 或者用AWS CLI直接查询
aws --endpoint-url=http://localhost:4566 apigateway get-rest-apis

此时生成的API Gateway URL会包含你设置的自定义ID，格式为：https://<自定义ID>.execute-api.localhost.localstack.cloud:4566/<阶段名>/

注意：这个配置是LocalStack的扩展特性，仅在LocalStack环境中生效，部署到真实AWS时会被自动忽略，不会影响线上环境。

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