swagger-jsservice-generator v1.1.6

开始

根据 swaggerapi 的接口配置信息 生成含有 JSDoc 注释的 请求代码，对 vscode 的提示友好，入参和返回参数的代码提示

npm install swagger-jsservice-generator --save-dev

使用

// swagger.js
const path = require('path');
const parseSwagger = require('swagger-jsservice-generator');

const { generate, generateApi } = parseSwagger({
  url: 'http://swagger.xxxx', // 这里会自动拼接上 /swagger-resources
  module: 'user',
  output: path.resolve(__dirname, '../api'),
  apiLibName: 'axios',
  apiLibPath: 'Axios', // 如果有get请求则需要封装一下，请求接口参数目前固定为 url,data
  convert: {
    integer: 'number',
    delete: 'remove', // method 为delete 的时候会转为axios.remove(url,data),避免关键字问题
  },
});

// 生成所有api，传递url，不用传apiUrl和module
generate();
// 生成单个api,需要传递 apiUrl和module，module时文件名
generateApi();

node swagger.js

//output: api/user.js;
// 如果使用了restful风格，需要对axios包装下，
// 包装格式如下：
// AxiosUtil.[get|post|delete|put](url,data); url 和 data 是固定的生成方式，因此需要包装统一处理
import axios from 'axios';
/**
 * some description
 * @param {SomeVo} data  - 请求参数，任何请求都只接受一个data对象作为入参
 * @param {Promise<DTO>} returnObject
 *
 **/
export function getDataList(data) {
  return axios.get('/data/list', data);
}

参数说明