Hey API OpenAPI TypeScript 生成器升级：更智能的输入过滤器

项目简介

Hey API OpenAPI TypeScript 是一个强大的工具，能够将 OpenAPI/Swagger 规范自动转换为 TypeScript 类型定义和客户端代码。它极大地简化了前端开发人员与后端 API 交互的工作流程，确保类型安全并减少手动编写接口定义的工作量。

输入过滤器的重要升级

在最新发布的 0.68.0 版本中，Hey API OpenAPI TypeScript 对其输入过滤器功能进行了重大改进。这一改进主要解决了开发者在过滤 OpenAPI 文档时遇到的两个核心问题：

1. 更可靠的过滤机制：新版本避免了生成无效输出的问题，不再需要开发者手动指定每一个缺失的模式(schema)。

2. 简化的配置方式：移除了对正则表达式的支持，采用了更直观的配置语法，使过滤规则的编写更加清晰和易于维护。

新旧配置对比

在之前的版本中，开发者需要使用复杂的正则表达式来过滤操作和模式：

export default {
  input: {
    include: '^(#/components/schemas/foo|#/paths/api/v1/foo/get)'
  }
}

而在新版本中，配置变得更加直观和结构化：

export default {
  input: {
    filters: {
      operations: {
        include: ['GET /api/v1/foo'],
      },
      schemas: {
        include: ['foo'],
      },
    },
  }
}

技术优势

1. 更安全的代码生成：新过滤器会自动处理依赖关系，确保生成的代码不会因为缺少依赖而失效。

2. 更好的可读性：结构化配置比正则表达式更易于理解和维护，降低了团队协作的成本。

3. 更精确的控制：可以分别针对操作(operations)和模式(schemas)进行精细化的过滤控制。

升级建议

对于正在使用正则表达式进行过滤的项目，建议逐步迁移到新的过滤语法。虽然正则表达式功能强大，但新的结构化配置在大多数常见场景下已经足够，并且带来了更好的可维护性。

如果您的项目确实依赖于正则表达式的高级匹配功能，可以考虑暂时停留在旧版本，或者向开发团队反馈您的具体需求，以便未来版本考虑重新引入正则表达式支持。

总结

Hey API OpenAPI TypeScript 0.68.0 版本的输入过滤器升级，体现了开发团队对开发者体验的持续关注。通过简化配置语法和增强过滤的可靠性，这个工具在自动化 API 客户端生成领域又向前迈进了一步。对于任何使用 TypeScript 与 REST API 交互的项目，这都是一次值得考虑的升级。