Orval项目中如何定制Fetch客户端的返回类型

在使用Orval生成API客户端代码时，开发者可能会遇到需要自定义返回类型结构的需求。特别是当使用Fetch客户端而非Axios时，默认生成的返回类型包含了响应数据和状态码两个字段，这有时并不符合项目的实际需求。

默认生成的类型结构

Orval默认会为Fetch客户端生成如下类型的响应结构：

export type userRigsListResponse = {
  data: PaginatedRigListUserListDTO;
  status: number;
};

这种结构包含了两个字段：

• data: 实际返回的数据内容
• status: HTTP响应状态码

自定义返回类型

在某些项目中，开发者可能希望直接返回数据本身，而不需要额外的响应状态码信息。Orval提供了配置选项来实现这一需求。

7.2.0版本的解决方案

在Orval 7.2.0版本中，可以通过特定的配置参数来修改返回类型，使其仅包含数据部分。

7.3.0版本的改进

在更新的7.3.0版本中，Orval引入了更明确的配置项includeHttpResponseReturnType。通过设置这个选项，开发者可以更直观地控制是否要在返回类型中包含HTTP响应信息。

实际应用建议

1. 明确需求：首先确定项目中是否需要HTTP状态码信息。如果前端错误处理完全依赖于返回数据中的错误码，则可以省略HTTP状态码。

2. 版本适配：根据项目使用的Orval版本选择合适的配置方式。

3. 类型安全：修改返回类型后，确保类型系统仍然能够正确捕获所有可能的响应情况。

4. 文档同步：团队内部应同步更新相关文档，说明API客户端的返回类型结构变化。

总结

Orval作为API客户端代码生成工具，提供了灵活的配置选项来满足不同项目的需求。通过合理配置返回类型，可以使生成的代码更符合项目的架构设计和开发习惯，同时保持类型系统的完整性和安全性。