koa2-swagger-ui/dist/index.d.ts

Swagger UI middleware for koa

import type { Middleware } from 'koa';
export interface SwaggerOptions {
    [key: string]: string | boolean | string[] | Record<string, unknown> | Array<Record<string, unknown>> | null | undefined;
    dom_id?: string;
    url?: string;
    urls?: Array<{
        url: string;
        name: string;
    }>;
    supportedSubmitMethods?: string[];
    docExpansion?: string;
    jsonEditor?: boolean;
    defaultModelRendering?: string;
    showRequestHeaders?: boolean;
    layout?: string;
    spec?: Record<string, unknown>;
    validatorUrl?: string | null;
}
export interface KoaSwaggerUiOptions {
    title: string;
    oauthOptions: boolean | any;
    swaggerOptions: SwaggerOptions;
    swaggerVersion: string;
    swaggerCdnUrl?: string;
    routePrefix: string | false;
    specPrefix: string;
    exposeSpec: boolean;
    hideTopbar: boolean;
    favicon: string;
    customCSS: string;
}
export declare function koaSwagger(config?: Partial<KoaSwaggerUiOptions>): Middleware;