umi环境下同步swagger api自动生成mock数据工具

背景

内部使用的是umi,umi中包含了mock服务,mock环境下不需要自己再去起一个服务,但是随着业务的迭代,前后端由于是完全分离的,开发基本处于并行环节,在连调阶段前大部分需要自己mock数据查看实现效果,但有些字段过多需要mock的数据也很多,由于后端是使用swagge来部署后端api接口的可视化界面,所以想到用脚本来自动生成mock数据

使用方法:
yarn add syncswagger --dev
// 本地添加swagger.config.js

// package.json 添加启动命令
"syncSwagger": "syncSwagger",
// 生成mock数据
npm run syncSwagger

说明

需要在本地文件根目录下添加swagger.config.js

module.exports = {
  
  url: 'http://***/swagger-ui/api-docs', // swagger-api的文档地址(可以在network中找到)
  outputPath: './mock', // 默认目录,最终会自动生成文件 outputPath/mock.js
  blacklist: [],  // 黑名单 默认是模块 例如:['report'] 默认不更新report下的所有接口
  dataLength: '1-8', // mock 为数组时数组长度
  fileName: 'mock.js' 
}

你可能感兴趣的:(umi环境下同步swagger api自动生成mock数据工具)