在前端开发中，处理 JSON 数据是非常常见的任务。而生成 JSON Schema ，可以帮助我们更好地验证和处理数据。而 npm 包 generate-schema 可以帮助我们快速且方便地生成 JSON Schema。
安装
使用 npm 安装 generate-schema：
--- ------- ---------------
API
generate-schema 暴露了一个函数 generateSchema，该函数接受两个参数：
type：要生成的 JSON Schema 的类型。目前支持的类型有"json"、"array"和"object"。data：根据哪个数据来生成 JSON Schema。
函数返回值是生成的 JSON Schema。
生成 object 的 JSON Schema
假设我们要生成下面这个对象的 JSON Schema：
----- ---- - - ----- ----- ----- ---- --- ------ ------------------- --
我们可以这样生成 JSON Schema：
----- - -------------- - - --------------------------- ----- ------ - ------------------------ ------ --------------------
输出结果：
-
----- ---------
----------- -
----- - ----- -------- --
---- - ----- --------- --
------ - ----- --------- ------- ------- -
--
--------- - ------- ------ ------- -
-可以看到，generateSchema 函数会自动推断属性的类型，并添加必需属性的列表。
生成 array 的 JSON Schema
假设我们要生成下面这个数组的 JSON Schema：
----- ---- - --- -- ---
我们可以这样生成 JSON Schema：
----- - -------------- - - --------------------------- ----- ------ - ----------------------- ------ --------------------
输出结果：
- ----- -------- ------ - ----- --------- - -
可以看到，generateSchema 函数会自动推断数组元素的类型。
生成嵌套数据的 JSON Schema
假设我们要生成下面这个嵌套数据的 JSON Schema：
----- ---- - -
----- ----- -----
---- ---
-------- -
------- ---- ---- ----
----- ----------
------ -----
---- -------
-
--我们可以这样生成 JSON Schema：
----- - -------------- - - --------------------------- ----- ------ - ------------------------ ------ --------------------
输出结果：
-
----- ---------
----------- -
----- - ----- -------- --
---- - ----- --------- --
-------- -
----- ---------
----------- -
------- - ----- -------- --
----- - ----- -------- --
------ - ----- -------- --
---- - ----- -------- -
--
--------- - --------- ------- -------- ----- -
-
--
--------- - ------- ------ --------- -
-可以看到，generateSchema 函数可以递归地生成嵌套数据的 JSON Schema。
总结
通过这篇文章，我们学习了如何使用 generate-schema 快速且方便地生成 JSON Schema。在实际开发中，我们可以将生成的 JSON Schema 用于数据验证、文档生成等任务中。
示例代码见 GitHub 仓库 。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/45932