Class OpenAPIService

OpenAPI Service

Generates OpenAPI specifications with support for:

Runtime configuration via OpenAPIConfigService
Route filtering via hideFromDocs and custom routeFilter
i18n support for titles and descriptions
Security scheme definitions

Configuration is resolved per-request from OpenAPIConfigService, allowing middleware to override config based on domain context.

Index

Constructors

Methods

Constructors

constructor

new OpenAPIService(configService: IOpenAPIConfigService): OpenAPIService
Parameters
- configService: IOpenAPIConfigService
Returns OpenAPIService
- Defined in packages/core/src/openapi/services/openapi.service.ts:38

Methods

setupEndpoints

setupEndpoints(
app: OpenAPIHono<RouterEnv>,
controllers: Constructor<IController>[],
): void
Setup OpenAPI documentation endpoints
Parameters
- app: OpenAPIHono<RouterEnv>
- controllers: Constructor<IController>[]
Returns void
- Defined in packages/core/src/openapi/services/openapi.service.ts:46