Class OpenApiService

Default open api service implementation of Zibri.

Implements

OpenApiServiceInterface

Index

Constructors

Properties

Methods

attachTo createOpenApiDefinition

Constructors

constructor

new OpenApiService(): OpenApiService
Returns OpenApiService
- Defined in src/open-api/open-api.service.ts:73

Properties

`Readonly`openApiRoute

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

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

Methods

attachTo

attachTo(app: ZibriApplication): Promise<void>
Attaches the service to the Zibri application.
Parameters
- app: ZibriApplication
Returns Promise<void>
Implementation of OpenApiServiceInterface.attachTo
- Defined in src/open-api/open-api.service.ts:80

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:152