首页
/ Hey API OpenAPI TypeScript SDK 0.72.0版本发布:增强类结构支持与多项修复

Hey API OpenAPI TypeScript SDK 0.72.0版本发布:增强类结构支持与多项修复

2025-06-18 12:35:21作者:鲍丁臣Ursa

Hey API OpenAPI TypeScript SDK是一个强大的工具,能够将OpenAPI规范转换为类型安全的TypeScript代码,特别适合前端开发者快速构建与后端API交互的客户端。该项目通过自动化生成客户端代码,显著提高了开发效率并减少了手动编写API客户端时可能出现的错误。

主要特性:类结构支持增强

0.72.0版本引入了一个重要的新特性——classStructure选项,它为基于类的SDK生成提供了更灵活的结构控制。这个改进主要针对使用operationId来组织API方法的情况。

在之前的版本中,生成的类结构相对固定,而现在开发者可以通过operationId中的点(.)或斜杠(/)符号来自动创建嵌套的类结构。例如,一个operationIduser.profile.get的API方法,现在可以自动生成在User类的Profile子类中的get方法。

如果开发者希望保持原有的扁平结构,只需将classStructure选项设置为off即可。这个改进使得生成的代码结构更加符合实际业务逻辑的组织方式,提高了代码的可读性和维护性。

重要问题修复

本次更新包含了多个关键修复,提升了工具的稳定性和可用性:

  1. 崩溃报告提示:新增了崩溃报告提示功能,当工具遇到意外错误时,会提示用户提交错误报告,帮助开发团队更快地发现和解决问题。

  2. 属性名称处理:修复了propertyNames关键字的处理问题,现在能够正确解析包含此关键字的OpenAPI规范。

  3. BigInt默认值生成:修正了BigInt类型默认值生成不正确的问题,确保生成的验证代码能够正确处理大整数类型。

  4. 嵌套只读对象处理:改进了对嵌套内联对象中只读字段的处理,现在能够正确识别和生成包含readOnly/writeOnly字段的复杂嵌套对象结构。

技术实现细节

在底层实现上,这些改进涉及到了OpenAPI规范的解析逻辑、TypeScript代码生成策略以及验证器生成机制等多个方面。特别是类结构支持的增强,需要对operationId进行智能解析,并根据解析结果动态构建类层次结构,这展示了工具对复杂API设计的良好适应性。

对于验证器生成部分,修复了类型系统与运行时验证之间的不一致问题,特别是对于JavaScript中相对较新的BigInt类型的支持,确保了生成的代码能够在各种运行时环境下正确工作。

升级建议

对于现有用户,建议评估新版本中的类结构生成功能是否适合您的项目。如果您现有的代码依赖于之前的扁平结构,可以通过配置保持原有行为。对于新项目,推荐尝试新的类结构生成功能,它能够带来更好的代码组织方式。

所有用户都建议升级,特别是如果您遇到了与属性名称处理、BigInt类型或嵌套对象相关的问题,这些修复将直接改善您的开发体验。

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

热门内容推荐

最新内容推荐

项目优选

收起
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