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

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

2025-06-18 08:38:37作者:伍霜盼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选项

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

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

项目优选

收起
kernelkernel
deepin linux kernel
C
22
6
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
139
1.91 K
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
73
63
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
922
551
PaddleOCRPaddleOCR
飞桨多语言OCR工具包(实用超轻量OCR系统,支持80+种语言识别,提供数据标注与合成工具,支持服务器、移动端、嵌入式及IoT设备端的训练与部署) Awesome multilingual OCR toolkits based on PaddlePaddle (practical ultra lightweight OCR system, support 80+ languages recognition, provide data annotation and synthesis tools, support training and deployment among server, mobile, embedded and IoT devices)
Python
47
1
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
273
leetcodeleetcode
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
59
16