首页
/ Hey-API OpenAPI-TS 0.61.0版本发布:增强认证支持与开发体验优化

Hey-API OpenAPI-TS 0.61.0版本发布:增强认证支持与开发体验优化

2025-06-19 07:41:12作者:盛欣凯Ernestine

Hey-API OpenAPI-TS是一个强大的TypeScript代码生成工具,它能够根据OpenAPI规范自动生成类型安全的API客户端代码。该项目极大地简化了前端开发人员与后端API交互的工作流程,通过自动生成的类型定义和客户端方法,开发者可以更高效、更安全地进行API调用。

主要功能增强

HTTP Bearer认证方案支持

0.61.0版本新增了对HTTP Bearer认证方案的支持。Bearer认证是一种常见的API安全机制,它使用Bearer令牌来验证请求的合法性。这一改进使得开发者现在可以轻松生成支持Bearer认证的API客户端代码,而无需手动处理认证头部的添加逻辑。

OpenAPI 2.0规范支持

在实验性解析器中新增了对OpenAPI 2.0(即Swagger)规范的支持。虽然OpenAPI 3.0已成为主流,但许多现有项目仍在使用Swagger规范。这一改进确保了工具能够兼容更广泛的API定义文件,为老项目迁移提供了便利。

开发模式监控功能

新版本引入了文件监控模式(watch mode),这是一个对开发者体验的重要改进。当启用监控模式后,工具会持续观察输入的OpenAPI文件变化,并在检测到修改时自动重新生成客户端代码。这一特性特别适合在API频繁迭代的开发阶段使用,可以显著减少手动重新生成代码的次数,提高开发效率。

需要注意的是,当前版本的监控功能仅支持通过URL访问的远程文件,本地文件的监控支持将在未来版本中实现。

其他重要改进

长整型支持

修复了长整型(long integers)的支持问题。在API设计中,有时需要使用超出JavaScript安全整数范围的数字类型。新版本确保这些大数字能够被正确处理和类型定义。

错误处理选项

新增了sdk.throwOnError配置选项,允许开发者控制API调用失败时的行为。当设置为true时,客户端将在遇到错误时抛出异常,而不是返回错误响应。这为不同的错误处理策略提供了灵活性。

枚举键保留

改进了枚举键生成逻辑,现在会保留原始定义中的前导分隔符。这一变化确保了生成的代码与原始API定义保持更高的一致性,减少了潜在的混淆。

升级注意事项

本次更新包含了一些破坏性变更,特别是认证相关的改进。开发者需要确保同时更新相关的@hey-api/client-*客户端包至最新版本,以获得完整的Basic HTTP认证支持。

总结

Hey-API OpenAPI-TS 0.61.0版本通过增强认证支持、改进规范兼容性和优化开发者体验,进一步巩固了其作为OpenAPI到TypeScript转换首选工具的地位。特别是监控模式的引入,将显著提升开发者在API迭代频繁项目中的工作效率。对于正在使用或考虑采用API客户端代码生成方案的团队,这个版本值得关注和升级。

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

热门内容推荐

最新内容推荐

项目优选

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