@morojs/moro

@morojs/moro / AppDocumentationManager

Class: AppDocumentationManager

Defined in: src/core/docs/index.ts:144

Constructors

Constructor

new AppDocumentationManager(): AppDocumentationManager

Returns

AppDocumentationManager

Methods

enableDocs()

enableDocs(config, routingManager): void

Defined in: src/core/docs/index.ts:149

Parameters

config

DocsConfig

routingManager

IntelligentRoutingManager

Returns

void

getDocsJSON()

getDocsJSON(): string

Defined in: src/core/docs/index.ts:195

Returns

string

getDocsMiddleware()

getDocsMiddleware(): (req, res, next) => void

Defined in: src/core/docs/index.ts:165

Returns

(req, res, next): void

Parameters

req

HttpRequest

res

HttpResponse

next

() => void

Returns

void

getDocsYAML()

getDocsYAML(): string

Defined in: src/core/docs/index.ts:203

Returns

string

getOpenAPISpec()

getOpenAPISpec(): OpenAPISpec

Defined in: src/core/docs/index.ts:187

Returns

OpenAPISpec

refreshDocs()

refreshDocs(): void

Defined in: src/core/docs/index.ts:173

Returns

void