auto-request
Version:
通过Yapi JSON Schema生成接口Axios或Taro接口
37 lines • 1.29 kB
TypeScript
import { FunctionInfo } from '@/helpers/countFunctions';
export interface AutoRequestOptions {
filename: string;
isTypeScript: boolean;
jsdoc?: {
enabled: boolean;
};
prefix?: string;
endfix?: string;
renderMethodCall?: () => string;
renderHeaderTemplate?: () => string;
renderMethodJsDocCall?: () => string;
renderEndTemplate?: () => string;
loggerPath?: string;
snapshotsPath?: string;
swaggerBackupPath?: string;
skipPrompt?: boolean;
ignoreUrls?: string[];
prettierFormat?: any;
total?: number;
/** @deprecated 请使用 loggerPath 直接指定完整路径 */
loggerFileName?: string;
}
/**
* 生成快照并检测 API 变更
* @param snapFilePath - 快照文件路径(可选)
* @param output - 输出目录
* @param options - 配置选项
* @param template - 模板代码
* @param swaggerJson - 当前 swagger JSON 字符串(可选,用于 swagger 对比)
* @returns 变更信息(新增和删除的函数)
*/
export declare const generatorSnapshots: (snapFilePath: string | undefined, output: string, options: AutoRequestOptions, template: string, swaggerJson?: string) => Promise<{
removed: FunctionInfo[];
added: FunctionInfo[];
}>;
//# sourceMappingURL=snapshot.d.ts.map