HeyAPI OpenAPI-TS 中查询参数类型安全性的改进建议

在 TypeScript API 客户端开发中，类型安全是保证代码质量的重要环节。本文探讨了 HeyAPI 的 OpenAPI-TS 工具在处理查询参数和请求体类型时存在的一个类型安全问题，并提出了改进建议。

当前问题分析

OpenAPI-TS 目前生成的类型定义中，查询参数和未定义的请求体会被赋予 Record<string, unknown> 类型。这种处理方式虽然灵活，但会带来类型安全问题：

1. 当 API 规范中没有定义任何查询参数时，理想情况下应该使用 never 类型，而不是允许任意键值对
2. 当 API 规范明确定义了查询参数时，应该严格限制为规范定义的结构，而不是允许额外属性
3. 同样的问题也出现在未定义的请求体上，应该使用 never 而非 Record<string, unknown>

问题影响

这种宽松的类型定义会导致以下问题：

• 开发者在修改 API 规范后，编译器不会捕获到不兼容的查询参数使用
• 代码中可能意外传递了未定义的参数，而不会得到类型检查的警告
• 降低了类型系统对 API 契约的保障能力

解决方案建议

建议进行以下改进：

1. 当 OpenAPI 规范中没有定义查询参数时，生成 never 类型
2. 当定义了查询参数时，只允许规范中明确定义的结构
3. 对请求体采用同样的严格类型策略
4. 考虑添加 --use-never 配置选项，让开发者可以选择启用严格的类型检查

实现考量

这种改进需要平衡以下因素：

• 类型安全性 vs 开发便利性
• 向后兼容性
• 与现有代码库的集成

建议可以通过渐进式的方式引入这些改进，先作为可选配置，再逐步成为默认行为。

总结

严格的类型定义是 TypeScript 的核心价值之一。通过改进 OpenAPI-TS 生成的查询参数和请求体类型，可以显著提高 API 客户端代码的类型安全性，帮助开发者在编译时捕获更多潜在错误，提升代码质量。