swagger-auto-generate
Version:
Automatically generate Swagger JSDoc documentation for Express applications
28 lines • 761 B
TypeScript
import { RouteInfo } from '../types';
export declare class JSDocGenerator {
/**
* Generate JSDoc comment for a route
*/
static generateJSDoc(route: RouteInfo): string;
/**
* Generate Swagger tag content
*/
private static generateSwaggerTag;
/**
* Format JSDoc comment
*/
private static formatJSDoc;
/**
* Generate complete Swagger specification
*/
static generateSwaggerSpec(routes: RouteInfo[], config: any): any;
/**
* Generate model definitions
*/
private static generateDefinitions;
/**
* Inject JSDoc into source code
*/
static injectJSDoc(sourceCode: string, route: RouteInfo, jsdoc: string): string;
}
//# sourceMappingURL=jsdocGenerator.d.ts.map