介绍
npm 包 express-apis 是一个用于快速搭建 RESTful APIs 的中间件，它基于 Express 框架开发，使得我们可以更加便捷地构建 Web 服务。本文将会详细介绍如何使用 express-apis。
安装
使用 npm 安装 express-apis：
npm i express-apis
快速上手
搭建一个简单的服务器
以下是一个简单的例子，使用 express-apis 搭建一个 Web 服务器：
-- -------------------- ---- ------- ----- ------- - ------------------- ----- ------ - -------------------- ----- ----------- - ------------------------ ----- --- - ---------- ------------------------ -- ---------------------- ---------------------------- --------- ----- ---- -- ---------------------- ----------------------------- -- -- ------------ --- ---------------- -- -- ------------------- -- ------- -- -------------------------
这个例子中，我们首先引入了 express 库和我们后面定义的路由，然后使用 expressApis 中间件来注册路由，最后启动服务器并监听端口。这段代码将会在 http://localhost:3000 上启动一个简单的 Web 服务器。
定义路由
我们需要在 routes.js 文件中定义路由，这个例子中我们定义了一个 GET 请求：
-- -------------------- ---- -------
-------------- - -
-
------- ------
----- ---------
-------- ----- ---- -- -
----- ----- - -
- --- -- ----- ----- --
- --- -- ----- ------- --
--
----------------
--
--
--其中 method 为 HTTP 方法，path 为路由路径，handler 为路由处理函数。在这个例子中，我们定义了一个 GET 请求，路径为 /users，handler 将会返回一个包含两个用户对象的 JSON，响应头中的 Content-Type 将会是 application/json。
发送请求
我们可以使用 curl 发送一个 GET 请求，或者使用 Postman 等工具：
curl http://localhost:3000/users
这样我们就可以通过 express-apis 来快速地搭建一个简单的 Web 服务器，并处理请求。
处理请求
获取请求参数
我们可以使用 req.params 获取 URL 中的参数，使用 req.query 获取查询字符串中的参数。以下是一个例子：
-- -------------------- ---- -------
-------------- - -
-
------- ------
----- -------------
-------- ----- ---- -- -
----- ------ - --------------
----- - - ------------
---------- ------- - ---
--
--
--在这个例子中，我们使用了 req.params 和 req.query 来获取 URL 参数和查询字符串参数，然后将它们返回为 JSON 格式。
处理请求头
我们可以使用 req.headers 获取请求头。以下是一个例子：
-- -------------------- ---- -------
-------------- - -
-
------- ------
----- -----------
-------- ----- ---- -- -
----- ------- - ------------
------------------
--
--
--在这个例子中，我们使用了 req.headers 来获取请求头，然后将它们返回为 JSON 格式。
处理请求体
我们可以使用 req.body 获取请求体。以下是一个例子：
-- -------------------- ---- -------
-------------- - -
-
------- -------
----- ---------
-------- ----- ---- -- -
----- ---- - ---------
------------------
---------- -------- --------- ---
--
--
--在这个例子中，我们使用了 req.body 来获取请求体，然后将它们打印输出，最后返回一个包含 'success' 的 JSON 响应体。
处理响应
设置响应状态码和响应头
我们使用 res.status 设置响应状态码，使用 res.set 设置响应头。以下是一个例子：
-- -------------------- ---- -------
-------------- - -
-
------- ------
----- ---------
-------- ----- ---- -- -
----- ----- - -
- --- -- ----- ----- --
- --- -- ----- ------- --
--
------------------------------------ ---------------
--
--
--在这个例子中，我们使用了 res.status 来设置状态码为 200，使用 res.set 来设置 'X-Total-Count' 响应头，最后将 users 打包为 JSON 响应体返回。
处理错误
我们可以使用 try-catch 来处理错误，并使用 res.status 和 res.json 返回错误。以下是一个例子：
-- -------------------- ---- -------
-------------- - -
-
------- -------
----- ---------
-------- ----- ---- -- -
--- -
----- ---- - ---------
-- ------------ -
----- --- ----------- ---- -- -----------
-
------------------
---------- -------- --------- ---
- ----- ----- -
---------------------- -------- ----------- ---
-
--
--
--在这个例子中，我们首先使用 try-catch 来捕获错误，如果 user.name 不存在，我们将抛出一个 Error，并返回一个状态码为 400 的 JSON 响应体。
总结
在本文中，我们学习了如何使用 npm 包 express-apis 来快速搭建 RESTful APIs。我们了解了如何处理请求和响应，如何设置状态码和响应头，如何处理错误等。希望这篇文章对你有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005662d81e8991b448e2095