在前端开发中，我们常常需要和后端进行接口数据交互。但是，当接口数量较多时，开发文档的编写以及与后端协商接口的方式可能让人感到较为麻烦。此时，simple-rest-docs 这个 npm 包就可以很好的解决这个问题。本篇文章将会介绍如何启用并使用这个 npm 包，以帮助更好地管理前后端数据交互的工作。
安装 simple-rest-docs
为了启用 simple-rest-docs，你需要在终端上运行以下命令安装它：
npm i --save-dev simple-rest-docs
配置 simple-rest-docs
安装完成后，你需要对其创建配置以便将其应用于项目。具体来说，你需要：
- 在项目根目录下创建一个名为 rest-docs 的文件夹
- 在 rest-docs 文件夹中，创建一个名为 docs.config.json 的文件。将以下文本复制并粘贴到此文件中，并根据你的需求修改：
-- -------------------- ---- -------
-
-------- -----
--------- -
------ -----
----------- -----------------------------
--
------ -
-
------- -------- -----
------- -- ------ ---- --- ---------
------- -----------------
----------- -------
---------- ---------
-------- -
-
-------- ---------
--------- ------
------- ---- --- -------
-------- ---
-------------------- ---
---------- ---
---------------------- ---
--
-
-------- ---------
--------- -------
------- ------- - --- ------
------- -
-
------- -----------
------- ---------
----------- -----
--
-
------- -----------
------- ---------
----------- -----
-
--
------------------- ---
---------- ---
---------------------- ---
--
-
-------- -------------
--------- ------
------- ------- - ------
--------- -
-
------- -----
------- ---------
----------- -----
-
--
------- -
-
------- -----------
------- ---------
--
-
------- -----------
------- ---------
-
--
---------- ---
---------------------- ---
--
-
-------- -------------
--------- ---------
------- ------- - ------
--------- -
-
------- -----
------- ---------
----------- -----
-
--
---------- ---
---------------------- ---
-
-
-
-
-以上配置文件展示了一个名称为“Example API”的 API，其中包含了 GET、POST、PUT 和 DELETE 方法。你应该根据你的需求进行更改，以适应于你所需的 API。
运行 simple-rest-docs
配置完 simple-rest-docs 后，你可以在本地运行它来生成你的 API 文档。只需要运行以下命令即可：
npx simple-rest-docs
这个命令会自动搜索项目根目录下的 rest-docs 文件夹并使用其中的 docs.config.json 文件。运行完成后，你可以在项目根目录下找到一个名为 REST-API-Specification.html 的文件。
示例代码
以下是一个简单的使用示例，它将向 API 发出 GET 请求并将响应输出到控制台：
const fetch = require('node-fetch');
fetch('http://localhost:3000/api/users')
.then(res => res.json())
.then(data => console.log(data))
.catch(err => console.error(err));结论
随着 API 的数量增加，它们的管理变得越来越困难。simple-rest-docs 可以帮助你更好地管理接口文档和协商接口规范。本文介绍了如何安装 simple-rest-docs、配置它以及在本地运行它。通过本文的学习，你可以更好地应对与后端数据交互的任务。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005587a81e8991b448d5bc6