@gmin/yapi-gen-js-code

yapi-gen-js-code

根据 YApi 的接口定义生成 javascript 的请求函数，适用于 PanJiaChen/vue-admin-template 及其衍生项目

环境

• node > 8.0
• yapi >= 1.5.2

功能

1. 支持 restful api
2. 支持 get, post 等多种请求体

安装

npm i -g @gmin/yapi-gen-js-code

使用

1.首先需要创建 yapi-gen.config.js 配置文件，如下所示：

module.exports = {
  server: 'http://127.0.0.1:3000',
  token: '',
  categoryId: 1
}

2.在当前目录下执行 yapi-gen-js-code

yapi-gen-js-code

执行完成后，即可生成 yapi-gen-js-code.js 请求文件

yapi-gen.config.js配置项说明

name	类型	默认值	描述信息
server	String	-	服务器地址，比如: http://127.0.0.1:3000
token	String	-	项目token
dist	String	-	生成文件路径
globalCode	String	import request from '@/utils/request'	全局代码，会注入到最前面
methodName	Function	请参考源码	方法名生成函数，一般无需改动
categoryId	String	-	项目分类id, 填写后只生成某个分类下的接口，默认生成该项目所有接口请求代码
showSubProperties	Boolean	false	是否显示@info中的子属性
showSubProperties	Boolean	true	是否显示@info注解

Thanks

• 感谢大佬 hellosean1025 的 hellosean1025/yapi-gen-js-code 源码