@api-helper/cli/es/lib/types.d.ts

根据 Swagger 的接口定义生成 TypeScript/JavaScript 的接口类型及其请求函数代码。

import type { AxiosHeaders } from 'axios';
import type { APIHelper } from '@api-helper/core/lib/types';
import { renderInterfaceName } from '@api-helper/template/lib/render-interface';
import { renderRequestFunctionName } from '@api-helper/template/lib/render-request-function';
export declare type ParserPluginRunResult = Array<{
    documentServer: Config['documentServers'][number];
    parsedDocumentList: Array<APIHelper.Document>;
}>;
export declare type DocumentServers = Config['documentServers'];
export declare type ParserPluginOptions = Pick<Config, 'requiredRequestField' | 'requiredResponseField'>;
export declare abstract class AbstractParserPlugin {
    abstract name: string;
    abstract run(documentServers: DocumentServers, options?: ParserPluginOptions): Promise<ParserPluginRunResult>;
}
export interface CommonConfig {
    genHeaders?: boolean;
    genCookies?: boolean;
    genResponseContentType?: boolean;
    requestFunctionFilePath?: string;
    requiredRequestField?: boolean;
    requiredResponseField?: boolean;
    events?: {
        onRenderInterfaceName?: typeof renderInterfaceName;
        onRenderRequestFunctionName?: typeof renderRequestFunctionName;
    };
    transformType: Record<string, string | ((type: string, format?: string | 'int32' | 'int64' | 'float' | 'double' | 'byte' | 'binary' | 'date' | 'date-time' | 'password', emptyType?: string) => string)>;
    includeCategory?: Array<string> | ((category: APIHelper.Category) => boolean);
    excludeCategory?: Array<string> | ((category: APIHelper.Category) => boolean);
    includeAPI?: Array<string | [string, string?]> | ((api: APIHelper.API) => boolean);
    excludeAPI?: Array<string | [string, string?]> | ((api: APIHelper.API) => boolean);
    type?: 'swagger' | 'yapi' | string;
    name?: string;
    dataKey?: string;
    auth?: {
        username: string;
        password: string;
    };
    authToken?: '';
    headers?: AxiosHeaders;
}
export interface ServerConfig extends CommonConfig {
    url: string;
}
export interface Config extends CommonConfig {
    onlyTyping?: boolean;
    outputPath: string;
    outputFilePath?: string;
    outputByCategory?: boolean;
    target?: 'javascript' | 'typescript';
    documentServers: Array<ServerConfig>;
    parserPlugins?: AbstractParserPlugin[];
}