简介
hiproxy-plugin-noah 是一个用于 hiproxy 的插件，它允许你在代理请求到服务端之前，对请求进行处理。这个插件基于 noah 的构建工具，支持各种场景下的mock，可以根据不同的场景，返回不同的数据。
安装
你需要安装 hiproxy 因为这个插件是用于其上的。全局安装方法：
npm install hiproxy -g
如果已经安装成功了，那么就继续安装 hiproxy-plugin-noah 插件：
npm install hiproxy-plugin-noah -g
使用
安装成功之后，我们就可以开始使用 hiproxy-plugin-noah 插件了。
配置文件
我们需要在项目目录下面新建一个文件夹 hiproxy 。在该目录下面新建一个配置文件 plugin.json ，具体配置项如下：
{
"hiproxy-plugin-noah": {
"config": "./mockConfig.js",
"debug": false
}
}| 配置项 | 描述 |
|---|---|
config |
mock 配置文件地址，指向可执行的 js 文件（参照下面的 mockConfig.js） |
debug |
是否开启 debug 模式，当该值为 true 时，会在控制台输出一些调试信息 |
Mock 配置
我们根据自己的项目需要新建一个 mockConfig.js 配置文件。通常情况下种文件的开发，具体的原理可以参考 noah 的基础功能。
-- -------------------- ---- -------
-------------- - -
----- -
-
-- ----
----- --------
-- ----
----- -
-
------ -----------
--- -
--
-
------ ----------
--- -
--
-
------ ---------------
--- -
-
--
-- --- -------------------- ---- -----
------ -
-
----- ------
----- -
-
------ --------------------
--- -
--
-
------ -------------------
--- -
-
-
-
--
-- ---- -----------
--------- -
-
------- ---
-
-
-
-
-在此文件中，你需要定义你的 mock 数据。以上示例定义了一个 demo 场景，它们的含义如下：
| 配置项 | 描述 |
|---|---|
path |
表示 mock 的路径，可以定义通配符，例如 /demo/* |
data |
表示 mock 返回的数据，可以是数组、对象、字符串等形式 |
query |
若符合 query 数组中查询参数的规则，则返回另外一个结果 |
postData |
若是 POST 请求，符合此处规则则返回另外一个结果 |
启动 hiproxy 代理服务
在项目根目录下，使用以下命令启动 hiproxy 代理服务：
hiproxy start
如果需要指定端口，可以使用 --port 参数：
hiproxy start --port 8090
测试与调试
启动 hiproxy 之后，我们就可以访问规定的路径来获取 mock 数据了。下面是一些示例：
GET 请求
GET http://localhost:5525/user
返回以下结果：
{
"login": "testNoah",
"id": 1
}POST 请求且返回另外一种响应
POST http://localhost:5525/testNoah/test/id
在 mockConfig.js 文件中定义规则：
-- -------------------- ---- -------
-------------- - -
----- -
-
-- ----
----- --------------------
-- ----
----- -
-
------ -----------
--- -
--
-
------ ----------
--- -
--
-
------ ---------------
--- -
-
--
-- ---- -----------
--------- -
-
------- ---
-
-
-
-
-我们得到一个 HTTP 状态码是 200 的响应：
{
"status": 200
}查询参数
我们可以在请求路径中加入查询参数，以达到额外匹配业务场景的效果。下面是一个示例:
GET http://localhost:5525/user?flag=all
在 mockConfig.js 文件中，定义与其匹配的规则：
-- -------------------- ---- -------
-------------- - -
----- -
-
-- ----
----- --------
-- ----
----- -
-
------ -----------
--- -
--
-
------ ----------
--- -
-
--
-- --- -------------------- ---- -----
------ -
-
----- ------
----- -
-
------ --------------------
--- -
--
-
------ -------------------
--- -
-
-
-
-
-
-
-在以上操作之后，我们将得到一个新的 JSON 响应数据：
{
"login": "testNoah-flag-all",
"id": 1
}结论
hiproxy-plugin-noah 的出现，提供了大量的解决方案，可以在前后端开发过程中帮助你更方便地进行 Mock 数据的开发。通过本教程，你能更好地了解到如何使用 hiproxy-plugin-noah 插件，它的基本操作和使用姿势。希望本文能够对你有帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005665481e8991b448e2793