在Orval项目中使用React Query与Fetch进行API交互

Orval是一个强大的OpenAPI客户端生成工具，它能够根据API规范自动生成类型安全的客户端代码。最新版本7.0中，Orval对React Query与Fetch的集成提供了更好的支持，使得开发者可以更灵活地选择HTTP客户端。

React Query与Fetch集成的背景

传统上，许多React项目使用Axios作为HTTP客户端，但随着现代浏览器对Fetch API的全面支持，越来越多的开发者希望使用更轻量级的Fetch方案。Orval 7.0版本通过引入httpClient: 'fetch'配置选项，简化了这一集成过程。

配置方法

在Orval配置文件中，开发者现在可以明确指定使用Fetch作为HTTP客户端：

output: {
  target: 'src/generated',
  schemas: 'src/generated',
  client: 'react-query',
  httpClient: 'fetch',
  mode: 'tags-split',
  // 其他配置...
}

这一配置会生成专门针对Fetch优化的React Query hooks，避免了之前版本中需要手动处理类型不匹配的问题。

自定义Fetch实现

对于需要特殊处理的场景，Orval仍然支持自定义Fetch实现。开发者可以提供自己的Fetch封装函数，只需确保其签名与标准Fetch兼容：

export const customFetch = async <T>(
  config: {
    url: string
    method: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH'
    data?: BodyInit
    params?: Record<string, unknown>
  },
  options?: RequestInit
): Promise<T> => {
  // 自定义实现逻辑
}

生成代码的变化

7.0版本生成的代码更加简洁和类型安全。例如，对于创建Todo的API，生成的hook会正确处理Fetch的参数格式：

export const createNewTodo = (options?: RequestInit) => {
  return customFetch<ApiResponse>('/v1/todo', {
    method: 'POST',
    ...options
  })
}

最佳实践

1. 错误处理：在自定义Fetch实现中加入统一的错误处理逻辑
2. 请求拦截：利用Fetch的拦截器特性实现认证、日志等功能
3. 类型安全：确保自定义Fetch实现保持完整的类型推断
4. 性能优化：考虑添加请求缓存、取消等高级功能

Orval 7.0的这些改进使得React Query与Fetch的集成更加无缝，为开发者提供了更多选择自由，同时保持了类型安全和开发体验的一致性。