Hey API 客户端生成中相对路径服务器地址的处理问题

在基于 OpenAPI 规范的前端开发中，自动生成 API 客户端是一个常见的需求。Hey API 的 openapi-ts 项目提供了从 OpenAPI 规范生成 TypeScript 客户端代码的能力，但在处理服务器(servers)配置中的相对路径时存在一个需要注意的问题。

问题背景

当 OpenAPI 规范中 servers.url 使用完整 URL(如 https://example.com/api)时，生成的客户端代码会正确包含 baseUrl 配置，API 请求会发送到正确的完整地址。但当 servers.url 使用相对路径(如 /api/v3)时，生成的客户端代码会丢失 baseUrl 配置，导致请求发送到当前域名的根路径，而非预期的相对路径。

技术细节分析

OpenAPI 3.0 规范允许 servers.url 使用两种形式：

1. 完整 URL：包含协议和域名的完整地址
2. 相对路径：以斜杠开头的路径部分

Hey API 的客户端生成器目前仅对完整 URL 形式的 servers.url 生成 baseUrl 配置，而对相对路径形式则忽略。这会导致以下问题：

1. 生成的 types.gen.ts 文件虽然包含 ClientOptions 类型定义，但没有提供实际的 baseUrl 值
2. client.gen.ts 中的 createConfig 调用缺少 baseUrl 参数
3. 最终 API 请求会直接使用路径部分，忽略 servers.url 中定义的相对路径前缀

解决方案建议

理想的实现方式应该是：

1. 无论 servers.url 是完整 URL 还是相对路径，都应生成对应的 baseUrl 配置
2. 对于相对路径，baseUrl 应直接使用该路径值
3. 生成的 client.gen.ts 应自动包含 baseUrl 配置

具体实现可参考以下代码结构：

// types.gen.ts
export type ClientOptions = {
  baseUrl: string;
};

export const baseUrl = "/api/privat/forsikring/betaling";  // 直接从 servers.url 获取

// client.gen.ts
import { baseUrl } from './types.gen';

export const client = createClient(createClientConfig(createConfig<ClientOptions>({ baseUrl })));

实际影响

这个问题会影响以下场景的开发：

1. 多环境部署：当 API 需要在不同域名下运行时，使用相对路径更灵活
2. 代理配置：前端应用通过反向代理访问 API 时，相对路径更易配置
3. 本地开发：开发环境可能使用与生产环境不同的域名

最佳实践建议

在等待官方修复的同时，开发者可以采用以下临时解决方案：

1. 在 OpenAPI 规范中使用完整 URL，并通过环境变量管理不同环境的域名
2. 创建客户端配置覆盖文件，手动添加 baseUrl
3. 在应用初始化时动态设置客户端配置

总结

正确处理 OpenAPI 规范中的 servers.url 配置对于生成可靠的 API 客户端至关重要。Hey API 的 openapi-ts 项目目前对相对路径的支持存在不足，开发者需要特别注意这个问题。理解这一限制并采取适当的应对措施，可以确保生成的客户端代码在不同环境下都能正确工作。