在前端开发中，我们经常需要和后端进行交互，而 RESTful API 是现在比较流行的交互方式。为了方便地创建 RESTful API，我们可以使用 descanso 这个 npm 包。本篇文章将详细介绍 descanso 的使用方法，并给出示例代码。
什么是 descanso？
descanso 是一个用于创建 RESTful API 的 Node.js 模块。它基于 Express 库，提供了一些工具函数和中间件，让我们可以方便地实现 RESTful API 中的常见功能，如路由映射、参数验证、错误处理等。
如何使用 descanso？
安装 descanso
使用 npm 安装 descanso 包：
npm install descanso --save
创建 RESTful API
在 Express 应用程序中引入 descanso：
const express = require('express')
const descanso = require('descanso')
const app = express()
app.use(express.json())
app.use(descanso())其中，express.json() 中间件用于解析请求体中的 JSON 数据。descanso() 函数返回一个中间件，用于处理 RESTful API 相关的请求，如路由映射、参数验证、错误处理等。
接下来，我们可以利用 descanso 提供的 API 创建 RESTful API：
-- -------------------- ---- ------- -- ------ ---------------------- ----- ---- -- - -- --------- -- -- ------ -------------------------- ----- ---- -- - -- --------- -- -- ---- ----------------------- ----- ---- -- - -- ------- -- -- ------ -------------------------- ----- ---- -- - -- --------- -- -- ------ ----------------------------- ----- ---- -- - -- --------- --
其中，descanso.get()、descanso.post()、descanso.put()、descanso.delete() 函数分别用于处理对应的 HTTP 方法请求，并设置对应的路由。
路由中可以使用 : 符号指定参数，并在回调函数中通过 req.params 获取对应的参数值，例如 /users/:id 中的 :id 参数可以通过 req.params.id 获取。
处理请求参数
descanso 还提供了一些工具函数，用于验证请求参数。例如，我们可以使用 descanso.query() 验证查询参数，使用 descanso.body() 验证请求体参数：
-- -------------------- ---- -------
-- ------
--------------------------
----------------
------- ------ --------- --------- ------
-------- ------ --------- -------- ----------
---
----- ---- -- -
-- ---------
----- -- - -------------
----- ------ - ----------------
----- ------- - -----------------
--上述代码中，descanso.query() 用于验证查询参数，并且规定了两个参数：fields 和 include，其中 fields 参数是必需的，类型为字符串；include 参数可选，类型为字符串，默认值为 'profile'。如果查询参数不符合要求，descanso.query() 将自动返回错误响应。如果查询参数符合要求，则可以在回调函数中获取对应的参数值。
类似地，可以使用 descanso.body() 验证请求体参数：
-- -------------------- ---- -------
-- ----
-----------------------
---------------
----- ------ --------- --------- ------
---- ------ --------- --------- ----- ---- ----
------ ------ --------- ------- --------
---
----- ---- -- -
-- -------
----- ---- - -------------
----- --- - ------------
----- ----- - --------------
--上述代码中，descanso.body() 用于验证请求体参数，并且规定了三个参数：name、age、email。其中，name 和 age 参数是必需的。age 参数的类型为数字，且不小于 18。email 参数的类型为字符串，且符合 email 格式。如果请求体参数不符合要求，descanso.body() 将自动返回错误响应。如果请求体参数符合要求，则可以在回调函数中获取对应的参数值。请注意，req.body 中的参数必须是 JSON 数据格式。
异常处理
在 RESTful API 中，异常处理是必需的，否则会向客户端返回不必要的错误信息。descanso 提供了 descanso.catch() 中间件，用于捕获异常并返回标准格式的错误响应。我们只需要在 descanso 中间件后添加 descanso.catch() 中间件即可：
-- -------------------- ---- -------
----- --- - ---------
-----------------------
-------------------
-------------------------
-- ------
--------------------------
----------------
------- ------ --------- --------- ------
-------- ------ --------- -------- ----------
---
----- ---- -- -
-- ---------
----- -- - -------------
----- ------ - ----------------
----- ------- - -----------------
-- ------
----- --- ---------------
--在上述代码中，我们手动抛出了一个错误异常。descanso.catch() 会捕获这个异常，并返回一个标准格式的错误响应：
{
"error": {
"code": 500,
"message": "获取用户失败"
}
}示例代码
下面是一个完整的示例代码，按照上述方式创建 RESTful API：
-- -------------------- ---- -------
----- ------- - ------------------
----- -------- - -------------------
----- --- - ---------
-----------------------
-------------------
-------------------------
-- ---------
----- -- - -
---- ---- ---- ----- ----- ---- --- ------ ------------------------
---- ---- ---- ----- ----- ---- --- ------ --------------------
---- ---- ---- ----- ----- ---- --- ------ ---------------------
-
-- ------
---------------------- ----- ---- -- -
----- ----- - -----------------
--------------- -------
--
-- ------
--------------------------
----------------
------- ------ --------- --------- ------
-------- ------ --------- -------- ----------
---
----- ---- -- -
----- -- - -------------
----- ------ - ----------------
----- ------- - -----------------
----- ---- - ------
-- ------ -
--------------- ------
- ---- -
----- --- --------------
-
--
-- ----
-----------------------
---------------
----- ------ --------- --------- ------
---- ------ --------- --------- ----- ---- ----
------ ------ --------- ------- --------
---
----- ---- -- -
----- -- - ---------------------
----- ---- - -------------
----- --- - ------------
----- ----- - --------------
----- ---- - ---- ----- ---- ------
------ - ----
--------------------------- ------
--
-- ------
--------------------------
---------------
----- ------ --------- --------- ------
---- ------ --------- --------- ----- ---- ----
------ ------ --------- ------- --------
---
----- ---- -- -
----- -- - -------------
----- ---- - -------------
----- --- - ------------
----- ----- - --------------
----- ---- - ------
-- ------ -
--------- - ----
-------- - ---
---------- - -----
--------------- ------
- ---- -
----- --- --------------
-
--
-- ------
----------------------------- ----- ---- -- -
----- -- - -------------
----- ---- - ------
-- ------ -
------ ------
------------
- ---- -
----- --- --------------
-
--
-- ----
----- ---- - ---------------- -- ----
---------------- -- -- ---------------------- -- ---- ----------上述代码中，我们模拟了一个数据仓库，使用 descanso 创建了一个简单的 RESTful API，包括获取所有用户、获取指定用户、创建用户、更新指定用户、删除指定用户等功能。我们还使用了 descanso.query() 和 descanso.body() 来验证请求参数，使用 descanso.catch() 捕获异常。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005675181e8991b448e3cf1