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.
52 lines • 1.48 kB
TypeScript
/**
* API Performance Benchmarking
*
* Automatically benchmarks discovered APIs and generates performance reports
*/
import type { DiscoveredAPI } from '../types.js';
export interface PerformanceMetrics {
endpoint: string;
method: string;
latency: {
min: number;
max: number;
avg: number;
p50: number;
p95: number;
p99: number;
};
throughput: number;
errorRate: number;
successRate: number;
sampleSize: number;
}
export interface PerformanceReport {
summary: {
totalEndpoints: number;
averageLatency: number;
slowestEndpoint: string;
fastestEndpoint: string;
totalErrors: number;
overallSuccessRate: number;
};
metrics: PerformanceMetrics[];
recommendations: string[];
loadTestScript?: string;
}
/**
* Benchmark a single API endpoint
*/
export declare function benchmarkEndpoint(api: DiscoveredAPI, iterations?: number): Promise<PerformanceMetrics>;
/**
* Benchmark all discovered APIs
*/
export declare function benchmarkAPIs(apis: DiscoveredAPI[], iterations?: number): Promise<PerformanceReport>;
/**
* Format performance report as markdown
*/
export declare function formatPerformanceReport(report: PerformanceReport): string;
/**
* Save performance report
*/
export declare function savePerformanceReport(report: PerformanceReport, outputPath: string): Promise<void>;
//# sourceMappingURL=performance-benchmark.d.ts.map