首页
/ Orval v7.4.0 版本发布:API 客户端生成工具的重大更新

Orval v7.4.0 版本发布:API 客户端生成工具的重大更新

2025-06-13 18:49:43作者:戚魁泉Nursing

Orval 是一个强大的 API 客户端生成工具,它能够根据 OpenAPI/Swagger 规范自动生成类型安全的 API 客户端代码。这个工具特别适合前端开发团队,可以显著减少手动编写 API 调用代码的工作量,同时确保类型安全。最新发布的 v7.4.0 版本带来了一系列功能增强和错误修复,进一步提升了开发体验。

核心功能改进

1. 属性排序功能

新版本引入了属性排序功能,使得生成的代码更加整洁有序。这个功能特别适用于大型 API 项目,可以帮助开发者更快速地定位和理解生成的代码结构。属性排序不仅提升了代码的可读性,也使得团队协作更加高效。

2. 服务器字段支持

Orval 现在能够正确处理 OpenAPI 规范中的 servers 字段。这意味着生成的客户端代码将能够更好地处理不同环境(如开发、测试、生产)的 API 端点配置,为多环境部署提供了更好的支持。

3. 类型文档生成

一个值得注意的新特性是能够生成 TypeDoc 格式的 API 文档。这使得开发者可以直接从生成的代码中获得详细的 API 文档,无需额外维护文档系统。生成的文档包含了完整的类型信息和方法说明,极大地提升了开发体验。

类型系统增强

1. 数组类型处理改进

当数组定义中没有明确指定 items 类型时,Orval 现在会默认使用 unknown[] 类型,而不是简单地忽略这种情况。这种处理方式更加符合 TypeScript 的类型安全原则,减少了潜在的运行时错误。

2. 枚举类型处理优化

对于包含 null 值的枚举类型,现在会正确地添加 "| null" 联合类型。同时,对于原生枚举类型,现在会使用 keyof typeof 语法,确保类型检查更加准确。这些改进使得枚举类型的使用更加符合 TypeScript 的最佳实践。

3. 表单数据类型修正

修复了表单数据(FormData)类型中可能出现的 undefined 类型问题。现在生成的代码会正确处理表单数据的类型定义,避免了潜在的类型错误。

客户端生成改进

1. Fetch 客户端增强

Fetch 客户端现在提供了更完善的类型支持:

  • 响应数据现在包含完整的类型信息
  • 错误类型被正确地包含在响应数据类型中
  • 对于没有内容的响应体,避免了不必要的异常
  • 新增了对 NDJSON 响应类型的支持

这些改进使得生成的 Fetch 客户端更加健壮和类型安全,特别是在处理各种边缘情况时表现更好。

2. 查询库集成优化

对于使用 React Query 或 Vue Query 的开发者,新版本带来了以下改进:

  • 为突变操作添加了默认的 mutation key
  • 为突变钩子添加了 TData 泛型支持
  • 确保当 allParamsOptional 为 true 时,定义具有可选类型

这些改进使得与流行状态管理库的集成更加无缝,提供了更好的开发体验。

错误修复与稳定性提升

v7.4.0 版本修复了多个关键问题,包括:

  • 修复了头参数作为引用时生成不正确的问题
  • 修正了模式过滤器未定义时的模式生成行为
  • 解决了重命名枚举被旧名称使用的问题
  • 修复了 Mock 处理程序中的导入问题
  • 修正了 MSW 模拟中的对象语法错误

这些修复显著提升了工具的稳定性和可靠性,使得生成的代码质量更高。

总结

Orval v7.4.0 版本带来了多项重要改进,特别是在类型系统、文档生成和客户端功能方面。这些更新不仅提升了开发体验,也使得生成的代码更加健壮和类型安全。对于正在使用或考虑使用 API 客户端生成工具的团队来说,这个版本值得升级。

新加入的 TypeDoc 文档生成功能特别有价值,它能够自动为生成的 API 客户端创建详细的文档,减少了维护文档的额外工作。同时,对 Fetch 客户端的多项增强使得生成的代码能够更好地处理各种实际场景。

随着这些改进,Orval 继续巩固其作为 API 客户端生成工具领先选择的地位,为前端开发者提供了高效、可靠的解决方案。

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

项目优选

收起
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
819
487
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
120
175
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
163
252
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
322
1.07 K
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
172
259
note-gennote-gen
一款跨平台的 Markdown AI 笔记软件,致力于使用 AI 建立记录和写作的桥梁。
TSX
79
2
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.05 K
0
WxJavaWxJava
微信开发 Java SDK,支持微信支付、开放平台、公众号、视频号、企业微信、小程序等的后端开发,记得关注公众号及时接受版本更新信息,以及加入微信群进行深入讨论
Java
818
22
MateChatMateChat
前端智能化场景解决方案UI库,轻松构建你的AI应用,我们将持续完善更新,欢迎你的使用与建议。 官网地址:https://matechat.gitcode.com
719
102
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
568
51