如今,大多数 Web 应用程序都依赖于 REST API。它是一种使应用程序组件之间相互通信的通用方法。REST API 已成为现代应用程序中的核心技术,并始终被广泛使用。在本文中,我们将介绍如何使用 Fastify 和 Joi 构建完善的 RESTful API。
Fastify 是什么?
Fastify 是一个快速、低开销的 Web 框架,专门设计用于构建高效的 RESTful API。它是用 Node.js 实现的,并且使用了底层的 V8 引擎的高性能。Fastify 是一个高性能 Web 框架,能够处理大量的请求和响应。
Joi 是什么?
Joi 是一个 JavaScript 对象校验库,用于对客户端和服务器端数据进行校验。它是一个易于理解的、可扩展的校验器,可以用于 HTTP 请求和响应的实体。
构建 RESTful API 的步骤
下面是使用 Fastify 和 Joi 构建 RESTful API 的步骤:
第 1 步:安装 Fastify 和 Joi
首先,我们需要安装 Fastify、Joi 和相关依赖。我们可以使用 NPM 来安装这些依赖。我们打开终端并进入项目目录,然后运行以下命令:
npm install fastify @hapi/joi fastify-cors
第 2 步:创建 Fastify 应用程序
在项目根目录中,我们创建一个名为 app.js
的文件,并运行以下命令创建一个新的 Fastify 应用程序:
-- -------------------- ---- ------- ----- ------- - -------------------- ------- ---- --- -- ------ ---------------- ----- --------- ------ -- - ------ - ------ ------- - --- -- ----------- ----- ----- - ----- -- -- - --- - ----- --------------------- ------------------------ --------- -- ----------------------------------- - ----- ----- - ----------------------- ---------------- - -- -- ----- --- ------ --------
上面的代码演示了如何创建一个 Fastify 应用程序,定义一个路由处理程序和监听应用程序端口的方法。
第 3 步:编写路由处理程序
在我们使用 Joi 编写路由处理程序之前,我们需要了解 Fastify 的路由处理程序。在 Fastify 中,路由处理程序是一种用于处理 HTTP 请求和响应的方法。我们在路由处理程序中定义了我们的业务逻辑。以下是一个简单的目录处理程序:
-- -------------------- ---- ------- ------------------------- ----- --------- ------ -- - ------ - - ----- --------- -- - ----- --------- - - --
第 4 步:使用 Joi 访问请求负载
现在我们已经定义了路由处理程序,我们可以使用 Joi 来访问请求有效载荷并对其进行校验。Joi 使我们能够轻松访问请求的有效载荷数据,并允许我们在接收数据之前对数据进行有效性验证。
在以下示例中,我们使用 Joi 检查传递的有效载荷是否包含以下属性:firstName
、lastName
、email
和 mobile
。如果有效载荷中任何一个属性缺失,Joi 将抛出一个错误。
-- -------------------- ---- ------- --------------------- - ------- - ----- ------------ ---------- ------------------------ --------- ------------------------ ------ -------------------------------- ------- ----------------------- -- - -- ----- --------- ------ -- - ----- - ---------- --------- ------ ------ - - ------------ -- ------------------ -- ------ ------ - ------- ----- ----- - ---------- --------- ------ ------ - - --
第 5 步:使用 Joi 访问请求参数
在上述示例中,我们使用了 Joi.object()
和 Joi.string()
等方法来访问请求的有效载荷属性。类似地,我们可以使用 Joi
辅助对象来访问请求的参数。
以下示例演示如何使用 Joi 访问请求参数:
-- -------------------- ---- ------- ------------------------ - ------- - ------- ------------ --- -------------------------------------- -- - -- ----- --------- ------ -- - ----- - -- - - -------------- -- ------- -- ------ ------ - ------- ----- ----- - -- - - --
第 6 步:使用 Fastify 插件
Fastify 插件是一种可扩展的方式,可以在 Fastify 应用程序中引入新功能。例如,在许多 API 中,您可能需要使用 CORS 中间件。为此,我们可以使用 fastify-cors
插件来处理所有跨域请求。以下是如何使用 fastify-cors
插件实现的:
-- -------------------- ---- ------- ----- ------- - -------------------- ------- ---- --- ----------------------------------------- - ------- ------------------ --- ---------------- ----- --------- ------ -- - ------------ ------ ------- --- --- ----- ----- - ----- -- -- - --- - ----- --------------------- ------------------------ --------- -- ----------------------------------- - ----- ----- - ----------------------- ---------------- - -- --------
结论
在本文中,我们了解了如何使用 Fastify 和 Joi 构建 RESTful API。我们学习了如何使用 Fastify 来创建应用程序、定义路由处理程序和监听端口。我们还深入研究了如何使用 Joi 来访问请求的有效载荷和参数,并进行数据校验。最后,我们还了解了如何使用 Fastify 插件来扩展 Fastify 应用程序的功能。这些技术的结合使用将使我们的应用程序更加健壮、可扩展和易维护。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/66fd1cc44471362601787b1e