gen-api-js/dist/config/api.config.js

根据线上接口文档轻量化简易一键批量生成模块化 JavaScript/TypeScript API接口

/* 参考文档:https://www.npmjs.com/package/gen-api-js */
module.exports = {
  docName: "", // 在线文档网站名称
  // debug: false,//是否开启调试
  docUrl: "", //在线文档网站地址
  // cache:true,//是否开启缓存 默认为开启状态
  // typescript:false,//语言类型 默认会根据文件类型去生成 
  // cacheFileName:"genApi.data.json",//缓存文件名称 默认为 genApi.data.json
  // 生成api的文件夹
  // apiFilePath: "api",// 会从src路径下寻找
  /*  puppeteer 选项配置  参考: https://pptr.nodejs.cn/
  puppeteerOptions:{
    method:'launch',
    run(puppeteer) {
      return {
        headless: true,
        defaultViewport: null,
        args: ["--start-maximized"],
        ignoreDefaultArgs: ["--enable-automation"],
        executablePath: puppeteer.executablePath("chrome"),
         devtools: true,
      };
    },
  } */
  // 自定义apiName函数名
  /*   getRequestFunctionName(apiName, opt, toCamelCase) {
    let funcName = toCamelCase(
      `${opt.method.toLocaleLowerCase()}/${opt.formatPaths.at(-2)}/${opt.formatPaths.at(-1)}`
    );
    return funcName;
  }, */

  // importRequestName: "",  // 头部引入的请求方法名称

  /* requestOptions: {
     annotation:"",
     paramsName: "",
    requestFunc(opt, reqTypeName, resTypeName) {
      return `
     export function ${opt.apiName}(${this.config.typescript ? `${opt.newParamsName}?:${reqTypeName}` : `${opt.newParamsName}`} )  {
       ${`return request.${this.config.typescript ? `${opt.method}<${reqTypeName},${resTypeName}>` : `${opt.method}`}({ url: ${opt.path},${!opt.restFul ? opt.newParamsName : ""}})

          `}
      }

    `;
    }
  }, */
  // api项目配置项
  // 配置选项:  如果要生成当前项目下所有的接口只需要传项目id过来即可 projectId 是必填项 使用方式:catIds:[xxx] 批量使用传参:catIds:[xxx,'开始下标-结束下标']下标是从1开始(生成下标范围api)  catIds:[xxx,3]生成单独某一项(传下标|id|菜单名称)catIds:[xxx,'1 3 5]批量生成对应的项(传下标|id|菜单名称) catIds:[xxx,'-xxx] 排除当前这项(传下标|id|菜单名称)
  projects: [],
};