Interface OpenAPIModuleOptions

Static module configuration (provided via forRoot)

interface OpenAPIModuleOptions {
    docsPath?: string;
    info?: OpenAPIInfo;
    jsonPath?: string;
    securitySchemes?: Record<string, object>;
}

Properties

docsPath?: string

Path for Swagger UI docs (default: '/api/docs')

Default info section for spec

jsonPath?: string

Path for OpenAPI JSON spec (default: '/api/openapi.json')

securitySchemes?: Record<string, object>

Security schemes definition