@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:99

Returns

(req, res, next): void

Parameters

req

HttpRequest

res

HttpResponse

next

() => void

Returns

void

generateFromRoutes()

generateFromRoutes(routes): OpenAPISpec

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

Parameters

routes

CompiledRoute[]

Returns

OpenAPISpec

getOpenAPIJSON()

getOpenAPIJSON(): string

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

Returns

string

getOpenAPIYAML()

getOpenAPIYAML(): string

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

Returns

string

getSpec()

getSpec(): OpenAPISpec

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

Returns

OpenAPISpec

updateConfig()

updateConfig(newConfig): void

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

Parameters

newConfig

Partial<DocsConfig>

Returns

void