在构建任何 Web 应用程序时，请求验证是一个不可或缺的步骤。Fastify 是一个快速且低开销的 Web 框架，它提供了各种功能来帮助开发人员进行请求验证。其中一种功能是使用 JSON Schemas 来验证请求体和查询参数。在这篇文章中，我们将探讨如何在 Fastify 中使用 JSON Schemas 进行请求验证。
什么是 JSON Schemas？
JSON Schemas 是一个用于定义 JSON 数据结构的规范。它定义了 JSON 对象的属性、数据类型和可接受的值范围。使用 JSON Schemas 可以确保数据在传输时符合特定的格式和结构，从而减少人为错误和数据丢失。
JSON Schemas 遵循 JSON 格式，通常由以下部分组成：
$schema：JSON Schemas 的版本和规范。title：JSON Schemas 的标题。description：JSON Schemas 的描述。type：JSON Schemas 的数据类型。properties：JSON 对象的属性和属性值。required：所需的属性列表。
在 Fastify 中使用 JSON Schemas 进行请求验证
在 Fastify 中，您可以使用 fastify-json-schema 插件来进行请求体和查询参数的 JSON Schemas验证。这可以确保请求数据与您的 API 的预期格式匹配，并提醒您需要更改的任何方面。以下是在 Fastify 中进行请求验证的基本步骤：
- 使用
fastify-json-schema插件。需要安装并注册这个插件。npm install fastify-json-schema。 - 声明 JSON Schemas。
- 将 JSON Schemas 与 Fastify 路由中的特定项配对。
现在，让我们看一个使用 JSON Schemas 的示例。假设我们有一个 POST 端点，可以根据客户的名称创建新的用户。首先，我们需要声明一个 JSON Schemas，该 Schemas 描述了所需的数据格式。以下代码片段定义了一个 JSON Schemas，如下所示：
-- -------------------- ---- -------
-
---------- ------------------------------------------
------- ---------
----------- ------------------
------------- -
---------------- -
------- ---------
------------ -
--
----------------- -
------- ---------
--------- -------
--
----------------- -
------- ---------
---------- ------------------------
-
-
-该 JSON Schemas 定义了一个对象，该对象具有以下三个属性：
customer_name（必填）：字符串类型，最小长度为 1。customer_email：字符串类型，必须为电子邮件格式。customer_phone：字符串类型，必须匹配 "###-###-####" 格式。
接下来，将该 JSON Schemas 与 Fastify 路由一起使用。示例代码如下所示：
-- -------------------- ---- -------
----- ------- - ---------------------
-------------------------------------------------
----- ---------------- - -
----- -
----- ---------
--------- ------------------
----------- -
-------------- - ----- --------- ---------- - --
--------------- - ----- --------- ------- ------- --
--------------- - ----- --------- -------- ------------------------ --
--
--
--
--------------------- - ------- ---------------- -- ----- --------- ------ -- -
-- ----
---在此示例中，createUserSchema 是一个对象字面量，其中包含名为 body 的属性。该 body 属性包含描述我们在前面自定义的 JSON Schemas。通常，每个请求类型（POST、GET、PUT 等）都会带有一个 Schemas 对象，其中包含请求体和查询参数定义。
结论
在 Fastify 中使用 JSON Schemas 进行请求验证是一种实现规范结构的便捷方法。通过在您的代码中集成 JSON Schemas，可以确保数据在传输时符合特定的格式和结构。这不仅有助于减少人为错误，还有助于提高数据一致性和可读性。
在您的项目中使用 JSON Schemas 进行验证可使您的团队在整个应用程序中相互协作，并确保符合统一的代码格式和结构。希望这篇文章对您有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/67315b870bc820c582388103