前端开发需要经常与后端进行数据交互，而 RESTful API 是当前最流行的接口设计风格之一。为了便于前端开发者使用 RESTful API，我们推荐使用 npm 包 modular-rest-toolkit。
简介
modular-rest-toolkit 是一个轻量级，简单易用的 RESTful API 请求工具集。它提供了方便的方法来调用常用的 HTTP 方法 (GET、POST、PUT、DELETE)，并支持 promise 和 async/await。它还具有模块化的结构，可轻松地自定义您的请求函数以及请求拦截器和响应拦截器。
安装
您可以使用 npm 来安装 modular-rest-toolkit：
npm install modular-rest-toolkit
使用方法
下面是一个简单的例子，它演示了如何使用 moduler-rest-toolkit 来发送 GET 请求：
-- -------------------- ---- ------- ----- - -------------- --------- - - -------------------------------- ----- ------- - --------------- -------- --------------------------------------- -------- ------ --- ----- --- - ------------------- ----- -------- ---------- - ----- -------- - ----- ------------------ ------ -------------- - ---------- ------------- -- ------------------- ------------ -- --------------------
上面的代码中，我们首先使用 createRequest 工厂函数创建了一个请求实例 request，它指定了 API 的基本 URL 和请求超时时间。然后，我们使用 createApi 工厂函数来创建一个 API 实例 api，它使用 request 实例来发送请求。最后，我们定义了一个 getUsers 函数，它发送一个 GET 请求来获取用户列表。
HTTP 方法
modular-rest-toolkit 提供了四个 HTTP 方法：get、post、put 和 delete。
GET 请求
发送 GET 请求的方法是 api.get(url, config?)，其中 url 指定要请求的 URL，config 可选参数包含其他请求配置，例如请求头部和查询参数。
下面是一个演示如何使用 get 方法来获取用户列表的例子：
async function getUsers() {
const response = await api.get('/users', {
headers: { 'X-Frame-Options': 'SAMEORIGIN' },
params: { limit: 10 },
});
return response.data;
}POST 请求
发送 POST 请求的方法是 api.post(url, data?, config?)，其中 url 指定要请求的 URL，data 是 POST 请求的请求体，config 可选参数包含其他请求配置，例如请求头部和查询参数。
下面是一个演示如何使用 post 方法来创建用户的例子：
-- -------------------- ---- -------
----- -------- ---------------- -
----- -------- - ----- ------------------ ----- -
-------- - --------------- ------------------ --
---
------ --------------
-
------------
----- --------
------ --------------------
------ ---------------
--
------------ -- ------------------
------------ -- --------------------PUT 请求
发送 PUT 请求的方法是 api.put(url, data?, config?)，其中 url 指定要请求的 URL，data 是 PUT 请求的请求体，config 可选参数包含其他请求配置，例如请求头部和查询参数。
下面是一个演示如何使用 put 方法来更新用户的例子：
-- -------------------- ---- -------
----- -------- -------------- ----- -
----- -------- - ----- ----------------------- ----- -
-------- - --------------- ------------------ --
---
------ --------------
-
------------- -
----- ------
------ ------------------
------ ---------------
--
------------ -- ------------------
------------ -- --------------------DELETE 请求
发送 DELETE 请求的方法是 api.delete(url, config?)，其中 url 指定要请求的 URL，config 可选参数包含其他请求配置，例如请求头部和查询参数。
下面是一个演示如何使用 delete 方法来删除用户的例子：
async function deleteUser(id) {
const response = await api.delete(`/users/${id}`);
return response.data;
}
deleteUser(1)
.then(() => console.log('User deleted successfully'))
.catch((err) => console.error(err));请求拦截器和响应拦截器
modular-rest-toolkit 支持自定义请求拦截器和响应拦截器，它们可以用来实现自定义逻辑（例如设置授权头）或加强和格式化请求和响应。
在请求拦截器中，您可以操作 config 对象，它包含请求的配置信息。在响应拦截器中，您可以操作 response 对象，它包含响应的信息。
下面是一个演示如何使用请求拦截器和响应拦截器的例子：
-- -------------------- ---- -------
----- ------- - ---------------
-------- ---------------------------------------
-------- ------
---
----------------------------------------- -- -
---------------------------- - -----------
------ -------
---
-------------------------------------------- -- -
----- ---- - --------------
-- --------------- -
----- --- --------------------
-
------ ---------
---
----- --- - -------------------
----- -------- ----------- -
----- -------- - ----- ------------------------
------ --------------
-
----------
------------ -- ------------------
------------ -- --------------------上面的代码中，我们首先创建了一个请求实例 request，并在它上面定义了两个拦截器，用于设置授权头和对错误进行处理。然后，我们使用 request 实例来创建一个 API 实例 api，并使用它来发送 GET 请求。在响应中，我们检查 success 属性，如果为 false，则抛出一个错误。
总结
modular-rest-toolkit 是一个易于使用和自定义的 API 请求工具集，它提供了方便的方法来调用常用的 HTTP 方法，并支持 promise 和 async/await。它还具有模块化的结构，可轻松地自定义您的请求函数以及请求拦截器和响应拦截器。
我们希望本文对您有帮助，并鼓励您在 GitHub 上为 modular-rest-toolkit 提供反馈或参与开发。感谢您的阅读！
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600672eb0520b171f02e1e62