{

  "url": "./api.json", // 文件路径

  "remoteUrl": "http://**", // url

  "requestConfig": {

    "url": "./api.json" // 文件路径或url

    // 以下所有 request 支持的参数

    // headers?: Headers;

    // baseUrl?: string;

    // callback?: RequestCallback;

    // jar?: CookieJar | boolean;

    // formData?: { [key: string]: any };

    // form?: { [key: string]: any } | string;

    // auth?: AuthOptions;

    // oauth?: OAuthOptions;

    // aws?: AWSOptions;

    // hawk?: HawkOptions;

    // qs?: any;

    // qsStringifyOptions?: any;

    // qsParseOptions?: any;

    // json?: any;

    // jsonReviver?: (key: string, value: any) => any;

    // jsonReplacer?: (key: string, value: any) => any;

    // multipart?: RequestPart[] | Multipart;

    // agent?: http.Agent | https.Agent;

    // agentOptions?: http.AgentOptions | https.AgentOptions;

    // agentClass?: any;

    // forever?: any;

    // host?: string;

    // port?: number;

    // method?: string;

    // body?: any;

    // family?: 4 | 6;

    // followRedirect?: boolean | ((response: http.IncomingMessage) => boolean);

    // followAllRedirects?: boolean;

    // followOriginalHttpMethod?: boolean;

    // maxRedirects?: number;

    // removeRefererHeader?: boolean;

    // encoding?: string | null;

    // pool?: any;

    // timeout?: number;

    // localAddress?: string;

    // proxy?: any;

    // tunnel?: boolean;

    // strictSSL?: boolean;

    // rejectUnauthorized?: boolean;

    // time?: boolean;

    // gzip?: boolean;

    // preambleCRLF?: boolean;

    // postambleCRLF?: boolean;

    // withCredentials?: boolean;

    // key?: Buffer;

    // cert?: Buffer;

    // passphrase?: string;

    // ca?: string | Buffer | string[] | Buffer[];

    // har?: HttpArchiveRequest;

    // useQuerystring?: boolean;

  },

  "type": "yapi",

  "yapiConfig": {

    "required": false,

    "bodyJsonRequired": false,

    "categoryMap": {

      "中文": "English" // yapi 接口分类中英文映射

    }

  },

  "swaggerParser": {

    "-o": "tmp/services"

  },

  "validateResponse": false, // 是否生成校验逻辑

  "guardConfig": {

    // + strict 严格模式

    //    - 校验 swagger tags【yapi 接口分类】是否是纯英文

    //    - 方法名使用 http method + url 驼峰形式

    //    - 新项目采用

    // + safe 安全模式

    //    - 方法名使用 http method + url 驼峰形式

    //    - 老项目升级，不会校验 tags，会生成方法调用替换映射表

    // + 默认

    //    - http method + url => operationId 映射锁定

    //    - 老项目维持现状

    "mode": "strict",

    // swagger 处理重复 operationId 逻辑有风险，因此需要锁定映射关系

    "methodUrl2OperationIdMap": {

      "get /api/xxx/xxx": "operationId"

    }

  }

}

/** 不再兼容非标准的数据结构 */

export declare type AjaxPromise<R> = Promise<R>;

/** 非标准包裹 */

export declare type NonStandardAjaxPromise<R> = Promise<{

  code?: number;

  message?: string;

  result: R;

}>;

export interface ExtraFetchParams {

  /** extra data for extends */

  extra?: any;

  /** 扩展请求头 */

  headers?: any;

  /** cancel request */

  cancel?: Promise<string | undefined>;

}

export interface WrappedFetchParams extends ExtraFetchParams {

  /** http method */

  method: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'OPTIONS' | 'PATCH' | 'HEAD';

  url: string;

  /** post json data */

  data?: any;

  /** post form data */

  form?: any;

  /** query data */

  query?: any;

  /** header */

  header?: any;

  /** path data */

  path?: any;

}

export declare class Ajax {

  /** ajax 方法 */

  ajax(

    { method, url, data, form, query, header, extra, cancel, headers }: WrappedFetchParams,

    path?: string,

    basePath?: string

  ): Promise<any>;

  /** 接口传参校验 */

  check<V>(value: V, name: string): void;

  /** 新 fetch 接口，>= 3.5.4 */

  public autosFetch<S extends keyof AutosAPIS>(

    source: S,

    ...args: AutosAPIS[S][0]

  ): Promise<AutosAPIS[S][1]> {

    const { isFile, opt, ...config } = (args[0] || {}) as AutosParams;

    let { headers = {} } = opt || {};

    if (isFile) {

      headers = {

        ...headers,

        'Content-Type': 'multipart/form-data'

      };

    }

    const [method, url] = source.split(' ') as [WrappedFetchParams['method'], string];

    return this.ajax({

      ...config,

      ...opt,

      method,

      url: config.path

        ? url.replace(

            /(({[^}]+})|(:[^/:]+$)|(:[^:/]+))/g,

            all => config.path![all.replace(/[:{}]/g, '')] || ''

          )

        : url,

      headers

    });

  }

}

declare const _default: Ajax;

export default _default;

import { ExtraFetchParams } from '@ajax';

import * as models from '../model/models';

​

declare global {

  interface AutosAPIS {

    'GET /ts-boilerplate/api/user/info': [

      (

        | []

        | [

            {

              opt?: ExtraFetchParams;

            }

          ]

      ),

      models.UserInfo

    ];

  }

}

declare global {

  interface AutosAPIS {

    /** 测试接口 */

    'DEMO /ajax/test': [[{}], {}];

  }

}

// ...

function autosFetch<S extends keyof AutosAPIS>(

  source: S,

  ...args: AutosAPIS[S][0]

): Promise<AutosAPIS[S][1]> {

  const { isFile, opt, ...config } = (args[0] || {}) as AutosParams;

  let { headers = {} } = opt || {};

  if (isFile) {

    headers = {

      ...headers,

      'Content-Type': 'multipart/form-data'

    };

  }

  // ...

}