Hey-API OpenAPI-TS 项目中内联规范加载问题的技术分析

问题背景

在 Node.js 环境中使用 Hey-API 的 OpenAPI-TS 工具时，开发者可能会遇到一个令人困惑的问题：当尝试以内联对象形式直接传递 OpenAPI 规范时，系统会错误地尝试读取当前工作目录而非使用提供的规范对象。这一行为导致了 EISDIR 错误，表明系统正在非法地对目录执行读取操作。

问题表现

具体表现为，当开发者使用以下代码结构时：

createClient({
  input: { openapi: '3.0.3', info: ... }, // 内联OpenAPI规范对象
  output: 'out',
  dryRun: true,
  plugins: ['@hey-api/client-fetch'],
});

系统会抛出错误信息：

🔥 Unexpected error occurred. Error opening file "/path/to/my/project" 
EISDIR: illegal operation on a directory, read

有趣的是，这个问题在浏览器环境中不会出现，因为浏览器环境下有完全不同的文件系统访问机制。

技术原因分析

经过深入调查，这个问题源于工具在 Node.js 环境下对输入参数的处理逻辑存在缺陷。当接收到输入参数时，工具未能正确区分文件路径和内联对象两种不同的输入形式，错误地将所有输入都当作文件路径处理。

在 Node.js 环境中，工具尝试将输入参数作为文件路径解析，当发现输入不是字符串而是对象时，它没有执行适当的类型检查，而是默认回退到当前工作目录的路径，导致了目录读取错误。

解决方案

开发团队已经识别并修复了这个问题。修复方案主要包括：

1. 增强输入参数的类型检查机制，明确区分文件路径和内联对象两种输入形式
2. 在 Node.js 环境中添加专门的逻辑处理内联对象输入
3. 确保在不同运行环境下（Node.js 和浏览器）行为的一致性

临时解决方案

在官方修复发布前，开发者可以采用以下临时解决方案：

1. 将内联规范写入临时文件，然后通过文件路径引用
2. 在 Node.js 环境中模拟浏览器环境（不推荐用于生产环境）：

// 临时模拟浏览器环境
global.window = {};
global.location = { href: 'https://some-website/' };

最佳实践建议

1. 对于生产环境，建议始终通过文件路径引用 OpenAPI 规范
2. 如果必须使用内联对象，确保使用最新版本的 Hey-API OpenAPI-TS 工具
3. 在 CI/CD 环境中特别注意这个问题，因为它可能导致构建失败

总结

这个问题展示了环境差异对工具行为的影响，也提醒我们在开发跨环境工具时需要特别注意文件系统访问等环境相关操作。Hey-API 团队已经迅速响应并修复了这个问题，体现了对开发者体验的重视。