AWS CDK基于Swagger部署API Gateway时更新配置后旧值未清除
CDK SpecRestApi 部署后新旧端点配置并存问题
场景说明
我使用AWS CDK(v1.100.0)管理API Gateway部署,端点定义来自swagger文件,对应堆栈代码如下:
export class MyStack extends cdk.Stack { constructor(scope: cdk.Construct, id: string, props?: cdk.StackProps) { super(scope, id, props); const api = new apigateway.SpecRestApi(this, 'my-api', { cloudWatchRole: false, endpointTypes: [ EndpointType.REGIONAL ], apiDefinition: apigateway.ApiDefinition.fromAsset('path/to/swagger.yaml'), deployOptions: { stageName: 'dev', // ... 其他部署配置 } }); } }
这套配置可以正常完成初始部署,创建出对应API Gateway实例与dev stage环境。
异常表现
每当修改swagger文件(例如将某端点的请求方法从POST改为PUT)并重新触发堆栈部署时,同一路径下的旧POST方法和新的PUT方法会同时存在;如果修改端点路径、请求参数等其他swagger配置,也会出现旧配置没有被清理、和新配置并存的情况。
问题产生原因
- v1.100.0版本
SpecRestApi的实现机制缺陷
该版本的SpecRestApi在解析swagger文件、生成CloudFormation资源时,仅会将当前swagger定义包含的路径、方法对应的AWS::ApiGateway::Resource、AWS::ApiGateway::Method资源纳入堆栈管控范围,没有实现旧资源的清理逻辑。当修改swagger删除/变更原有配置时,已经脱离新swagger定义的旧资源会从CDK的资源树中被移除,但这些资源并不会被标记为需要在AWS侧删除,而是变成不受堆栈管控的游离资源。 - 资源匹配逻辑的局限性
该版本的资源ID匹配规则仅对完全匹配路径、方法的配置做更新复用,当你将某路径下的POST方法改为PUT时,PUT对应的是全新创建的资源,旧的POST方法资源因为不再匹配新的swagger定义,就会被CDK侧丢弃管控,永远保留在实际API Gateway实例中。 - CloudFormation的更新逻辑边界
CloudFormation仅会对模板中纳入管控的资源执行增删改操作,那些已经从CDK资源树中剥离、但实际存在的旧API资源,因为不在新生成的模板范围内,不会被触发删除操作,最终造成新旧配置同时存在的现象。
内容的提问来源于stack exchange,提问作者grigori
相关产品推荐
相关产品推荐

