不同CDK栈中API Gateway端点已添加但阶段未同步的解决咨询

主栈创建API Gateway并部署v1阶段后，工作栈通过fromRestApiAttributes导入该API并添加新路径和方法，但这些变更未同步到v1阶段，导致新端点无法调用。核心原因是主栈的初始部署不会自动感知其他栈对API的修改，需要手动触发API Gateway重新部署并更新阶段关联。

方法1：手动管理Deployment与Stage，跨栈触发更新 #

步骤1：修改主栈，显式创建Deployment和Stage并暴露必要属性

修改main-stack.ts，去掉自动部署配置，手动创建Deployment和Stage，并将API ID、Stage名称等属性暴露给工作栈：

export class MainSlackBotStack extends cdk.Stack {
  public readonly api: apigateway.RestApi;
  public readonly apiId: string;
  public readonly stageName: string;
  public readonly rootResourceId: string;

  constructor(scope: Construct, id: string, props: MainSlackBotStackProps) {
    super(scope, id, props);

    this.api = new apigateway.RestApi(this, 'MainSlackBotApi', {
      restApiName: 'MainSlackBotApi',
      description: 'This service is the api gateway for the Slack Bot',
      defaultCorsPreflightOptions: {
        allowHeaders: ["Content-Type", "X-Amz-Date", "Authorization", "X-Api-Key"],
        allowMethods: ["OPTIONS", "POST"],
        allowCredentials: true,
        allowOrigins: ["*"],
      },
    });

    // 手动创建Deployment
    const deployment = new apigateway.Deployment(this, 'MainApiDeployment', {
      api: this.api,
    });

    // 手动创建Stage
    const stage = new apigateway.Stage(this, 'MainApiStage', {
      deployment: deployment,
      stageName: 'v1',
    });

    // 暴露必要属性给工作栈
    this.apiId = this.api.restApiId;
    this.stageName = stage.stageName;
    this.rootResourceId = this.api.restApiRootResourceId;
  }
}

步骤2：工作栈添加端点后，创建新Deployment并更新Stage

在worker-stack.ts中，添加完端点后，创建新的Deployment，并通过自定义Lambda资源更新v1阶段指向该Deployment：

// 导入主API
const mainApi = apigateway.RestApi.fromRestApiAttributes(this, `MainApi`, {
    restApiId: props.apiId,
    rootResourceId: props.rootResourceId,
});

// 添加API端点（保留原有代码）
const slackBotEndpoint = mainApi.root.addResource(`${props.namespace}`);
slackBotEndpoint.addMethod(
    "POST",
    new apigateway.LambdaIntegration(commandEntryFunction, {}),
    {
        methodResponses: [{
            statusCode: '200',
            responseParameters: {
                'method.response.header.Content-Type': true,
                'method.response.header.Access-Control-Allow-Origin': true,
            },
        }],
        authorizer: customAuthorizerFunction,
        authorizationType: apigateway.AuthorizationType.CUSTOM,
    },
);

// 创建新的Deployment，用时间戳确保每次部署生成唯一实例
const newDeployment = new apigateway.Deployment(this, `WorkerDeployment-${props.namespace}`, {
  api: mainApi,
  description: `Deployment for ${props.namespace} - ${Date.now()}`,
});

// 创建Lambda用于更新API Gateway Stage
const updateStageLambda = new lambda.Function(this, 'UpdateStageFn', {
  runtime: lambda.Runtime.NODEJS_18_X,
  handler: 'index.handler',
  code: lambda.Code.fromInline(`
    const AWS = require('aws-sdk');
    const apigw = new AWS.APIGateway({ region: process.env.AWS_REGION });

    exports.handler = async (event) => {
      const { restApiId, stageName, deploymentId } = event.ResourceProperties;
      await apigw.updateStage({
        restApiId,
        stageName,
        patchOperations: [{ op: 'replace', path: '/deploymentId', value: deploymentId }]
      }).promise();
      return { PhysicalResourceId: deploymentId };
    };
  `),
});

// 授予Lambda更新Stage的权限
updateStageLambda.addToRolePolicy(new iam.PolicyStatement({
  actions: ['apigateway:updateStage'],
  resources: [`arn:aws:apigateway:${cdk.Aws.REGION}::/restapis/${props.apiId}/stages/${props.stageName}`],
}));

// 触发自定义资源执行更新，确保Deployment创建完成后再执行
new cdk.CustomResource(this, 'UpdateStageResource', {
  serviceToken: updateStageLambda.functionArn,
  properties: {
    restApiId: props.apiId,
    stageName: props.stageName,
    deploymentId: newDeployment.deploymentId,
  },
  dependsOn: [newDeployment],
});

方法2：使用CDK的autoDeploy（仅适用于简单跨栈场景） #

如果主栈与工作栈存在强依赖关系，可在主栈的RestApi配置中开启autoDeploy，让API Gateway在检测到变更时自动重新部署。但此方法可靠性有限，跨栈的API变更可能无法被主栈的CDK合成过程感知：

this.api = new apigateway.RestApi(this, 'MainSlackBotApi', {
  // ...其他配置
  deployOptions: {
    stageName: "v1",
    autoDeploy: true, // 开启自动部署
  },
});

API Gateway的Stage与Deployment是绑定关系，只有将新的Deployment关联到Stage，API变更才会生效。跨栈场景下，主栈的初始Deployment无法感知工作栈对API的修改，因此需要在工作栈中创建新的Deployment并主动更新Stage的绑定关系。

内容的提问来源于stack exchange，提问作者Matthew D'vertola