Orval项目中allOf与对象结合时生成无效语法的问题分析
2025-06-17 14:23:02作者:邓越浪Henry
问题背景
在Orval项目(一个用于生成API客户端代码的工具)中,当使用OpenAPI规范定义响应模式时,如果响应模式使用了allOf关键字并且其中一个子模式包含对象属性定义,会导致生成的MSW(Mock Service Worker)模拟代码出现语法错误。
问题重现
通过一个具体的OpenAPI规范示例可以清晰地重现这个问题。示例中定义了一个GET端点,其响应模式使用了allOf组合两个模式:
- 一个分页DTO模式(PaginatedDto),包含
total_count和next_cursor字段 - 一个直接定义的属性对象,包含
data数组字段,数组元素为用户对象(User)
生成的错误代码
Orval生成的模拟响应代码中出现了语法错误,具体表现为对data字段的错误解构操作:
export const getGetResponseMock = (): ExampleResponseResponse => ({
...{total_count: faker.number.int({min: undefined, max: undefined}),
next_cursor: faker.helpers.arrayElement([faker.string.uuid(), null])},
...data: Array.from({ length: faker.number.int({ min: 1, max: 10 }) }, (_, i) => i + 1)
.map(() => ({username: faker.string.alpha(20)}))
})
问题出在...data:这一部分,这里错误地使用了对象展开运算符(...)来展开data属性,而实际上应该直接作为对象属性赋值。
期望的正确代码
正确的生成代码应该是:
export const getGetResponseMock = (): ExampleResponseResponse => ({
...{total_count: faker.number.int({min: undefined, max: undefined}),
next_cursor: faker.helpers.arrayElement([faker.string.uuid(), null])},
data: Array.from({ length: faker.number.int({ min: 1, max: 10 }) }, (_, i) => i + 1)
.map(() => ({username: faker.string.alpha(20)}))
})
技术分析
这个问题本质上是一个代码生成逻辑的缺陷。当处理allOf组合时,Orval的代码生成器应该:
- 正确识别
allOf中的每个组成部分 - 对于引用类型($ref)的部分,使用对象展开(...)来合并属性
- 对于直接定义的属性对象,应该保持其原始结构,而不是尝试展开
在当前的实现中,生成器似乎对所有allOf的子项都统一使用了对象展开语法,而没有区分它们是引用类型还是内联定义的对象属性。
影响范围
这个问题会影响所有使用以下特征的OpenAPI规范:
- 响应模式中使用
allOf组合 allOf中包含直接定义的对象属性(非引用类型)- 使用Orval生成MSW模拟代码
解决方案建议
修复这个问题的思路应该是修改Orval的代码生成逻辑,使其能够:
- 区分
allOf中的引用类型和内联定义 - 对引用类型使用对象展开语法
- 对内联定义的对象属性保持原始结构
这种修复将确保生成的模拟代码既保持功能正确性,又符合TypeScript的语法规范。
登录后查看全文
热门项目推荐
相关项目推荐
ERNIE-4.5-VL-28B-A3B-ThinkingERNIE-4.5-VL-28B-A3B-Thinking 是 ERNIE-4.5-VL-28B-A3B 架构的重大升级,通过中期大规模视觉-语言推理数据训练,显著提升了模型的表征能力和模态对齐,实现了多模态推理能力的突破性飞跃Python00
Kimi-K2-ThinkingKimi K2 Thinking 是最新、性能最强的开源思维模型。从 Kimi K2 开始,我们将其打造为能够逐步推理并动态调用工具的思维智能体。通过显著提升多步推理深度,并在 200–300 次连续调用中保持稳定的工具使用能力,它在 Humanity's Last Exam (HLE)、BrowseComp 等基准测试中树立了新的技术标杆。同时,K2 Thinking 是原生 INT4 量化模型,具备 256k 上下文窗口,实现了推理延迟和 GPU 内存占用的无损降低。Python00
MiniMax-M2MiniMax-M2是MiniMaxAI开源的高效MoE模型,2300亿总参数中仅激活100亿,却在编码和智能体任务上表现卓越。它支持多文件编辑、终端操作和复杂工具链调用Python00
HunyuanVideo-1.5暂无简介00
MiniCPM-V-4_5MiniCPM-V 4.5 是 MiniCPM-V 系列中最新且功能最强的模型。该模型基于 Qwen3-8B 和 SigLIP2-400M 构建,总参数量为 80 亿。与之前的 MiniCPM-V 和 MiniCPM-o 模型相比,它在性能上有显著提升,并引入了新的实用功能Python00
Spark-Formalizer-7BSpark-Formalizer 是由科大讯飞团队开发的专用大型语言模型,专注于数学自动形式化任务。该模型擅长将自然语言数学问题转化为精确的 Lean4 形式化语句,在形式化语句生成方面达到了业界领先水平。Python00
GOT-OCR-2.0-hf阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00
项目优选
收起
deepin linux kernel
C
24
7
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
9
1
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
375
3.25 K
暂无简介
Dart
619
140
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
62
19
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.03 K
479
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
647
261
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.09 K
619
喝着茶写代码!最易用的自托管一站式代码托管平台,包含Git托管,代码审查,团队协作,软件包和CI/CD。
Go
23
0
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
790
76