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

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

2025-06-13 19:41:51作者:余洋婵Anita

Orval 是一个强大的 OpenAPI/Swagger 客户端代码生成工具,能够根据 API 规范自动生成类型安全的客户端代码。最新发布的 7.6.0 版本带来了多项重要改进,特别是在类型安全、Zod 集成和开发体验方面有了显著提升。

核心功能增强

1. 原生枚举类型支持优化

本次更新对原生枚举类型的处理进行了重要调整。在之前的版本中,枚举类型的处理可能存在一些边界情况的问题。新版本通过重构枚举处理逻辑,确保了在各种复杂场景下都能正确生成枚举类型定义,特别是在处理嵌套枚举或联合枚举时更加可靠。

2. 类型系统改进

类型系统方面有两个重要改进:

  • 修复了在合并必需属性时可能出现的问题,现在能够正确处理已经标记为必需的属性,避免生成冗余的类型定义
  • 移除了类型定义中的 any 类型,进一步增强了生成的代码的类型安全性

3. 命名约定自定义支持

新增了命名约定配置选项,开发者现在可以自定义生成代码中的命名风格。这一特性对于需要遵循特定代码风格指南的团队特别有用,可以确保生成的代码与现有代码库风格一致。

Zod 集成深度优化

1. 默认 Zod 支持

7.6.0 版本将 Zod 支持提升到了新高度,现在可以更简单地启用 Zod 验证。通过配置即可自动为所有生成的类型添加 Zod 验证模式,大大简化了 API 请求和响应数据的验证流程。

2. 多部分表单支持

新增了对 multipart/form-data 内容的 Zod 验证支持,这对于文件上传等场景特别重要。生成的代码现在能够正确验证包含文件和其他字段的表单数据。

3. 鉴别器严格模式

在使用鉴别器(discriminator)时,现在会自动启用 Zod 的严格模式,确保鉴别字段被正确处理。这一改进解决了之前版本中可能出现的类型验证不严格的问题。

开发体验提升

1. 状态码分离响应类型

一个显著的改进是现在会根据不同的 HTTP 状态码生成独立的响应类型。这意味着开发者可以更精确地处理不同状态码对应的响应数据,提高了代码的可读性和类型安全性。

2. 常量对象生成

对于使用常量模式定义的 Schema,现在会生成对应的常量对象。这一特性减少了运行时计算,提高了性能,同时也使代码更加清晰。

3. 自定义验证规则集

新增了提供自定义验证规则集的能力,开发者可以根据项目需求定义自己的验证规则,然后应用到生成的代码中。这一特性为有特殊验证需求的场景提供了灵活性。

问题修复与稳定性提升

除了新功能外,7.6.0 版本还修复了多个问题:

  • 修复了 Safari 17.0 以下版本的参数序列化问题
  • 改进了模型名称以下划线开头的处理
  • 修复了组合路由中的语法错误
  • 改进了工作区设置中对现有索引文件的处理
  • 解决了 MSW 在处理嵌套 allOf 时的问题

总结

Orval 7.6.0 版本在类型安全、Zod 集成和开发体验方面都做出了重要改进。这些变化使得生成的客户端代码更加健壮、类型更加精确,同时也为开发者提供了更多的配置选项和更好的开发体验。特别是对 Zod 的深度集成,使得 API 数据的验证变得更加简单和可靠。对于正在使用或考虑使用 Orval 的团队来说,这个版本值得升级。

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