@flavoai/fastfold
Version:
Zero-boilerplate backend for React apps with auto-generated CRUD and declarative security
50 lines • 1.22 kB
TypeScript
import { FastfoldConfig } from '../types';
export interface ApiEndpoint {
method: string;
path: string;
description: string;
parameters?: ApiParameter[];
requestBody?: ApiRequestBody;
responses: ApiResponse[];
}
export interface ApiParameter {
name: string;
in: 'path' | 'query';
required: boolean;
type: string;
description: string;
}
export interface ApiRequestBody {
description: string;
schema: Record<string, any>;
}
export interface ApiResponse {
status: number;
description: string;
schema?: Record<string, any>;
}
export declare class ApiDocumentationGenerator {
private config;
constructor(config: FastfoldConfig);
/**
* Generate complete API documentation
*/
generateDocumentation(): {
info: any;
tables: Record<string, any>;
endpoints: ApiEndpoint[];
};
/**
* Generate endpoints for a specific table
*/
private generateTableEndpoints;
/**
* Convert Fastfold schema to JSON Schema
*/
private schemaToJsonSchema;
/**
* Get human-readable security description
*/
private getSecurityDescription;
}
//# sourceMappingURL=generator.d.ts.map