什么是 request-contract
request-contract 是一个简单易用的 npm 包，用于在 Node.js 的 http 请求中实现请求契约。
通过使用 request-contract，您可以创建请求契约，指定 api 路径、http 请求方法、请求参数、响应数据等，从而自动化验证和提示请求/响应的正确性和规范性，提高代码质量和可维护性。
如何安装 request-contract
在终端中执行以下命令即可安装 request-contract：
npm install --save request-contract
如何使用 request-contract
创建请求契约
首先，您需要创建一个请求契约，以指定 api 路径、http 方法、请求参数、响应数据等。
下面是一个示例：
-- -------------------- ---- -------
----- ------- - -------------------
----- -------- - ----------------------------
----- ----- - ----------
----- ----------
------- -------
-------- -
--------------- -------------------
--
-------------- -
----- ---------
----------- -
----- - ----- -------- --
---- - ----- --------- -------- - --
------ - ----- --------- ------- ------- --
--
--------- -------- ------ ---------
--
--------------- -
----- ---------
----------- -
----- - ----- --------- ----- ----- ---- --
-------- - ----- -------- --
----- - ----- --------- ----------- -- --
--
--------- -------- ---------- --------
--
---其中：
path：api 路径method：http 请求方法（GET/POST/PUT/DELETE 等）headers：请求头requestSchema：请求参数契约（使用 JSON Schema 定义）responseSchema：响应数据契约（使用 JSON Schema 定义）
发送请求
接下来，您可以使用 request 函数来发送请求，并在请求的回调函数中进行契约验证：
-- -------------------- ---- -------
--------
-
---- -----------------------------
------- -------
-------- - --------------- ------------------ --
----- ----------------
----- ------
---- ---
------ ------------------
---
--
------- --------- ----- -- -
-- ------- ----- ------
----------------------------------- ----------------- ------ -- --------
-
--request-contract 更多用法
除了上述最基本的使用方法外，request-contract 还可以更进一步。
使用 preHandlers 和 postHandlers
如果您需要在请求发送或响应接收前后，额外执行一些操作（例如添加 auth token，记录请求/响应日志等），可以使用 preHandlers 和 postHandlers。
-- -------------------- ---- -------
----- ----- - ----------
----- ----------
------- -------
-------- -
--------------- -------------------
--
-------------- --- --- ----
--------------- --- --- ----
------------ -
---------------- -- -
------------------------------------ - ------- ----- -- -- ---- -----
-------------------- ------- -- ------------------------
--
--
------------- ----------- -- --------------------- -------- ---- ------ --------------------------
---端口自动化测试
如果您是一个开发人员或团队，那么您可以使用 request-contract 参与自动化测试的编写和执行。
例如，您可以使用 contract.test 函数来编写端到端测试：
-- -------------------- ---- -------
----- ----- - ----------
----- ----------
------- -------
-------- -
--------------- -------------------
--
-------------- --- --- ----
--------------- --- --- ----
---
-------------- --------- -- -- -
----------- --- ---- ----- ------ ----- -- -- -
----- - ---------- - - ----- ------------
---- -------------------------------
------- -------
----- -
----- ------
---- ---
------ ------------------
--
---
-----------------------------
---
----------- --- ---- ------- ------ ----- -- -- -
----- - ---------- - - ----- ------------
---- -------------------------------
------- -------
----- -
----- ------
------ ------------------
--
---
-----------------------------
---
---以上是使用 request-contract 的基本用法，您可以通过详细阅读该包的文档来掌握更深入的用法：https://github.com/simonrenauld/request-contract。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005600a81e8991b448ddd73