1.0.16 • Published 2 years ago

api-local-transfer v1.0.16

Weekly downloads
-
License
-
Repository
-
Last release
2 years ago

##确认是否有一些历史记录或者缓存影响你的命令执行 D:\Program Files\nodejs\module 现在改到移动到E盘了导致新老命令都可以执行 都加了path

通过 apiLocal init 初始化配置文件

module.exports = {
  outputDir: "./",
  apiName: "",  // 根据文件后缀判断是ts还是js文件
  product: "",
  remote: "https://xxx/AA/BB/CC", // 若有多个 用“/” 分开,会自动获取合并
  compareLocal: false, // 是否和本地生成代码比较,如果本地规则不匹配请设置false或者不加此属性,规则目前未提供灵活自定义
  methodNameDef: function(path) {
    return path;
  }, // 方法命名规则可以自定义

  /*
  *{
  method: 'post',
  url: '/XX/XX',
  methodNameNative: 'XX_XX',
  bodyParams: 'XXRequest',
  queryParams: '',
  responseType: 'XXResponse',
  title: '名称',
  parameters: '针对ts使用, params:XXRequest '
}
  * */
  templateBody: ({ method, url, methodNameNative, bodyParams, queryParams, responseType, title, parameters }) => {
    return '';
  },
  // 方法体模板信息 写入的参数值需要确认此值是否在返回信息里
  templateWrapper: (apiSource) => {
    return `
        ${apiSource}
    `;
  },  // 方法体模板信息外面嵌套的一层

  typesSeparate: true // ts需要配置,声明文件是否分开
}

##第一步: ###npm i api-transfer-code -g 全局安装

##第二步: ###在应用根目录 执行 apiLocal init 初始化配置文件 生成 api.config.js文件

如果执行不成功 看下 NODE_PATH配置是否正确(npm config get prefix)

默认在 C:\Users**\AppData\Roaming\npm

安装了全局命令或者修改了全局环境变量,webstorm 不能及时生效,需要全部关闭

##第三步:

###配置文件所列参数 都必填