@heibanfe/mock

heibanfe mock express middleware.

Install

yarn add @heibanfe/xhbmock

Configuration

const express = require("express");
const xhbmock = require("@heibanfe/xhbmock");

const app = express();

app.use(
    xhbmock({
        proxyConfig: {
            // 代理名称
            name: "test",
            // 用于拦截的前缀
            filter: "/api",
            // 代理 信息，具体参照 https://github.com/http-party/node-http-proxy/blob/master/README.md#options
            config: {
                target: "http://xxx"
            }
        },
        // api请求的前缀
        apiPrefix: "your-api-prefix",
        // 存储mock数据的地址
        mockDirectory: ".xhbmock" // 默认为.xhbmock
    })
);
app.listen(3000, "0.0.0.0");

Usage

用上面的配置启动服务器之后，访问 http://127.0.0.1:3000/mock。在左边的菜单栏选择添加代理，填入你要代理的路径。比如下面某个 webapi 的请求路径

demo/module/signature/signature.ts

点击获取内容模板，这时候会为这个接口生成数据，点击提交。这样就添加了一个接口代理。当然除了自动生成，你也可以选择旁边的直接导入，手动填入 JSON 数据。

上面只是添加了一条代理，实际上并未生效。还需要到开关路径这个菜单下面，把刚刚添加的代理移动到右边的框内。

然后回到我们的业务页面，再次调用这个接口，就可以看到成功代理了。