简介
suren-rest 是一个基于 Node.js 的库，它提供了方便快捷的方式来进行 RESTful API 访问和操作。使用该库可以轻松地实现HTTP请求，完成基本的 CRUD 操作以及更多高级操作，比如多个请求的串联和并行等。
安装
首先，为了使用 suren-rest 库，你需要安装它。在安装前，请确保你已经安装了 Node.js 和 npm。
使用 npm 来安装 suren-rest：
npm install suren-rest --save
在上述命令中，“--save”参数可以将安装的库信息添加到项目的 package.json 文件中，以便重新安装该库。
快速开始
使用 suren-rest 库进行 HTTP 请求很简单：
const surenRest = require('suren-rest');
surenRest.get('https://jsonplaceholder.typicode.com/todos/1')
.then(res => console.log(res))
.catch(err => console.log('出错了：', err));上述代码中，我们使用 get 方法，使用 promis 的方式来请求一个 URL（ https://jsonplaceholder.typicode.com/todos/1）。通过 then 返回 res 对象，并打印出来。如果请求失败，则错误将被捕获并打印出来。
因为该库使用了 PROMISE，所以我们可以使用 async ... await，来进行流程控制。
-- -------------------- ---- -------
----- -------- --------------- -
--- -
----- -------- - ----- ----------------------------------------------------------------------
----- ----- - ----- -----------------------------------------------------------------------------
----- ------ - ----- ------------------------------------------------------------------------------
------ -
---------
------
------
--
- ----- --- -
--------------------- ---
-
-
-----------------------------上述代码中，我们定义了一个 async 函数，getUser，该函数依次向其提供的 URL 进行请求。最终，将得到一个包含 userInfo、posts 和 albums 三个信息的对象作为返回值。如果任何一个请求失败，就会捕获错误并打印出来。
API
下列列出了 suren-rest 的主要 API，以便于使用者深入了解该库的能力。
surenRest.get(url, [options])
向指定的 URL 发送 GET 请求。支持的 option 可以有：
- headers：一个对象，包含将要发送的请求标头。
- query：一个对象，它应该包含在 URL 中的查询字符串参数。
- params：一个对象，可以用来设置请求参数。
示例：
surenRest.get('https://jsonplaceholder.typicode.com/posts/1', {
headers: { 'Content-Type': 'application/json' },
query: { id: 1, userId: 1 },
params: { name: 'Surendra Yadav', age: 29 }
})
.then(res => console.log(res))
.catch(err => console.error(err));surenRest.post(url, [data], [options])
向指定的 URL 发送 POST 请求。支持的 option 可以有：
- headers：一个对象，包含将要发送的请求标头。
- params：一个对象，可以用来设置请求参数。
示例：
-- -------------------- ---- ------- ------------------------------------------------------------ - ------ ------ ----- ------ ------- - -- - -------- - --------------- ------------------ -- ------- - ----- --------- ------- ---- -- - -- --------- -- ----------------- ---------- -- --------------------
surenRest.put(url, [data], [options])
向指定的 URL 发送 PUT 请求。支持的 option 可以有：
- headers：一个对象，包含将要发送的请求标头。
- params：一个对象，可以用来设置请求参数。
示例：
-- -------------------- ---- ------- ------------------------------------------------------------- - --- -- ------ ------ ----- ------ ------- - -- - -------- - --------------- ------------------ -- ------- - ----- --------- ------- ---- -- - -- --------- -- ----------------- ---------- -- --------------------
surenRest.delete(url, [options])
向指定的 URL 发送 DELETE 请求。支持的 option 可以有：
- headers：一个对象，包含将要发送的请求标头。
- params：一个对象，可以用来设置请求参数。
示例：
surenRest.delete('https://jsonplaceholder.typicode.com/posts/1', {
headers: { 'Content-Type': 'application/json' },
params: { name: 'Surendra Yadav', age: 29 }
})
.then(res => console.log(res))
.catch(err => console.error(err));surenRest.request(options)
发起一个通用的请求，通过设置参数来对该请求进行定制。其支持的 option 信息可以有：
- method：请求方法。'GET'、'POST'、'PUT' 或 'DELETE'。
- url：请求的 URL。
- headers：一个对象，可以携带请求标头。
- data：可以包装在请求主体中的数据。
示例：
surenRest.request({
method: 'GET',
url: 'https://jsonplaceholder.typicode.com/posts/1',
headers: { 'Content-Type': 'application/json' },
params: { name: 'Surendra Yadav', age: 29 }
})
.then(res => console.log(res))
.catch(err => console.error(err));surenRest.concat(options)
用来串联多个请求，每次只能处理一次 promise。对于多个需求，使用该 API 可以避免多次请求。
示例：
-- -------------------- ---- -------
------------------
-
------- ------
---- -----------------------------------------------
-------- - --------------- ------------------ --
------- - ----- --------- ------- ---- -- -
--
-
------- ------
---- --------------------------------------------------
-------- - --------------- ------------------ --
------- - ----- --------- ------- ---- -- -
-
--
--------- -- -----------------
---------- -- --------------------surenRest.parallel(options)
用来并行多个请求，可以一次性处理多个 promise。
示例：
-- -------------------- ---- -------
--------------------
-
------- ------
---- -----------------------------------------------
-------- - --------------- ------------------ --
------- - ----- --------- ------- ---- -- -
--
-
------- ------
---- --------------------------------------------------
-------- - --------------- ------------------ --
------- - ----- --------- ------- ---- -- -
-
--
--------- -- -----------------
---------- -- --------------------小结
使用 suren-rest 库可以让我们更轻松地使用 Node.js 进行 RESTful API 的访问和操作。使用该库，我们可以完成 HTTP 请求，完成 CRUD 操作，甚至还有一些更高级的操作，如并行和串联多个请求等。因此，suren-rest 是一个非常实用且丰富的 npm 库，值得使用。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005668781e8991b448e2bdc