RESTful API 是现代 Web 应用中最常见的 API 设计风格。它的优点在于简单、灵活和易于扩展。使用 Hapi 和 hapi-swagger 插件可以轻松地构建 RESTful API，本文将介绍如何使用它们来构建高质量的 API。
Hapi 简介
Hapi 是一个 Node.js Web 框架，它的设计目标是提供一个可靠、可扩展、可测试的基础架构，以便构建 Web 应用程序和服务。它提供了许多有用的功能，例如路由、请求处理、插件系统等。
以下是一个简单的 Hapi 应用程序示例：
-- -------------------- ---- -------
----- ---- - ----------------------
----- ------ - -------------
----- -----
----- -----------
---
--------------
------- ------
----- ----
-------- --------- -- -- -
------ ------ --------
-
---
----- -------- ------- -
----- ---------------
------------------- ------- --- ---------------------
-
--------在上面的示例中，我们创建了一个 Hapi 服务器，并定义了一个路由，用于处理 HTTP GET 请求。当我们访问根路由时，服务器将返回“Hello World!”。
hapi-swagger 简介
hapi-swagger 是一个 Hapi 插件，用于自动生成 API 文档。它可以自动从代码中提取路由信息，并生成符合 Swagger 规范的文档，包括 API 描述、请求参数、响应格式等。它还提供了一个交互式的 UI，可以帮助开发人员更好地了解和测试 API。
以下是一个简单的 hapi-swagger 插件示例：
-- -------------------- ---- -------
----- ---- - ----------------------
----- ----- - -----------------------
----- ------ - ------------------------
----- ----------- - ------------------------
----- ------ - -------------
----- -----
----- -----------
---
----- -------------- - -
----- -
------ --- --- ---------------
-------- -------
-
--
----- ---- - ----- -- -- -
----- -----------------
------
-------
-
------- ------------
-------- --------------
-
---
--------------
------- ------
----- ----
-------- --------- -- -- -
------ ------ --------
--
-------- -
----- --------
------------ ---- -------
------ -------- - -------- --------
-
---
----- ---------------
------------------- ------- --- ---------------------
--
-------在上面的示例中，我们首先注册了 Inert 和 Vision 插件，它们是 hapi-swagger 插件所依赖的插件。然后，我们注册了 hapi-swagger 插件，并传递了一些选项。最后，我们定义了一个路由，并添加了一些元数据，用于生成 API 文档。
构建 RESTful API
现在，我们来看一下如何使用 Hapi 和 hapi-swagger 插件来构建一个简单的 RESTful API。我们将创建一个 CRUD API，用于管理用户信息。
数据库设置
我们将使用 MongoDB 作为我们的数据库，使用 Mongoose 作为 MongoDB 的 ODM（对象文档映射）。首先，我们需要安装 Mongoose：
npm install mongoose
然后，我们需要连接到 MongoDB 数据库：
-- -------------------- ---- ------- ----- -------- - -------------------- --------------------------------------------------- - ---------------- ----- ------------------- ---- ---------- -- - ---------------------- -- ---------- ---------------- -- - ------------------ ---------- -- --------- ------- ---
定义模型
我们将定义一个 User 模型，用于存储用户信息。在 models/user.js 文件中，我们可以这样定义模型：
-- -------------------- ---- -------
----- -------- - --------------------
----- ---------- - --- -----------------
----- -
----- -------
--------- ----
--
------ -
----- -------
--------- -----
------- ----
--
--------- -
----- -------
--------- ----
--
---------- -
----- -----
-------- --------
--
---------- -
----- -----
-------- --------
-
---
-------------- - ---------------------- ------------在上面的示例中，我们定义了一个 userSchema，它包含了 name、email、password、createdAt 和 updatedAt 字段。我们还导出了一个 User 模型，它将使用这个 schema。
创建路由
我们将创建以下路由来处理用户数据：
- GET /users：获取所有用户列表
- POST /users：创建一个新用户
- GET /users/{id}：获取一个用户的详细信息
- PUT /users/{id}：更新一个用户的详细信息
- DELETE /users/{id}：删除一个用户
在 routes/users.js 文件中，我们可以这样定义路由：
-- -------------------- ---- -------
----- --- - ---------------------
----- ---- - --------------------------
-------------- - -
-
------- ------
----- ---------
-------- ----- --------- -- -- -
----- ----- - ----- ------------
------ ------
--
-------- -
----- --------
------------ ---- --- -------
------ -------- - ---- -- --- ------
-
--
-
------- -------
----- ---------
-------- ----- --------- -- -- -
----- ---- - --- ----------------------
----- ------------
------ -----
--
-------- -
----- --------
------------ ------- - --- ------
------ -------- - --- ---- ---- --- ----- ---------
--------- -
-------- ------------
----- ------------------------
------ --------------------------------
--------- -----------------------
--
-
-
--
-
------- ------
----- --------------
-------- ----- --------- -- -- -
----- ---- - ----- ---------------------------------
------ -----
--
-------- -
----- --------
------------ ---- - ---- -- ----
------ -------- - ---- ---- --- ----- ----
--------- -
------- ------------
--- -----------------------
--
-
-
--
-
------- ------
----- --------------
-------- ----- --------- -- -- -
----- ---- - ----- ----------------------------------------- ---------------- - ---- ---- ---
------ -----
--
-------- -
----- --------
------------ ------- - ---- -- ----
------ -------- - ---- ---- --- ----- ----
--------- -
------- ------------
--- -----------------------
---
-------- ------------
----- -------------
------ ---------------------
--------- ------------
--
-
-
--
-
------- ---------
----- --------------
-------- ----- --------- -- -- -
----- ---- - ----- ------------------------------------------
------ -----
--
-------- -
----- --------
------------ ------- - ---- -- ----
------ -------- - ---- ---- --- ----- ----
--------- -
------- ------------
--- -----------------------
--
-
-
-
--在上面的示例中，我们定义了五个路由，每个路由都有一个处理程序和一些元数据。我们使用 Joi 来验证请求参数和负载，以确保输入数据的正确性。我们还在每个路由的元数据中添加了一些描述信息，以便生成文档。
启动应用程序
最后，我们将所有的路由注册到 Hapi 服务器，并启动服务器：
-- -------------------- ---- -------
----- ---- - ----------------------
----- ----- - -----------------------
----- ------ - ------------------------
----- ----------- - ------------------------
----- ------ - --------------------------
----- ------ - -------------
----- -----
----- -----------
---
----- -------------- - -
----- -
------ --- --- ---------------
-------- -------
-
--
----- ---- - ----- -- -- -
----- -----------------
------
-------
-
------- ------------
-------- --------------
-
---
---------------------
----- ---------------
------------------- ------- --- ---------------------
--
-------在上面的示例中，我们首先注册了 Inert 和 Vision 插件，它们是 hapi-swagger 插件所依赖的插件。然后，我们注册了 hapi-swagger 插件，并传递了一些选项。接下来，我们将所有的路由注册到 Hapi 服务器中。最后，我们启动服务器并输出服务器的 URL。
结论
在本文中，我们介绍了如何使用 Hapi 和 hapi-swagger 插件来构建 RESTful API。我们展示了如何连接到 MongoDB 数据库、定义模型、创建路由以及生成 API 文档。我们希望这篇文章能够帮助你更好地理解如何使用 Hapi 和 hapi-swagger 插件来构建高质量的 API。如果你有任何问题或建议，请在评论中留言。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/676a1e6244e319dee41a4999