Class SwaggerUtil

Index

Constructors

Methods

merge mergeConfig metaExtractor readMeta routeToSwaggerPath serveMeta writeMeta

Constructors

constructor

new SwaggerUtil(): SwaggerUtil
Returns SwaggerUtil

Methods

`Static`merge

merge(root: SwaggerConfig, data: MergeInputType[]): SwaggerConfig
Parameters
- root: SwaggerConfig
- data: MergeInputType[]
Returns SwaggerConfig
- Defined in SwaggerUtil.ts:192

`Static`mergeConfig

mergeConfig(root: SwaggerConfig, data: SwaggerConfig[]): SwaggerConfig
Parameters
- root: SwaggerConfig
- data: SwaggerConfig[]
Returns SwaggerConfig
- Defined in SwaggerUtil.ts:246

`Static`metaExtractor

metaExtractor(
    root: Object,
    npmPackageVersion: boolean,
    ...path: Object[],
): undefined | SwaggerConfig
Parameters
- root: Object
- npmPackageVersion: boolean
- ...path: Object[]
Returns undefined | SwaggerConfig
- Defined in SwaggerUtil.ts:62

`Static`readMeta

readMeta(path: string): any
Parameters
- path: string
Returns any
- Defined in SwaggerUtil.ts:36

`Static`routeToSwaggerPath

routeToSwaggerPath(route: RouteData): SwaggerRPath
Parameters
- route: RouteData
Returns SwaggerRPath
- Defined in SwaggerUtil.ts:99

`Static`serveMeta

serveMeta(
    conf: SwaggerConfig,
    port?: number,
    auth?: string,
): Promise<null | Server>
Parameters
- conf: SwaggerConfig
- Optionalport: number
- Optionalauth: string
Returns Promise<null | Server>
- Defined in SwaggerUtil.ts:45

`Static`writeMeta

writeMeta(conf: SwaggerConfig, kind: "JSON" | "YAML", path?: string): void
Parameters
- conf: SwaggerConfig
- kind: "JSON" | "YAML"
- Optionalpath: string
Returns void
- Defined in SwaggerUtil.ts:26