CDK中CfnRestApi与RestApi类的核心差异咨询

1. 抽象层级差异 #

• RestApi是CDK的高层抽象（L2 Construct），封装了API Gateway REST API的常见操作与最佳实践，自动处理底层细节（比如默认配置、资源关联逻辑、权限依赖等）。
• CfnRestApi是底层CloudFormation资源（L1 Construct），完全对应CloudFormation的AWS::ApiGateway::RestApi资源，属性与CloudFormation定义一一映射，无额外封装，所有细节需手动配置。

2. 使用复杂度对比 #

• 用RestApi时，可通过简洁语法快速定义API结构，关联资源、方法时无需手动指定依赖：

  const api = new apigateway.RestApi(this, 'MyApi');
  const users = api.root.addResource('users');
  users.addMethod('GET');
  

• 用CfnRestApi时，所有关联资源（如CfnResource、CfnMethod）需手动创建，且必须显式指定RestApiId等依赖属性：

  const cfnApi = new apigateway.CfnRestApi(this, 'MyCfnApi', {
    name: 'MyCfnApi'
  });
  const cfnUsersResource = new apigateway.CfnResource(this, 'UsersResource', {
    restApiId: cfnApi.ref,
    parentId: cfnApi.rootResourceId,
    pathPart: 'users'
  });
  

3. 功能封装程度 #

• RestApi提供大量高层封装功能：比如一键集成Lambda、快速配置CORS、阶段部署管理、访问日志设置等，无需手动拼接CloudFormation参数。
• CfnRestApi仅支持CloudFormation原生属性，任何高层功能都需通过对应L1资源（如CfnDeployment、CfnStage）手动配置，无快捷封装。

4. 适用场景 #

• 优先选RestApi：常规API Gateway开发场景（如标准REST API、后端服务集成），能提升开发效率，减少出错概率。
• 选CfnRestApi：需要精确控制CloudFormation模板每一个细节，或使用RestApi未封装的CloudFormation原生属性时（比如小众配置、自定义模板片段）。

内容的提问来源于stack exchange，提问作者Andrea Lombardo