TypeScript新手求助：如何在har-to-openapi中传入HAR文件？

前置准备 #

确保你的项目已完成以下配置：

• 初始化npm项目（未初始化的话执行）：npm init -y
• 安装依赖：

  npm install har-to-openapi --save-dev
  npm install typescript @types/node --save-dev
  

• 配置tsconfig.json（基础示例）：

  {
    "compilerOptions": {
      "target": "ES6",
      "module": "CommonJS",
      "strict": true,
      "esModuleInterop": true
    },
    "include": ["*.ts"]
  }
  

完整转换脚本示例 #

创建convert-har.ts文件，内容如下：

import { generateSpec } from 'har-to-openapi';
import * as fs from 'fs';

// 定义转换函数：接收HAR文件路径和输出文件路径
function convertHar(harPath: string, outputPath: string) {
  // 1. 读取本地HAR文件内容
  const harRawContent = fs.readFileSync(harPath, 'utf-8');
  
  // 2. 将HAR字符串解析为JSON对象（generateSpec需要JSON格式数据）
  const harJson = JSON.parse(harRawContent);
  
  // 3. 调用工具生成OpenAPI规范
  const openApiSpec = generateSpec(harJson);
  
  // 4. 将生成的规范写入本地文件
  fs.writeFileSync(outputPath, JSON.stringify(openApiSpec, null, 2));
  
  console.log(`转换完成！OpenAPI规范已保存到：${outputPath}`);
}

// 替换为你的本地HAR文件路径和期望的输出路径
convertHar('./api-recording.har', './openapi-spec.json');

运行脚本 #

直接用ts-node运行（无需提前编译）：

ts-node convert-har.ts

如果不想用ts-node，也可以先编译再运行：

tsc
node convert-har.js

关键说明 #

• generateSpec方法不直接接收文件路径，它需要的是解析后的HAR JSON对象，因此必须先读取文件内容并完成解析。
• 确保你的HAR文件是标准格式（可通过Chrome/F12网络面板导出），否则可能转换失败。
• 处理大文件建议用异步读取方式，示例如下：

import { generateSpec } from 'har-to-openapi';
import * as fs from 'fs/promises';

async function convertHarAsync(harPath: string, outputPath: string) {
  const harRawContent = await fs.readFile(harPath, 'utf-8');
  const harJson = JSON.parse(harRawContent);
  const openApiSpec = generateSpec(harJson);
  await fs.writeFile(outputPath, JSON.stringify(openApiSpec, null, 2));
  console.log(`异步转换完成！文件已保存到：${outputPath}`);
}

convertHarAsync('./api-recording.har', './openapi-spec.json');

内容的提问来源于stack exchange，提问作者Chris Hoina