Orval项目中Fetch客户端响应类型的优化实践

背景介绍

在Orval 7.0.0版本中，Fetch客户端返回的响应对象默认包含两个字段：data和status。这种设计虽然提供了HTTP状态信息，但在实际开发中却带来了使用上的不便。开发者需要访问response.data.data才能获取到真正的业务数据，这种嵌套结构增加了代码复杂度，降低了开发体验。

问题分析

Orval生成的类型定义默认如下：

export type getUserBloggerInfoResponse = {
  data: GetUserBloggerInfoResponse;
  status: number;
};

而开发者期望的类型定义是：

export type getUserBloggerInfoResponse = GetUserBloggerInfoResponse;

这种设计差异源于Orval Fetch客户端的设计理念，它为了便于应用处理HTTP状态，强制在响应中包含了HTTP状态信息。当与Tanstack Query客户端结合使用时，这种类型定义会被继承，导致开发者必须处理额外的嵌套结构。

解决方案

Orval团队听取了社区反馈，在最新版本中引入了新的配置选项来解决这个问题。开发者现在可以通过配置选择返回原始定义的返回类型，而不是包含状态信息的包装对象。

配置方式

在orval.config.js文件中，可以添加如下配置：

module.exports = {
  // 其他配置...
  fetch: {
    returnData: true // 设置为true将只返回数据部分
  }
}

这个配置项returnData允许开发者控制返回类型：

• 当设置为true时，直接返回API定义的响应数据类型
• 当设置为false(默认值)时，返回包含data和status的包装对象

技术实现原理

在底层实现上，Orval通过修改代码生成逻辑来适配这一变化。当returnData选项启用时，生成器会：

1. 跳过响应包装层的类型定义
2. 直接使用API规范中定义的响应类型
3. 调整客户端代码，确保返回值的类型与定义一致

这种实现方式既保持了向后兼容性，又为开发者提供了更简洁的API访问方式。

最佳实践建议

1. 新项目：建议启用returnData选项，以获得更简洁的API访问体验
2. 现有项目：如果已经基于包装对象开发，需要评估修改成本
3. 状态信息需求：如果确实需要HTTP状态信息，可以保持默认配置或通过错误处理机制获取

总结

Orval团队通过这个改进展示了他们对开发者体验的重视。这种灵活的配置方式既满足了需要原始数据的开发者，也保留了获取HTTP状态信息的能力。这种设计思路值得其他API工具开发者借鉴，它体现了在框架设计和开发者便利性之间寻找平衡的重要性。

对于使用Orval的开发者来说，现在可以根据项目需求选择最适合的响应类型处理方式，从而编写出更简洁、更易维护的代码。