api-guarder v1.0.1

简单mock服务 + 代理服务，保证接口请求正常响应。

Installation

npm install api-guarder --save-dev

Usage

// webpack devServer config
...
{
  devServer: {
    // 可以不使用proxy配置
    // 直接在环境配置指定开发环境访问 http://localhost:4000，如下：
    // const domain = {
    //   dev: 'http://localhost:4000',
    //   ...
    // }
    proxy: {
      '/xxx': {
        target: 'http://localhost:4000', // 本地代理服务器地址
        changeOrigin: true,
      },
    },
    after() {
      const launchApiGuarder = require('api-guarder');
      launchApiGuarder({
        mode: 'proxy', // 可选值: mock | proxy
        target: 'http://api.example.com', // 后端接口服务器地址
        changeOrigin: true,
      });
    },
  }
}
...

Options

mode（必需）

选择模式：mock 或 proxy

• 使用mock模式，可以通过mockjs在开发阶段mock接口数据
• 使用proxy模式，联调阶段代理后端接口返回，并在本地文件备份，当下次后端接口数据返回异常时，读取上一次缓存在本地的数据返回给前端，保证前端数据正常

host（可选）

自定义本地启动的服务器的主机名，默认为localhost

port（可选）

自定义本地启动的服务器的端口号，默认为4000

target（指定proxy模式时，必需）

指定后端接口服务器的域名/主机名

changeOrigin（指定proxy模式时，通常设置为true）

请求是否修改origin头字段，用于解决跨域，和http-proxy的选项一致

apiCacheDir（可选）

自定义本地缓存接口数据的目录，默认为api-caches

mockDir（可选）

自定义本地存放mock文件的目录，默认为mocks

mockFileExt（可选）

自定义mock文件支持的后缀名，多个后缀名使用,隔开，默认为js,ts,json