首页
/ Orval v7.8.0 版本发布:增强类型安全与开发体验

Orval v7.8.0 版本发布:增强类型安全与开发体验

2025-06-13 23:31:48作者:苗圣禹Peter

Orval 是一个强大的 API 客户端生成工具,它能够根据 OpenAPI/Swagger 规范自动生成类型安全的 API 客户端代码。最新发布的 7.8.0 版本带来了一系列改进,特别是在类型系统、Zod 集成和错误处理方面有了显著提升。

核心改进

类型系统增强

本次版本在类型系统方面做了多项优化:

  1. 自定义错误和响应体类型:修复了自定义错误和响应体类型的导入问题,现在能够正确识别和导入用户定义的类型,这对于需要自定义错误处理的场景尤为重要。

  2. 默认响应处理:为 fetch 实现添加了默认响应处理逻辑,当 API 没有明确指定响应类型时,系统会提供合理的默认值,避免运行时错误。

  3. 原生枚举支持:重新引入了对原生枚举类型的支持修复,确保枚举类型在生成的代码中能够正确工作。

Zod 集成优化

Orval 与 Zod 的集成在本版本中获得了多项重要改进:

  1. 必填字段处理:现在会优先考虑 required 定义来确定是否使用 optional(),这使得必填字段的校验更加准确。

  2. 元组函数映射:修正了元组(tuple)类型的函数映射问题,现在能够正确生成元组类型的校验代码。

  3. 枚举模式生成:改进了多种类型下的枚举模式生成逻辑,支持更丰富的枚举使用场景。

  4. 引用属性处理:修复了 schema 中 $ref 属性名的处理问题,确保引用属性能够正确解析。

  5. 日期时间选项:新增了 output.orverride.zod.datetimeOptions 配置选项,允许开发者自定义日期时间类型的处理方式。

开发者体验提升

QueryClient 参数可选化

针对使用 TanStack Query v5 的用户,现在 mutations 操作支持可选的 queryClient 参数。这一改进使得在需要自定义 QueryClient 实例的场景下更加灵活,同时保持了向后兼容性。

MSW 集成改进

解决了嵌套引用(nested ref)的处理问题,使得在使用 Mock Service Worker 进行 API 模拟时,能够正确处理复杂的嵌套数据结构。

Axios 升级

将 axios 依赖升级到了 1.8.2 版本,并修复了相关的 TypeScript 错误,提升了 HTTP 客户端的稳定性和类型安全性。

技术价值

这次更新体现了 Orval 项目对开发者体验和类型安全的持续关注。特别是对 Zod 集成的多项改进,使得开发者能够更自信地构建类型安全的 API 客户端。自定义错误处理的完善也为构建健壮的应用提供了更好支持。

对于正在使用 Orval 的团队来说,升级到 7.8.0 版本将获得更稳定的类型推断和更灵活的配置选项,特别是在处理复杂数据结构和自定义校验规则时体验会明显提升。新加入的日期时间配置选项也为国际化应用开发提供了更多可能性。

总体而言,Orval 7.8.0 通过这一系列改进,进一步巩固了其作为 API 客户端生成工具的领导地位,特别是在类型安全和开发者体验方面树立了新的标杆。

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