@saber2pr/nest-swagger-md

Index

Interfaces

Functions

Functions

Const createApiDocs

createApiDocs(document: OpenAPIObject, fileName?: string, opts?: ApiMarkdownDocsOpts & ApiRestClientOpts): Promise<void>

- Defined in index.ts:13
Parameters
- document: OpenAPIObject
- fileName: string = 'api'
- Optional opts: ApiMarkdownDocsOpts & ApiRestClientOpts
Returns Promise<void>

createApiMarkdownDocs

createApiMarkdownDocs(document: OpenAPIObject, outputFile?: string, opts?: ApiMarkdownDocsOpts): Promise<void>

- Defined in core/docs.ts:102
Parameters
- document: OpenAPIObject
- outputFile: string = ...
- Optional opts: ApiMarkdownDocsOpts
Returns Promise<void>

createApiRestClient

createApiRestClient(document: OpenAPIObject, outputFile?: string, opts?: ApiRestClientOpts): Promise<void>

- Defined in core/http.ts:88
Parameters
- document: OpenAPIObject
- outputFile: string = ...
- Optional opts: ApiRestClientOpts
Returns Promise<void>

default

default(document: OpenAPIObject, outputFile?: string, opts?: ApiMarkdownDocsOpts): Promise<void>

- Defined in core/docs.ts:102
Parameters
- document: OpenAPIObject
- outputFile: string = ...
- Optional opts: ApiMarkdownDocsOpts
Returns Promise<void>

Generated using TypeDoc