前端js代码生成器

1. 简介

前端js代码生成器是针对前端Vue开发、微信小程序开发javascript接口交互代码自动化的一个生成器工具。

2. 使用环境

node V8+

3. 如何使用

  1. 登陆公司gitlab平台,进入分组 “金鹏信息分布式组件构建平台”,找到分组api-gen下的项目api-gen-h5,clone源码到本地。快速进入
  2. 使用前端IDE(这里以WebStorm为例),打开项目,进入文件conf/projects.js,如图所示:
  3. 修改项目配置,参数解析详见: 参数解析
  4. 运行命令 ./gen.js --project='projectName',首次使用请先执行npm install。成功示例如下图:

4. 参数解析

  'izz': [
    {
      projectName: '爱郑州',
      apiUrl: 'https://petstore.swagger.io/v2/swagger.json',
      macPath: '/Users/Steven/Desktop/test/api.js',
      winPath: 'D:/Projects/izz/src/api/api.js',
      className: 'Api',
      domainVar: 'window.api.domain',
      template: 'vue'
    }]

izz: 项目标识,运行gen.js参数projectName
projectName: 项目中文名称,例如 “爱郑州wechat"
apiUrl: 服务端swagger.json的地址
macPath/winPath: api.js生成位置,mac电脑地址或者window电脑地址,根据自己的电脑系统配置其一即可。
className: 生成的api calssName
domainVar: 域名前缀定义变量名称
template: 模板类型。支撑vue(基于vue1.0网络交互类库)、axios、nodejs、nuxt、wxa模板。
apiPrefix: api前缀,默认 'api',如果没有前缀,可设置'',如果不设置,默认是 'api'。

5. 注意事项

  1. 如果运行./gen.js 命令,报错 permission not allowed,是因为gen.js没有执行权限,运行命令 sudo chmod +x gen.js赋予gen.js文件执行权限即可。
  2. 由于接口的不稳定性,通信接口需要根据服务端的修改进行覆盖生成,所以请勿更改生成的接口交互代码,接口发生变化,请运行命令进行接口自动化升级。

源码地址:http://sources.jpsycn.com/dev-plat/api-gen/api-gen-h5.git

版权归河南金鹏信息技术股份有限公司所有,仅用于技术交流,禁止用于商业目的 all right reserved,powered by Gitbook该文件修订时间: 2020-03-21 17:17:43

results matching ""

    No results matching ""