Orval v7.4.0 版本发布:API 客户端生成工具的重大更新
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 客户端生成工具领先选择的地位,为前端开发者提供了高效、可靠的解决方案。
atomcodeClaude Code 的开源替代方案。连接任意大模型,编辑代码,运行命令,自动验证 — 全自动执行。用 Rust 构建,极致性能。 | An open-source alternative to Claude Code. Connect any LLM, edit code, run commands, and verify changes — autonomously. Built in Rust for speed. Get StartedRust098- DDeepSeek-V4-ProDeepSeek-V4-Pro(总参数 1.6 万亿,激活 49B)面向复杂推理和高级编程任务,在代码竞赛、数学推理、Agent 工作流等场景表现优异,性能接近国际前沿闭源模型。Python00
MiMo-V2.5-ProMiMo-V2.5-Pro作为旗舰模型,擅⻓处理复杂Agent任务,单次任务可完成近千次⼯具调⽤与⼗余轮上 下⽂压缩。Python00
GLM-5.1GLM-5.1是智谱迄今最智能的旗舰模型,也是目前全球最强的开源模型。GLM-5.1大大提高了代码能力,在完成长程任务方面提升尤为显著。和此前分钟级交互的模型不同,它能够在一次任务中独立、持续工作超过8小时,期间自主规划、执行、自我进化,最终交付完整的工程级成果。Jinja00
Kimi-K2.6Kimi K2.6 是一款开源的原生多模态智能体模型,在长程编码、编码驱动设计、主动自主执行以及群体任务编排等实用能力方面实现了显著提升。Python00
MiniMax-M2.7MiniMax-M2.7 是我们首个深度参与自身进化过程的模型。M2.7 具备构建复杂智能体应用框架的能力,能够借助智能体团队、复杂技能以及动态工具搜索,完成高度精细的生产力任务。Python00