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.
43 lines • 1.24 kB
TypeScript
/**
* API Contract Testing Generator
*
* Generates contract tests to prevent breaking changes
*/
import type { DiscoveredAPI } from '../types.js';
export interface ContractDefinition {
endpoint: string;
method: string;
requestSchema: any;
responseSchema: any;
examples: {
request: any;
response: any;
}[];
}
export interface ContractTestOutput {
pactContracts: string;
schemathesisTests: string;
contractJson: string;
ciConfig: string;
}
/**
* Generate contract definitions from discovered APIs
*/
export declare function generateContractDefinitions(apis: DiscoveredAPI[]): ContractDefinition[];
/**
* Generate Pact contract files
*/
export declare function generatePactContracts(contracts: ContractDefinition[]): string;
/**
* Generate Schemathesis tests
*/
export declare function generateSchemathesisTests(contracts: ContractDefinition[]): string;
/**
* Generate contract test output
*/
export declare function generateContractTests(apis: DiscoveredAPI[]): ContractTestOutput;
/**
* Save contract tests
*/
export declare function saveContractTests(output: ContractTestOutput, outputPath: string): Promise<void>;
//# sourceMappingURL=contract-test-generator.d.ts.map