如何使用TypeScript版CDK将YAML文件导入API Gateway？

核心思路 #

AWS CDK中，API Gateway的底层CloudFormation资源CfnRestApi支持通过body属性直接传入Swagger或OpenAPI的JSON/YAML内容，不管是新建API还是给已创建的API更新配置，都可以基于这个属性实现导入。

方案1：新建API时直接导入Swagger/YAML #

如果是从头创建API并导入Swagger，直接使用L2构造RestApi的body参数即可：

import * as apigateway from 'aws-cdk-lib/aws-apigateway';
import * as fs from 'fs';
import { Stack, StackProps } from 'aws-cdk-lib';
import { Construct } from 'constructs';

export class MyApiStack extends Stack {
  constructor(scope: Construct, id: string, props?: StackProps) {
    super(scope, id, props);

    // 读取本地Swagger/YAML文件
    const swaggerContent = fs.readFileSync('./path/to/your/swagger.yaml', 'utf8');

    // 创建API并导入Swagger配置
    const api = new apigateway.RestApi(this, 'MyImportedApi', {
      restApiName: 'My Imported API',
      body: swaggerContent, // 直接传入文件内容
    });
  }
}

方案2：给已通过CDK创建的API导入Swagger/YAML #

如果已经用CDK创建了API（比如你已经添加了资源和方法），可以通过修改其底层的CfnRestApi资源来导入Swagger：

import * as apigateway from 'aws-cdk-lib/aws-apigateway';
import * as fs from 'fs';
import { Stack, StackProps } from 'aws-cdk-lib';
import { Construct } from 'constructs';

export class MyApiStack extends Stack {
  constructor(scope: Construct, id: string, props?: StackProps) {
    super(scope, id, props);

    // 你已创建的API
    const existingApi = new apigateway.RestApi(this, 'MyExistingApi', {
      restApiName: 'My Existing API',
      // 原来的配置...
    });

    // 读取Swagger/YAML文件
    const swaggerContent = fs.readFileSync('./path/to/your/swagger.yaml', 'utf8');

    // 获取API对应的底层CloudFormation资源
    const cfnApi = existingApi.node.defaultChild as apigateway.CfnRestApi;
    // 设置body属性，覆盖原有配置
    cfnApi.body = swaggerContent;
  }
}

注意事项 #

• 配置冲突处理：CDK是声明式基础设施即代码，导入Swagger后会覆盖API Gateway的现有配置（包括你之前添加的资源和方法）。确保你的Swagger文件包含所有需要保留的API定义，或者调整Swagger内容与现有CDK配置匹配。
• 动态变量替换：如果Swagger文件中需要引用CDK创建的资源（比如Lambda函数ARN），可以先读取文件内容，再替换占位符：

  import * as lambda from 'aws-cdk-lib/aws-lambda';
  
  // 假设你有一个Lambda函数
  const myLambda = new lambda.Function(this, 'MyLambda', {
    // Lambda配置...
  });
  
  let swaggerContent = fs.readFileSync('./swagger.yaml', 'utf8');
  // 替换Swagger中的占位符
  swaggerContent = swaggerContent.replace('{{LAMBDA_ARN}}', myLambda.functionArn);
  
  const cfnApi = existingApi.node.defaultChild as apigateway.CfnRestApi;
  cfnApi.body = swaggerContent;
  

• YAML/JSON格式兼容：CloudFormation的CfnRestApi.body同时支持JSON字符串和YAML字符串，直接读取对应格式的文件内容传入即可，无需额外转换。

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