使用AWS CDK更新API Gateway后，导出始终为旧版本求助

问题场景 #

使用AWS CDK创建API Gateway，初始代码定义了请求模型CreateUserDto并关联到/users POST方法：

const api = new apigateway.RestApi(this, 'MyApiGateway', {
  deploy: true,
  retainDeployments: false
});

const createDto = api.addModel('CreateUserDto', {
  modelName: 'CreateUserDto',
  schema: ...
});

const users = api.root.addResource('users');
users.addMethod(
  'POST',
  createUserLambdaIntegration, {
    operationName: 'Create User',
    requestModels: {
      'application/json': createDto
    },
    methodResponses: [
      {
        statusCode: '201'
      }
    ]
  }
);

后续修改代码，将请求模型重命名为CreateUserRequest，并新增响应模型CreateUserResponse关联到方法：

const api = new apigateway.RestApi(this, 'MyApiGateway', {
  deploy: true,
  retainDeployments: false
});

const createUserRequest = api.addModel('CreateUserRequest', {
  modelName: 'CreateUserRequest',
  schema: ...
});

const createUserResponse = api.addModel('CreateUserResponse', {
  modelName: 'CreateUserResponse',
  schema: ...
});

const users = api.root.addResource('users');
users.addMethod(
  'POST',
  createUserLambdaIntegration, {
    operationName: 'Create User',
    requestModels: {
      'application/json': createUserRequest
    },
    methodResponses: [
      {
        statusCode: '201',
        responseModels: {
          'application/json': createUserResponse
        }
      }
    ]
  }
);

修改后API Gateway控制台可见更新后的模型，但通过控制台或AWS CLI导出Swagger JSON时，始终得到最初部署的版本。

问题原因 #

核心原因是导出操作指向的部署版本未同步到最新修改，可能的具体诱因包括：

• CDK部署未自动触发新的API Gateway部署资源更新
• API阶段未关联到最新的部署版本
• 导出时指定了旧的部署ID或阶段

解决步骤 #

1. 确认CDK部署已更新API部署资源 #

• 执行cdk deploy时，检查输出日志，确认AWS::ApiGateway::Deployment资源被标记为CREATE或UPDATE。
• 登录CloudFormation控制台，查看对应栈的变更历史，验证部署资源已被重新创建。

2. 检查阶段与最新部署的关联 #

• 进入API Gateway控制台，打开目标API的Stages页面。
• 选择对应的阶段（如默认的prod），查看页面顶部的Deployment字段，确认其指向最新的部署ID（可在Deployments页面对比最新部署记录）。
• 若阶段未关联最新部署，可手动在控制台将阶段重新部署到最新版本，或检查CDK代码是否正确绑定阶段与部署。

3. 导出时明确指定最新部署（CLI方式） #

使用AWS CLI导出时，强制指定最新的部署ID或正确的阶段：

# 通过阶段名称导出（确保阶段关联最新部署）
aws apigateway get-export --rest-api-id YOUR_API_ID --stage-name YOUR_STAGE_NAME --export-type swagger --parameters extensions='apigateway' --output json > swagger.json

# 或直接指定最新部署ID
aws apigateway get-export --rest-api-id YOUR_API_ID --deployment-id YOUR_LATEST_DEPLOYMENT_ID --export-type swagger --parameters extensions='apigateway' --output json > swagger.json

4. 强制CDK生成新部署 #

若CDK未自动触发部署更新，可通过给部署添加动态标识强制刷新：

const api = new apigateway.RestApi(this, 'MyApiGateway', {
  deploy: true,
  retainDeployments: false,
  deployOptions: {
    description: `Updated at ${new Date().toISOString()}`
  }
});

每次部署时，动态生成的时间戳会让CDK认为部署配置变更，从而重新创建部署资源。

5. 验证模型与方法的关联 #

• 在API Gateway控制台的Models页面，确认CreateUserRequest和CreateUserResponse存在且配置正确。
• 进入/users POST方法的Integration Request和Method Response页面，确认请求/响应模型已正确关联。

内容的提问来源于stack exchange，提问作者Pedro Martins Timóteo da Costa