hey-api/openapi-ts 0.67.5版本发布:优化类型生成与注释增强
hey-api/openapi-ts是一个用于将OpenAPI/Swagger规范转换为TypeScript类型的强大工具。它能够自动生成客户端SDK、类型定义以及与流行前端框架(如TanStack Query)集成的代码,极大简化了前端开发人员与后端API交互的工作流程。
核心改进内容
1. TanStack Query注释增强
本次更新重点改进了与TanStack Query(原React Query)集成的代码生成功能。现在生成的TanStack Query hooks将自动包含原始SDK函数的完整注释内容。这一改进使得开发者在IDE中查看自动补全时,能够直接获取API方法的详细说明文档,无需在原始SDK文件和hooks文件之间来回切换。
2. 引用类型处理优化
在类型系统生成方面,0.67.5版本解决了引用类型($ref)在readable/writable模式下的处理问题。当被引用的模式不包含任何可读/可写字段时,生成器现在会正确排除这些引用,避免了生成冗余或无效的类型定义。这一改进特别有利于处理复杂的嵌套数据结构场景。
3. 枚举常量空值排除
新增了enumsConstantsIgnoreNull配置选项,允许开发者选择是否在生成的JavaScript枚举常量对象中排除null值。这个功能特别适合那些需要严格类型检查的项目,可以避免null值污染枚举类型系统,同时保持与后端API定义的兼容性。
技术影响分析
这些改进从多个维度提升了开发体验:
-
文档完整性:将SDK注释传递到TanStack Query hooks,实现了API文档的"一次编写,多处使用",符合现代开发中"文档即代码"的理念。
-
类型安全性增强:对引用类型的精确处理减少了类型系统的"噪音",使生成的类型定义更加精确,有助于TypeScript编译器进行更有效的类型检查。
-
配置灵活性:新增的枚举处理选项给予开发者更多控制权,可以根据项目需求选择最适合的枚举生成策略。
升级建议
对于现有项目,建议在测试环境中先行验证0.67.5版本,特别是关注:
- 检查生成的TanStack Query hooks是否完整包含了预期的API文档
- 验证复杂数据结构中的引用类型是否正确处理
- 根据项目需求评估是否需要启用
enumsConstantsIgnoreNull选项
这些改进不会引入破坏性变更,但能显著提升开发体验和代码质量,值得大多数项目进行升级。
atomcodeClaude Code 的开源替代方案。连接任意大模型,编辑代码,运行命令,自动验证 — 全自动执行。用 Rust 构建,极致性能。 | An open-source alternative to Claude Code. Connect any LLM, edit code, run commands, and verify changes — autonomously. Built in Rust for speed. Get StartedRust098- DDeepSeek-V4-ProDeepSeek-V4-Pro(总参数 1.6 万亿,激活 49B)面向复杂推理和高级编程任务,在代码竞赛、数学推理、Agent 工作流等场景表现优异,性能接近国际前沿闭源模型。Python00
MiMo-V2.5-ProMiMo-V2.5-Pro作为旗舰模型,擅⻓处理复杂Agent任务,单次任务可完成近千次⼯具调⽤与⼗余轮上 下⽂压缩。Python00
GLM-5.1GLM-5.1是智谱迄今最智能的旗舰模型,也是目前全球最强的开源模型。GLM-5.1大大提高了代码能力,在完成长程任务方面提升尤为显著。和此前分钟级交互的模型不同,它能够在一次任务中独立、持续工作超过8小时,期间自主规划、执行、自我进化,最终交付完整的工程级成果。Jinja00
Kimi-K2.6Kimi K2.6 是一款开源的原生多模态智能体模型,在长程编码、编码驱动设计、主动自主执行以及群体任务编排等实用能力方面实现了显著提升。Python00
MiniMax-M2.7MiniMax-M2.7 是我们首个深度参与自身进化过程的模型。M2.7 具备构建复杂智能体应用框架的能力,能够借助智能体团队、复杂技能以及动态工具搜索,完成高度精细的生产力任务。Python00