apx-toolkit
Version:
Automatically discover APIs and generate complete integration packages: code in 12 languages, TypeScript types, test suites, SDK packages, API documentation, mock servers, performance reports, and contract tests. Saves 2-4 weeks of work in seconds.
28 lines • 886 B
TypeScript
/**
* Enhanced Documentation Generator
* Generates markdown documentation with JSDoc/TSDoc comments
*/
import type { DiscoveredAPI } from '../types.js';
export interface DocumentationOptions {
includeExamples?: boolean;
includeTypes?: boolean;
includeTests?: boolean;
format?: 'markdown' | 'html';
}
/**
* Generate markdown API documentation
*/
export declare function generateMarkdownDocs(apis: DiscoveredAPI[], options?: DocumentationOptions): string;
/**
* Generate JSDoc comments for TypeScript
*/
export declare function generateJSDocComments(api: DiscoveredAPI): string;
/**
* Generate complete documentation package
*/
export declare function generateDocumentationPackage(apis: DiscoveredAPI[], options?: DocumentationOptions): {
markdown: string;
jsdoc: Record<string, string>;
readme: string;
};
//# sourceMappingURL=docs-generator.d.ts.map