Skip to main content

Class: OpenApiDocumentGenerator

A generator for creating OpenAPI document definitions based on route definitions and metadata.

Implements​

Constructors​

Constructor​

new OpenApiDocumentGenerator(options, parameterGenerator): OpenApiDocumentGenerator

Parameters​

options​

OpenApiPluginOptions

parameterGenerator​

ParameterGenerator

Returns​

OpenApiDocumentGenerator

Methods​

generate()​

generate(routes): OpenApiDocumentDefinition

Generates an OpenAPI document definition based on the provided route definitions.

Parameters​

routes​

readonly RouteDefinition[]

An array of route definitions for which to generate OpenAPI documentation.

Returns​

OpenApiDocumentDefinition

An OpenApiDocumentDefinition instance representing the generated OpenAPI document.

Implementation of​

Generator.generate

extractTypeFromMetadata()​

static extractTypeFromMetadata(target, propertyKey, parameterIndex?): "string" | "number" | "boolean" | ClassType | "array"

Parameters​

target​

ClassType

propertyKey​

string | symbol

parameterIndex?​

number

Returns​

"string" | "number" | "boolean" | ClassType | "array"