Function convert

@vtx-labs/har2api — programmatic API.

Turn a browser .har capture into an OpenAPI 3.1 spec, a Postman collection, and cURL commands. Pure, offline, and dependency-free: it parses the HAR, infers endpoints (templating dynamic path segments), infers JSON Schemas from the bodies it saw, and redacts captured secrets before they reach any output.

Example

import { convert } from "@vtx-labs/har2api";
import { readFileSync } from "node:fs";

const { openapiYaml, postmanJson } = convert(readFileSync("capture.har", "utf8"));
console.log(openapiYaml);

convert(harJson: string, options?: ConvertOptions): ConvertResult
Convert a HAR document (JSON string) into an OpenAPI 3.1 spec, a Postman collection, and cURL commands.
Parameters
- harJson: string
- options: ConvertOptions = {}
Returns ConvertResult
Throws
HarParseError if the input is not a usable HAR document.
- Defined in src/convert.ts:46

Function convert

Example

Parameters

Returns ConvertResult

Throws

Settings