Orval项目中如何处理DELETE请求的204 No Content响应问题

问题背景

在使用Orval生成API客户端代码时，开发者可能会遇到一个常见问题：当API规范中定义了DELETE操作返回204 No Content状态码时，生成的fetch客户端代码仍会尝试解析响应体为JSON，导致运行时错误。

问题分析

根据OpenAPI规范，DELETE操作通常会返回204状态码表示成功删除且没有返回内容。然而Orval默认生成的fetch客户端代码会无条件地对所有响应执行res.json()调用，这在响应体为空时会导致SyntaxError: Unexpected end of JSON input错误。

解决方案

1. 自定义fetch实现

最可靠的解决方案是创建自定义fetch函数，正确处理各种响应情况：

const getBody = async <T>(response: Response): Promise<T> => {
  const text = await response.text();
  
  if (!text) {
    return {} as T;
  }

  const contentType = response.headers.get("content-type");
  
  if (contentType?.includes("application/json")) {
    return JSON.parse(text);
  }

  return text as unknown as T;
};

export const customFetch = async <T>(
  url: string,
  options: RequestInit,
): Promise<T> => {
  const request = new Request(url, options);
  const response = await fetch(request);
  const data = await getBody<T>(response);

  return { status: response.status, data } as T;
};

2. Orval配置调整

在Orval配置文件中指定使用自定义fetch函数：

{
  output: {
    client: 'fetch',
    override: {
      fetch: {
        custom: './path/to/custom-fetch.ts'
      }
    }
  }
}

最佳实践建议

1. 响应处理一致性：确保API设计遵循RESTful原则，204响应确实不应该包含响应体。

2. 错误处理：在自定义fetch中添加适当的错误处理逻辑，考虑网络错误、超时等情况。

3. 类型安全：为自定义fetch函数添加完善的TypeScript类型定义，确保生成的代码类型安全。

4. 测试覆盖：为各种响应情况（空响应、JSON响应、非JSON响应）编写测试用例。

总结

Orval作为API客户端代码生成工具，默认行为可能无法覆盖所有边缘情况。通过自定义fetch实现，开发者可以灵活处理各种API响应模式，特别是对于204 No Content这类特殊响应。这种方法不仅解决了当前问题，还为未来可能遇到的其他响应处理需求提供了扩展性。

对于团队项目，建议将这种自定义fetch实现作为共享基础设施的一部分，确保所有生成的前端API客户端代码具有一致的行为和错误处理机制。