首页
/ hey-api/openapi-ts 0.67.5版本发布:优化类型生成与注释增强

hey-api/openapi-ts 0.67.5版本发布:优化类型生成与注释增强

2025-06-18 21:12:45作者:伍霜盼Ellen

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定义的兼容性。

技术影响分析

这些改进从多个维度提升了开发体验:

  1. 文档完整性:将SDK注释传递到TanStack Query hooks,实现了API文档的"一次编写,多处使用",符合现代开发中"文档即代码"的理念。

  2. 类型安全性增强:对引用类型的精确处理减少了类型系统的"噪音",使生成的类型定义更加精确,有助于TypeScript编译器进行更有效的类型检查。

  3. 配置灵活性:新增的枚举处理选项给予开发者更多控制权,可以根据项目需求选择最适合的枚举生成策略。

升级建议

对于现有项目,建议在测试环境中先行验证0.67.5版本,特别是关注:

  1. 检查生成的TanStack Query hooks是否完整包含了预期的API文档
  2. 验证复杂数据结构中的引用类型是否正确处理
  3. 根据项目需求评估是否需要启用enumsConstantsIgnoreNull选项

这些改进不会引入破坏性变更,但能显著提升开发体验和代码质量,值得大多数项目进行升级。

登录后查看全文
热门项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
176
261
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
858
511
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
129
182
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
258
298
ShopXO开源商城ShopXO开源商城
🔥🔥🔥ShopXO企业级免费开源商城系统,可视化DIY拖拽装修、包含PC、H5、多端小程序(微信+支付宝+百度+头条&抖音+QQ+快手)、APP、多仓库、多商户、多门店、IM客服、进销存,遵循MIT开源协议发布、基于ThinkPHP8框架研发
JavaScript
93
15
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
332
1.08 K
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
398
371
note-gennote-gen
一款跨平台的 Markdown AI 笔记软件,致力于使用 AI 建立记录和写作的桥梁。
TSX
83
4
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.07 K
0
kernelkernel
deepin linux kernel
C
22
5