UNPKG

@sigiljs-community/openapi-plugin

Version:

Plugin for SigilJS framework, that automatically derives an OpenAPI JSON spec from your routes and serves it at a configurable endpoint

16 lines (15 loc) 576 B
import { OpenApiTransformerInfoOptions, OpenApiTransformerTransformOptions } from '@sigiljs/openapi-transformer'; import { SigilPlugin } from '@sigiljs/sigil'; export interface OpenApiPluginConfig { info?: Partial<OpenApiTransformerInfoOptions>; transform?: Partial<OpenApiTransformerTransformOptions>; path?: string | false; } export default class OpenApiPlugin extends SigilPlugin<OpenApiPluginConfig> { #private; static name: string; openApiDefinition: Record<string, any>; constructor(); onInitialize(): any; onUpdateCallback(): any; }