@morojs/moro

@morojs/moro / DocumentationSystem

Class: DocumentationSystem

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

Constructors

Constructor

new DocumentationSystem(config): DocumentationSystem

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

Parameters

config

DocsConfig

Returns

DocumentationSystem

Methods

createMiddleware()

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

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

Returns

(req, res, next) => void

generateFromRoutes()

generateFromRoutes(routes): OpenAPISpec

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

Parameters

routes

CompiledRoute[]

Returns

OpenAPISpec

getOpenAPIJSON()

getOpenAPIJSON(): string

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

Returns

string

getOpenAPIYAML()

getOpenAPIYAML(): string

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

Returns

string

getSpec()

getSpec(): OpenAPISpec

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

Returns

OpenAPISpec

updateConfig()

updateConfig(newConfig): void

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

Parameters

newConfig

Partial<DocsConfig>

Returns

void