Home

Awesome

yapi-gen-js-code

该工具目前还不完善,请勿正式使用

环境

根据 YApi 的接口定义生成 javascript 的请求函数,目前内置了 axios 请求模板

功能

  1. 支持 restful api
  2. 支持 get, post 等多种请求体
  3. 支持验证请求参数,需要依赖 ava

安装

npm i -g yapi-gen-js-code

使用

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

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

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

yapi-gen-js-code

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

可参考该 demo

生成代码示例

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

name类型默认值描述信息
serverString-服务器地址,比如: http://yapi.demo.qunar.com
tokenString-项目token
distString-生成文件路径
templateString Or Functionaxios模板名,目前仅内置了 axios 模板,自定义请查看下面文档
globalCodeStringconst axios = require('axios');全局代码,会注入到最前面
methodNameFunction请参考源码方法名生成函数,一般无需改动
categoryIdString-项目分类id, 填写后只生成某个分类下的接口,默认生成该项目所有接口请求代码
enableValidteBooleantrue是否开启参数验证,默认是开启的,需要引入 ava 依赖

自定义模板

自定义模板就是写一个函数,返回一个 request 函数片段,接收两个参数,第一个 baseinfo,包含了请求 url, method, 请求参数等

{
  template: function(){
    return `function request(baseinfo, options = {}){
        let params = baseinfo.params;

        options = Object.assign({}, {
          url: baseinfo.url,
          method: baseinfo.method,
          data: params
        }, options)

        if(checkRequestParams && typeof checkRequestParams === 'function'){
          checkRequestParams(interfaceData ,params)
        }

        return axios(options)
      }`
  }
}