swagger-auto-generate/dist/types/index.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;
}
export interface RouteInfo {
    method: string;
    path: string;
    functionName: string;
    parameters: ParameterInfo[];
    responses: ResponseInfo[];
    tags?: string[];
    summary?: string;
    description?: string;
    filePath: string;
    lineNumber: number;
}
export interface ParameterInfo {
    name: string;
    in: 'path' | 'query' | 'header' | 'body';
    required: boolean;
    type: string;
    description?: string;
    schema?: any;
}
export interface ResponseInfo {
    code: string;
    description: string;
    schema?: any;
}
export interface ParsedFunction {
    name: string;
    parameters: string[];
    body: string;
    lineNumber: number;
    isRouteHandler: boolean;
    httpMethod?: string;
    routePath?: string;
}
export interface ASTNode {
    type: string;
    start: number;
    end: number;
    body?: ASTNode[];
    expression?: ASTNode;
    declarations?: ASTNode[];
    id?: ASTNode;
    name?: string;
    params?: ASTNode[];
    value?: any;
    key?: ASTNode;
    property?: ASTNode;
    object?: ASTNode;
    arguments?: ASTNode[];
    callee?: ASTNode;
    [key: string]: any;
}
export interface JSDocComment {
    description: string;
    tags: JSDocTag[];
}
export interface JSDocTag {
    name: string;
    description: string;
    type?: string;
    optional?: boolean;
}
export * from './config';
//# sourceMappingURL=index.d.ts.map