Class OpenApiGenerator

Index

Constructors

Methods

buildOpenApiSpec exportOpenApiSpec

Constructors

constructor

new OpenApiGenerator(
    appConfig: AppConfig,
    middlewareRegistry: MiddlewareRegistry,
    logFactory: LogFactory,
): OpenApiGenerator
Parameters
- appConfig: AppConfig
- middlewareRegistry: MiddlewareRegistry
- logFactory: LogFactory
Returns OpenApiGenerator
- Defined in src/api/open-api/OpenApiGenerator.ts:101

Methods

buildOpenApiSpec

buildOpenApiSpec(): OpenAPIObject
Returns OpenAPIObject
- Defined in src/api/open-api/OpenApiGenerator.ts:110

exportOpenApiSpec

exportOpenApiSpec(format?: OpenApiFormat): Promise<string>
Parameters
- format: OpenApiFormat = "json"
Returns Promise<string>
- Defined in src/api/open-api/OpenApiGenerator.ts:117