Class OpenApiService

Default open api service implementation of Zibri.

Implements

Index

Constructors

Properties

Methods

createOpenApiDefinition onAppInit

Constructors

constructor

new OpenApiService(
    logger: LoggerInterface,
    assetService: AssetServiceInterface,
    authService: AuthServiceInterface,
    router: RouterInterface,
): OpenApiService
Parameters
- logger: LoggerInterface
- assetService: AssetServiceInterface
- authService: AuthServiceInterface
- router: RouterInterface
Returns OpenApiService
- Defined in src/open-api/open-api.service.ts:92

Properties

`Readonly`openApiRoute

openApiRoute: `/${string}` = '/explorer'

The route where the open api explorer should be reached under.

Methods

createOpenApiDefinition

createOpenApiDefinition(app: ZibriApplication): Promise<OpenAPIObject>
Creates the open api definition.
Parameters
- app: ZibriApplication
Returns Promise<OpenAPIObject>
Implementation of OpenApiServiceInterface.createOpenApiDefinition
- Defined in src/open-api/open-api.service.ts:286

onAppInit

onAppInit(app: ZibriApplication): Promise<void>
Runs when the app initializes.
Parameters
- app: ZibriApplication
Returns Promise<void>
Implementation of OnAppInit.onAppInit
- Defined in src/open-api/open-api.service.ts:104