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

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

2025-06-19 20:52:47作者:盛欣凯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客户端代码生成方案的团队,这个版本值得关注和升级。

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

热门内容推荐

最新内容推荐

项目优选

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