Class Postman

Postman collection generator.

Note

For now it is not possible to only send files outside of object property (multipart). Well, at least not tried yet but it definitely doesn't work with alternatives

Implements

DocGenerator

Constructors

constructor

new Postman(
helperClass?: new (args: unknown) => PostmanHelperInterface,
): Postman
Parameters
- helperClass: new (args: unknown) => PostmanHelperInterface = PostmanJoiHelper
Returns Postman
- Defined in generators/postman.ts:111

Methods

add

add(routes: RouteMeta[]): ProcessedRoute[]

Parameters

routes: RouteMeta[]

Returns ProcessedRoute[]

The added/updated routes

Example

import routing from '@novice1/routing';
import { Postman } from '@novice1/api-doc-generator';

const router = routing().post(...);
const postman = new Postman();
const routes = postman.add(router.getMeta());
const { path, method, schema } = routes[0];

add(routes: RouteMeta): ProcessedRoute[]

Parameters

routes: RouteMeta

Returns ProcessedRoute[]

The added/updated routes

Example

import routing from '@novice1/routing';
import { Postman } from '@novice1/api-doc-generator';

const router = routing().post(...);
const postman = new Postman();
const routes = postman.add(router.getMeta());
const { path, method, schema } = routes[0];

addEvent

addEvent(event: EventObject): Postman
Parameters
- event: EventObject
Returns Postman
- Defined in generators/postman.ts:271

addFolder

addFolder(name: string): Postman
Parameters
- name: string
Returns Postman
- Defined in generators/postman.ts:337
addFolder(folder: Folder): Postman
Parameters
- folder: Folder
Returns Postman
- Defined in generators/postman.ts:338

addFolders

addFolders(name: string): Postman
Parameters
- name: string
Returns Postman
- Defined in generators/postman.ts:348
addFolders(folder: Folder): Postman
Parameters
- folder: Folder
Returns Postman
- Defined in generators/postman.ts:349
addFolders(folders: Folder[]): Postman
Parameters
- folders: Folder[]
Returns Postman
- Defined in generators/postman.ts:350

addHost

addHost(host: string): Postman
Parameters
- host: string
Returns Postman
- Defined in generators/postman.ts:181

addVariable

addVariable(variable: Variable): Postman
Parameters
- variable: Variable
Returns Postman
- Defined in generators/postman.ts:254

getAuth

getAuth(): undefined | null | Auth
Returns undefined | null | Auth
- Defined in generators/postman.ts:315

getConsumes

getConsumes(): string[]
Returns string[]
- Defined in generators/postman.ts:162

getDefaultSecurity

getDefaultSecurity(): undefined | Auth
Returns undefined | Auth
- Defined in generators/postman.ts:415

getDescription

getDescription(): undefined | Description
Returns undefined | Description
- Defined in generators/postman.ts:223

getEventList

getEventList(): undefined | EventObject[]
Returns undefined | EventObject[]
- Defined in generators/postman.ts:267

getFolders

getFolders(): Folder[]
Returns Folder[]
- Defined in generators/postman.ts:333

getGenerateFoldersRule

getGenerateFoldersRule(): GenerateFoldersRule
Returns GenerateFoldersRule
- Defined in generators/postman.ts:144

getHost

getHost(): string[]
Returns string[]
- Defined in generators/postman.ts:177

getInfo

getInfo(): InfoObject
Returns InfoObject
- Defined in generators/postman.ts:191

getName

getName(): string
Returns string
- Defined in generators/postman.ts:205

getPostmanId

getPostmanId(): undefined | string
Returns undefined | string
- Defined in generators/postman.ts:214

getProtocolProfileBehavior

getProtocolProfileBehavior(): unknown
Returns unknown
- Defined in generators/postman.ts:324

getResponsesProperty

getResponsesProperty(): undefined | string
Returns undefined | string
- Defined in generators/postman.ts:153

getSchema

getSchema(): string
Returns string
- Defined in generators/postman.ts:241

getVariableList

getVariableList(): undefined | Variable[]
Returns undefined | Variable[]
- Defined in generators/postman.ts:250

getVersion

getVersion(): undefined | string | CollectionVersion
Returns undefined | string | CollectionVersion
- Defined in generators/postman.ts:232

removeAll

removeAll(): ProcessedRoute[]
remove all routes

Returns ProcessedRoute[]
The removed routes
- Defined in generators/postman.ts:516

removeDefaultSecurity

removeDefaultSecurity(): undefined | Auth
Returns undefined | Auth
- Defined in generators/postman.ts:419

result

result(): PostmanCollection
Returns PostmanCollection
Implementation of DocGenerator.result
- Defined in generators/postman.ts:1304

setAuth

setAuth(auth: null | Auth): Postman
Example:
```
postman.setAuth({
 type: 'basic',
 basic: []
});
```
Parameters
- auth: null | Auth
Returns Postman
- Defined in generators/postman.ts:288
setAuth(type: string, auth?: AuthAttribute[]): Postman
Example:
```
postman.setAuth('basic', []);
```
Parameters
- type: string
- Optionalauth: AuthAttribute[]
Returns Postman
- Defined in generators/postman.ts:295
setAuth(auth: BasePostmanAuthUtil): Postman

Example:

import {
  BasicAuthUtil
} from '@novice1/api-doc-generator';

const basicAuth = new BasicAuthUtil('basicAuth');

postman.setAuth(basicAuth);

Parameters

auth: BasePostmanAuthUtil

Returns Postman

setConsumes

setConsumes(consumes: string[]): Postman
Parameters
- consumes: string[]
Returns Postman
- Defined in generators/postman.ts:157

setDefaultSecurity

setDefaultSecurity(auth: BasePostmanAuthUtil): Postman

Example:

import {
  BasicAuthUtil
} from '@novice1/api-doc-generator';

const basicAuth = new BasicAuthUtil('basicAuthName');

postman.setDefaultSecurity(basicAuth);

Parameters

auth: BasePostmanAuthUtil

Returns Postman

setDefaultSecurity(auth: Auth): Postman
Example:
```
postman.setDefaultSecurity({
 type: 'basic',
 basic: []
});
```
Parameters
- auth: Auth
Returns Postman
- Defined in generators/postman.ts:387
setDefaultSecurity(type: string): Postman
Example:
```
postman.setDefaultSecurity('basic');
```
Parameters
- type: string
Returns Postman
- Defined in generators/postman.ts:394

setDescription

setDescription(description: Description): Postman
Parameters
- description: Description
Returns Postman
- Defined in generators/postman.ts:218

setEventList

setEventList(eventList: EventObject[]): Postman
Parameters
- eventList: EventObject[]
Returns Postman
- Defined in generators/postman.ts:262

setFolders

setFolders(folders: Folder[]): Postman
Parameters
- folders: Folder[]
Returns Postman
- Defined in generators/postman.ts:328

setGenerateFoldersRule

setGenerateFoldersRule(v: GenerateFoldersRule): Postman
Parameters
- v: GenerateFoldersRule
Returns Postman
- Defined in generators/postman.ts:136

setHost

setHost(host: string): Postman
Parameters
- host: string
Returns Postman
- Defined in generators/postman.ts:166
setHost(host: string[]): Postman
Parameters
- host: string[]
Returns Postman
- Defined in generators/postman.ts:167

setInfo

setInfo(info: InfoObject): Postman
Parameters
- info: InfoObject
Returns Postman
- Defined in generators/postman.ts:186

setInfoProperty

setInfoProperty(prop: string, v: unknown): Postman
Parameters
- prop: string
- v: unknown
Returns Postman
- Defined in generators/postman.ts:195

setName

setName(name: string): Postman
Parameters
- name: string
Returns Postman
- Defined in generators/postman.ts:200

setPostmanId

setPostmanId(postmanId: string): Postman
Parameters
- postmanId: string
Returns Postman
- Defined in generators/postman.ts:209

setProtocolProfileBehavior

setProtocolProfileBehavior(protocolProfileBehavior: unknown): Postman
Parameters
- protocolProfileBehavior: unknown
Returns Postman
- Defined in generators/postman.ts:319

setResponsesProperty

setResponsesProperty(v: string): Postman
Parameters
- v: string
Returns Postman
- Defined in generators/postman.ts:148

setSchema

setSchema(schema: string): Postman
Parameters
- schema: string
Returns Postman
- Defined in generators/postman.ts:236

setVariableList

setVariableList(variableList: Variable[]): Postman
Parameters
- variableList: Variable[]
Returns Postman
- Defined in generators/postman.ts:245

setVersion

setVersion(version: undefined | string | CollectionVersion): Postman
Parameters
- version: undefined | string | CollectionVersion
Returns Postman
- Defined in generators/postman.ts:227

Class Postman

Note

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Postman

Methods

add

Parameters

Returns ProcessedRoute[]

Example

Parameters

Returns ProcessedRoute[]

Example

addEvent

Parameters

Returns Postman

addFolder

Parameters

Returns Postman

Parameters

Returns Postman

addFolders

Parameters

Returns Postman

Parameters

Returns Postman

Parameters

Returns Postman

addHost

Parameters

Returns Postman

addVariable

Parameters

Returns Postman

getAuth

Returns undefined | null | Auth

getConsumes

Returns string[]

getDefaultSecurity

Returns undefined | Auth

getDescription

Returns undefined | Description

getEventList

Returns undefined | EventObject[]

getFolders

Returns Folder[]

getGenerateFoldersRule

Returns GenerateFoldersRule

getHost

Returns string[]

getInfo

Returns InfoObject

getName

Returns string

getPostmanId

Returns undefined | string

getProtocolProfileBehavior

Returns unknown

getResponsesProperty

Returns undefined | string

getSchema

Returns string

getVariableList

Returns undefined | Variable[]

getVersion

Returns undefined | string | CollectionVersion

removeAll

Returns ProcessedRoute[]

removeDefaultSecurity

Returns undefined | Auth

result

Returns PostmanCollection

setAuth

Parameters

Returns Postman