@har-sdk/editor

Parses OAS and Postman API specification files into form of tree with endpoints and parameters as leaves; tree is useful for GUI representation of specification parameters

Each node and parameter value have JSON pointer, that could be used to change parameter value or to remove node.

Setup

``bash
npm i --save @har-sdk/editor
`

Usage

`ts
import { OasV3Editor, SpecTreeNode } from '@har-sdk/editor';

const openApiEditor = new OasV3Editor();
openApiEditor.setup(jsonOrYamlSourceString).then(() => {
// tree parsing
let tree: SpecTreeNode = openApiEditor.parse();

// setting/updating parameter value
tree = openApiEditor.setParameterValue(
// parameter valueJsonPointer is pointer to example for oas3 and default for oas2;
// referenced parameter will be dereferenced automatically
tree.parameters[0].valueJsonPointer,
someNewValue
);

// removing specific node
tree = openApiEditor.removeNode(tree.children[1].jsonPointer);

// serialization
const serializedUpdatedSpec = openApiEditor.stringify();
});
`

API

$3

- OasV2Editor
- OasV3Editor
- PostmanEditor

All of them implement both TreeParser and Editor interfaces.

$3

`ts
export interface TreeParser {
setup(source: string): Promise;
parse(): SpecTreeNode;
stringify(): string;
}

export interface Editor {
setParameterValue(jsonPointer: string, value: any): SpecTreeNode;
removeNode(jsonPointer: string): SpecTreeNode;
}
`

$3

`ts
export interface SpecTreeNode {
readonly path: string;
readonly name?: string;
readonly method?: HttpMethod;
readonly jsonPointer: string;
readonly children?: ReadonlyArray;
readonly parameters?: ReadonlyArray;
}

export interface SpecTreeNodeParam {
readonly paramType: 'location' | 'requestBody' | 'variable';
readonly value?: any;
readonly valueJsonPointer: string;
}

// Specific parameter types with specific properties

export interface SpecTreeNodeVariableParam extends SpecTreeNodeParam {
readonly paramType: 'variable';
readonly name: string;
}

export interface SpecTreeNodeLocationParam extends SpecTreeNodeParam {
readonly paramType: 'location';
readonly name: string;
readonly location: ParamLocation;
}

export interface SpecTreeRequestBodyParam extends SpecTreeNodeParam {
readonly paramType: 'requestBody';
readonly bodyType: string;
}

// Enums

export enum ParamLocation {
PATH = 'path',
QUERY = 'query',
HEADER = 'header',
BODY = 'body'
}

export enum HttpMethod {
GET = 'GET',
PUT = 'PUT',
POST = 'POST',
DELETE = 'DELETE',
OPTIONS = 'OPTIONS',
HEAD = 'HEAD',
PATCH = 'PATCH',
TRACE = 'TRACE'
}
``