Yapi-to-config NPM

yapi-to-config

利用 yapi 提供的接口，生成一份 .js 导出一个数组。

这样做的目的是：通用性。

uni-app、js 等项目都可以使用导出的对象，再处理。

export default [
  /**
   * ==================================================
   *  公共分类
   *  公共分类
   * ==================================================
   */

  // 定位保存
  // doc: http://192.168.2.18:3000/project/141/interface/api/13715
  {
    funcName: "location_saveGpsLocation",
    method: "POST",
    url: "/v1/location/saveGpsLocation",
  }
]

安装

使用 npm:

$ npm install -D yapi-to-config

使用 yarn:

$ yarn add -D yapi-to-config

更新:

$ yarn upgrade yapi-to-config --latest

配置

// package.json
{
    // ...,
    "yapi": {
        // 必填：yapi 服务器地址
        "host": "YAPI_HOST",
        // 必填：yapi 接口 token
        "token": "YAPI_TOKEN",

        // 直接使用数据文件。如果有该字段，会直接使用， 不再请求 yapi 接口。
        // 数据文件地址, 相对于 package.json
        "localFilePath": "",

  		// 相对于 package.json，默认生成到 pkg 同级目录下
        "outputDir": "./",
        // 默认文件名
        "fileName": "apiConfig"
    }
}