yapi-apifox-to-typescript 4.2.3 → 5.0.1

package/lib/esm/ApifoxToYApiData.d.ts

@@ -0,0 +1,49 @@
+import { Category, CategoryConfig, InterfaceList, Project, SyntheticalConfig } from './types';
+export interface ApifoxToYApiDataOptions {
+    token: string;
+    projectId: number;
+    categories: CategoryConfig[];
+    serverUrl: string;
+    addFoldersToTags?: boolean;
+    oasVersion?: string;
+    exportFormat?: 'JSON' | 'YAML';
+}
+export type TProjectInfo = Project & {
+    cats: Category[];
+    getMockUrl: () => string;
+    getDevUrl: (value: string) => string;
+    getProdUrl: (value: string) => string;
+};
+export declare class ApifoxToYApiData {
+    private openApiDoc;
+    private options;
+    private project;
+    private schemas;
+    private interfaceIdCounter;
+    constructor(options: ApifoxToYApiDataOptions);
+    private resolveRef;
+    private resolveSchema;
+    private getSchemaType;
+    private getRequestParamType;
+    private getRequestQueryType;
+    private convertParametersToReqParams;
+    private convertRequestBody;
+    private normalizeSchema;
+    private convertResponse;
+    private generateInterfaceId;
+    /**
+     * 获取接口所属的目录名称
+     * Apifox 优先使用 x-apifox-folder 字段，其次才用 tags[0]
+     */
+    private getOperationFolder;
+    private convertOperationToInterface;
+    getProjectInfo(): Promise<TProjectInfo>;
+    private getTagId;
+    /**
+     * 从 OpenAPI tags 中获取目录对应的 tag
+     * 如果 x-apifox-folder 在 tags 中存在，则返回对应的 tag；否则返回 x-apifox-folder 本身
+     */
+    private getMatchingTag;
+    getCats(cats: CategoryConfig): number[];
+    getInterfaceList(syntheticalConfig: SyntheticalConfig): Promise<InterfaceList>;
+}