前言
在前端开发中，我们经常会使用到 RESTful API 来与后端交互。而在开发过程中，我们往往需要测试 API 接口的性能、调试接口返回的数据等，这时一个强大的工具就显得尤为重要。本文将介绍一款强大的 npm 包 @readme/oas-to-har，该包可以将 OpenAPI 规范转换为一个 HAR 文件。
安装
使用 npm 命令进行安装：
npm install @readme/oas-to-har
使用
命令行使用
在命令行中使用该包，使用如下命令：
oas-to-har [OPTIONS] OAS_FILE
其中 OPTIONS 可选，OAS_FILE 为 OpenAPI 规范文件的路径。OPTIONS 主要包括以下内容：
-o：输出的 HAR 文件名称，默认为swagger-petstore.har-h：指定主机名称，默认为localhost-p：指定端口号，默认为8080-s：指定 HTTPS 的设定
示例命令：
oas-to-har spec/petstore.yaml -o petstore.har -h petstore.com -p 80 -s
JavaScript API 使用
在 JavaScript 代码中使用该包，需要先引入：
const oasToHar = require('@readme/oas-to-har');使用示例：
-- -------------------- ---- -------
----- -- - --------------
----- -------- - ------------------------------
----- ---- - -------------------------------- --------
---------------------- - ----- --------------- ----- -- -- ----- ---- -- -
-- ----- -
-------------------
- ---- -
-----------------
-
---需要注意的是，转换完成后，har 将以回调函数的形式返回。
实际应用
接下来，我们通过一个实际的例子来展示该包的使用。
假设我们现在的开发任务是实现一个简单的 TODO 应用，我们需要通过 API 与后端交互。现在我们已经编写好了接口文档，接口如下：
-- -------------------- ---- -------
-------- -----
-----
------ ----- ---- ---
------------ ------- --- --- ----- ---- ---
-------- -----
----- --------------
--------
- ----
------
-------
----
-------- --- ----- ----
------------ -
--- - ---- -- --- ----- ---- --- --------
---------
- ----------------
----------
------
------------ ---- -- -----
-------
----- -----
------
----- --------------------
-----
-------- --- --- ----
------------ -
--- - --- ---- -- --- --------
---------
- ----------------
-----------
- ----- ----
--- ----
------------ -
--- --- ---- ------ -- --- -- --- --------
--------- ----
-------
----- --------------------
----------
------
------------ ----- ------- ----
-------
----- --------------------
------------
----
-------- --- ------ ----
------------ -
--- - ------ ---- ---- ---- --- --------
---------
- ----------------
-----------
- ----- --
--- ----
------------ -
--- -- -- --- ---- -- --------
--------- ----
-------
----- -------
----------
------
------------ --- ---- ----
-------
----- --------------------
----
-------- ------ ------ ----
------------ -
------ - ------ ---- ---- ------ --- --------
---------
- ----------------
-----------
- ----- --
--- ----
------------ -
--- -- -- --- ---- -- ------
--------- ----
-------
----- -------
- ----- ----
--- ----
------------ -
--- ------- ---- ------ -- ----- -- --- --------
--------- ----
-------
----- --------------------
----------
------
------------ --- ------- ---- ----
-------
----- --------------------
-------
-------- ------ ------ ----
------------ -
------ - ------ ---- ---- ---- --- --------
---------
- ----------------
-----------
- ----- --
--- ----
------------ -
--- -- -- --- ---- -- ------
--------- ----
-------
----- -------
----------
------
------------ ---- --- ------- ------------
------------
-----
----- ------
-----------
---
----- -------
------
----- ------
------------
----- ------
-----
----- -------我们可以使用此文档生成一个 HAR 文件：
oas-to-har todo.yaml
然后我们可以使用 Postman 工具在 HAR 文件中导入接口，如下图所示：
点击导入即可自动将 HAR 中的接口添加至 Postman 中：
接下来，我们就可以测试接口了。以添加任务接口为例：
我们在 Body 中输入待添加任务的 JSON 串，并发送请求：
可以看到，接口返回了成功添加的任务信息。
结束语
@readme/oas-to-har 包能够帮助我们将 OpenAPI 规范转换为一个标准的 HAR 文件，方便我们在 Postman 等工具中进行 API 测试和调试。通过本文的学习，我们应该能够灵活使用该包，提高开发效率。
示例代码
完成以上操作需要使用到以下示例代码。
- 待添加任务的 JSON 串：
{
"title": "Finish homework",
"description": "Complete last week's math assignment",
"done": false
}来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5eedb0c6b5cbfe1ea06110e8