stubby 是一个基于 Node.js 的可扩展和易于使用的 HTTP stubs 服务器。它是一种测试工具，用于模拟 HTTP 服务端点，以便在没有实际的 API 服务的情况下进行本地开发，测试和调试。
本文将为大家介绍如何使用 stubby 实现 HTTP stubs，并提供示例代码，帮助您更深入地了解这个工具。
安装
在全局安装 stubby 命令：
npm install -g stubby
或者在项目中安装并添加到开发依赖：
npm install -D stubby
配置文件
stubby 使用 YAML 格式的配置文件描述 API 端点和响应。您可以将配置文件命名为 stubby.yml 或 stubby.yaml。将配置文件放在项目根目录下，然后在终端中运行以下命令，启动 stubby：
stubby
stubby 会自动在当前工作目录下查找 stubby.yml 文件。
以下是一个简单的 stubby.yml 配置文件示例：
endpoint:
url: /api/users
response:
status: 200
body: '[{"id": 1, "name": "John Doe"}, {"id": 2, "name": "Jane Doe"}]'在这个示例中，我们创建了一个名为 endpoint 的 API 端点，URL 是 /api/users，响应状态码是 200，响应体是一个包含两个用户的 JSON 数组。
您可以通过以下命令访问这个 API 端点：
curl http://localhost:8882/api/users
响应文件
除了在 YAML 文件中指定响应体之外，您还可以创建一个单独的响应文件来描述响应头和响应体。响应文件必须以 .json、.xml、.txt 或 .html 结尾。
以下是一个 JSON 格式的响应文件示例：
-- -------------------- ---- -------
-
--------- ----
---------- -
--------------- ------------------
--
------- --
----- --
------- ----- ----
--
-
----- --
------- ----- ----
-
-
-接下来，您可以在 stubby.yml 文件中使用 file 关键字引用响应文件：
- url: /api/users file: ./users.json
动态响应
您可以使用 JavaScript 代码生成响应体，以获得更大的灵活性。为了实现这一点，可以将 .js 文件作为响应文件。
以下是一个示例 JavaScript 响应文件：
-- -------------------- ---- -------
-------- ---------------------- -
--- ---- - --
----- --
------- ----- ----
--
-
----- --
------- ----- ----
-
--
-- ------------- --- ------- -
---- - --
----- --
------- ----- ----
---
-
------ -
--------- ----
---------- -
--------------- ------------------
--
------- ----
-
-
-------------- - ----------------在这个示例中，我们定义了一个名为 dynamicResponse 的函数，它接受查询参数，并根据该参数返回不同的响应。
接下来，您可以在 stubby.yml 文件中引用这个响应文件：
- url: /api/users file: ./dynamicResponse.js handler: dynamicResponse
在这个示例中，我们使用 file 关键字指定了 JS 响应文件，并使用 handler 关键字指定了一个要调用的函数。
延迟响应
您可以将延迟时间指定为一个整数值(单位是毫秒)，以便模拟网络延迟。
- url: /api/users file: ./users.json latency: 2000
在这个示例中，我们将响应延迟时间设置为 2s。
HTTPS
默认情况下，stubby 在 8882 端口上监听 HTTP 请求。如果要监听 HTTPS 请求，请在配置文件中使用 tls 关键字，并设置 SSL 证书和密钥路径：
-- -------------------- ---- -------
----
----- ------------------
---- -----------------
---------
---- ----------
---------
------- ---
----- -------- -- ------- ----- ------ ------ -- ------- ----- -------在这个示例中，我们使用 tls 关键字指定了 SSL 证书和密钥的位置。
结论
通过本文的介绍，您学习了如何使用 stubby 工具创建 HTTP stubs，让您可以在没有实际的 API 服务的情况下进行本地开发，测试和调试。希望本文能为您提供了一些指导意义，并帮助您更好地使用 stubby 工具。
示例代码已经放在 GitHub，您可以下载使用，如果有不懂的地方，欢迎在评论区提出问题。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5ef84a7e403f2923b035b969