什么是 metabin-schema-validator
metabin-schema-validator 是一个基于 JSON schema 规范的元数据校验工具，它可以帮助前端开发者进行元数据验证，帮助减少开发中出现的数据错误和异常，提高前端开发效率。
metabin-schema-validator 的使用方法
安装
首先需要安装 Node.js 以及 npm 包管理器，安装完成后可以通过以下命令安装 metabin-schema-validator：
npm install -g metabin-schema-validator
使用
metabin-schema-validator 有两种使用方式，一种是将校验规则与数据分别保存在两个 JSON 文件中，然后通过命令行的方式执行校验；另一种是将校验规则与数据保存在一个 JSON 文件中，通过 JavaScript 代码调用 API 进行校验。
下面我们分别来介绍这两种使用方式。
通过命令行执行校验
在使用此方式前，需要准备两个 JSON 文件，一个是元数据校验规则文件，一个是需要校验的文件。校验规则文件需要遵循 JSON schema 规范，具体规范可以参考 JSON schema 官方文档。
假设我们有以下的校验规则文件 schema.json，用于校验学生信息：
-- -------------------- ---- -------
-
---------- ------------------------------------------
------- ---------
------------- -
------- -
------- ---------
------------ --
------------ --
--
------ -
------- ----------
---------- ---
---------- --
--
--------- -
------- ---------
------- -------- ---------
-
--
----------- -------- ------ ---------
-还有以下的校验数据文件 data.json，待校验的学生信息：
{
"name": "小王",
"age": 20,
// 缺少 gender 字段
"score": 88
}接下来，我们就可以通过以下命令执行校验：
metabin-schema-validator schema.json data.json
执行结果如下：
error: data.gender is a required property
表示 data.json 文件缺少 gender 字段。
通过 JavaScript 代码调用 API 进行校验
在使用此方式前，需要准备一个包含校验规则以及需要校验的数据的 JSON 文件，然后通过 JavaScript 代码调用 metabin-schema-validator 校验。
假设我们有以下的校验文件 data.json，其中包含了校验规则以及需要校验的学生信息：
-- -------------------- ---- -------
-
---------- ------------------------------------------
------- ---------
------------- -
------- -
------- ---------
------------ --
------------ --
--
------ -
------- ----------
---------- ---
---------- --
--
--------- -
------- ---------
------- -------- ---------
-
--
----------- -------- ------ ----------
----------------------- ------
-------- -
- ------- ---------------------------- --
- ------- ---------------------------- -
-
-我们可以通过以下 JavaScript 代码来调用 metabin-schema-validator 进行校验：
-- -------------------- ---- -------
----- --------- - ------------------------------------
--- ---- - -
------- -----
------ ---
-- -- ------ --
-------- --
--
--- ------ - -
---------- ------------------------------------------
------- ---------
------------- -
------- -
------- ---------
------------ --
------------ --
--
------ -
------- ----------
---------- ---
---------- --
--
--------- -
------- ---------
------- -------- ---------
-
--
----------- -------- ------ ----------
----------------------- ------
-------- -
- ------- ---------------------------- --
- ------- ---------------------------- -
-
--
------------------------ ------- ---------------- ------ -
-- -------- -
----------------------
-
-- ------- -
----------------------
- ---- -
----------------------
-
---执行结果如下：
-- -------------------- ---- -------
-
-------- --------
---------- -------- -------- --------- -------------
------- -
-------
--------
-
-
------这里我们使用了 metabin-schema-validator 提供的 validate API 进行校验，如果出现错误会将错误信息打印出来。
总结
本文介绍了 npm 包 metabin-schema-validator 的使用方法，包括通过命令行和 JavaScript 代码调用 API 两种方式。通过学习本文，我们可以更方便地进行元数据校验，并且可以提高开发效率，降低数据错误发生的概率。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005622c81e8991b448df815