Interface OpenApiServiceInterface

Interface for an open api service.

interface OpenApiServiceInterface {
    attachTo: (app: ZibriApplication) => void | Promise<void>;
    createOpenApiDefinition: (
        app: ZibriApplication,
    ) => OpenAPIObject | Promise<OpenAPIObject>;
    openApiRoute: `/${string}`;
}

Properties

attachTo: (app: ZibriApplication) => void | Promise<void>

Attaches the service to the Zibri application.

createOpenApiDefinition: (
app: ZibriApplication,
) => OpenAPIObject | Promise<OpenAPIObject>

Creates the open api definition.

openApiRoute: `/${string}`

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