Interface ConvertResult

Everything produced from one HAR file.

interface ConvertResult {
    curl: string;
    model: ApiModel;
    openapi: OpenApiDoc;
    openapiJson: string;
    openapiYaml: string;
    postman: PostmanCollection;
    postmanJson: string;
}

Properties

curl: string

cURL commands, one block per operation.

The intermediate API model — useful for custom emitters.

openapi: OpenApiDoc

OpenAPI 3.1 document (object form).

openapiJson: string

OpenAPI 3.1 as a pretty-printed JSON string.

openapiYaml: string

OpenAPI 3.1 as a YAML string.

postman: PostmanCollection

Postman Collection v2.1 (object form).

postmanJson: string

Postman Collection v2.1 as a pretty-printed JSON string.