swagger-auto-generate/dist/types/config.d.ts

Automatically generate Swagger JSDoc documentation for Express applications

export interface SwaggerAutoConfig {
    inputFolders: string[];
    outputFile: string;
    swaggerInfo: {
        title: string;
        version: string;
        description: string;
        host?: string;
        basePath?: string;
        schemes?: string[];
    };
    ignorePatterns?: string[];
    watchMode?: boolean;
    verbose?: boolean;
    autoGenerate?: boolean;
    swaggerUi?: {
        enabled: boolean;
        route: string;
        options?: any;
    };
}
export interface ExpressIntegrationConfig {
    app: any;
    swaggerConfig: SwaggerAutoConfig;
    autoSetup?: boolean;
}
export interface SwaggerJSDocOptions {
    definition: {
        openapi: string;
        info: {
            title: string;
            version: string;
            description: string;
            host?: string;
            basePath?: string;
            schemes?: string[];
        };
        servers?: Array<{
            url: string;
            description?: string;
        }>;
    };
    apis: string[];
}
export interface SwaggerUIExpressOptions {
    explorer?: boolean;
    customCss?: string;
    customCssUrl?: string;
    customJs?: string;
    customSiteTitle?: string;
    customfavIcon?: string;
    swaggerOptions?: {
        url?: string;
        urls?: Array<{
            url: string;
            name: string;
        }>;
        docExpansion?: 'list' | 'full' | 'none';
        filter?: string;
        showRequestHeaders?: boolean;
        showCommonExtensions?: boolean;
        tryItOutEnabled?: boolean;
        requestInterceptor?: (req: any) => any;
        responseInterceptor?: (res: any) => any;
    };
}
//# sourceMappingURL=config.d.ts.map