HeyAPI OpenAPI-TS 项目新增排除废弃端点功能解析

在API开发领域，随着接口的迭代更新，经常会出现一些被标记为废弃(deprecated)的端点。这些端点虽然仍可工作，但通常不建议在新代码中使用。HeyAPI的openapi-ts工具最新版本0.66.1引入了一项重要功能——自动排除废弃端点的能力，为开发者提供了更干净的SDK生成体验。

功能背景

在OpenAPI规范中，端点可以通过设置"deprecated": true属性来标记为废弃状态。传统上，即使端点被标记为废弃，它们仍然会被包含在生成的SDK中，这可能导致以下问题：

1. 增加了SDK的体积
2. 给开发者提供了不应该使用的API选项
3. 可能引起代码维护的混淆

配置方法

openapi-ts工具现在支持通过配置项来排除这些废弃端点。开发者只需在配置文件中添加以下设置：

export default defineConfig({
  input: {
    exclude: '@deprecated',
    path: 'path/to/openapi.json',
  },
  // 其他配置...
});

这个简单的配置就能确保所有被标记为废弃的端点不会出现在生成的SDK代码中。

技术实现原理

该功能的实现基于OpenAPI规范的AST(抽象语法树)处理。工具在解析OpenAPI文档时：

1. 首先构建完整的API端点树
2. 然后应用过滤规则，移除带有deprecated标记的节点
3. 最后基于清理后的AST生成类型定义和SDK代码

这种处理方式确保了类型系统的完整性，同时移除了不需要的废弃端点。

迁移建议

对于从其他工具(如openapi-typescript)迁移过来的项目，这项功能提供了平滑的过渡路径。开发者可以：

1. 首先验证现有项目中废弃端点的使用情况
2. 逐步将代码迁移到非废弃的替代端点
3. 最后启用这个排除功能，确保新代码不会意外使用废弃API

最佳实践

1. 渐进式迁移：不要一次性排除所有废弃端点，而是分阶段进行
2. 文档记录：在项目文档中明确记录被排除的废弃端点
3. 团队沟通：确保所有团队成员了解这一变更
4. 测试验证：在启用排除功能后，运行完整的测试套件

这项功能的加入使得openapi-ts工具在API客户端生成方面更加完善，帮助开发者构建更干净、更面向未来的应用代码。随着API演进，这种能力将成为维护大型项目的重要工具。