简介
在前端开发中，经常需要对所定义的数据结构进行验证。其中，jsonschema 是一种比较受欢迎的格式，它可以描述 JSON 数据的结构，以便进行验证。而 jsonschema-markdown 就是一个 npm 包，它可以根据 jsonschema 自动生成文档，为开发者提供更方便的查询与阅读。
本文将介绍如何使用 jsonschema-markdown，帮助读者快速了解如何安装及使用该 npm 包。
安装
npm 包 jsonschema-markdown 可以通过 npm 安装。请在项目文件夹中运行以下代码：
npm install jsonschema-markdown --save-dev
使用
使用 jsonschema-markdown 首先需要明确两点：
- 所有 jsonschema 文件必须存放在指定的目录中。
- 需要在项目的 package.json 文件中配置 jsonschema-markdown 的设置。
下面，我们来看一下具体的用法。
配置
首先，在项目的 package.json 文件中添加以下代码：
-- -------------------- ---- -------
-
--------------------- -
--------- ----------
------- ----------------------
----------- -------------------------------------------------------
----------- -----
--------- -
------- ------
---------- -----------------------
-
-
-source是指定存放 jsonschema 文件的目录，默认是schemas。docs是指定生成文档的路径及文件名，默认是docs/schema-docs.md。template是指定模板文件，可根据需要修改模板，默认使用node_modules/jsonschema-markdown/templates/clean.hbs。validate可以控制 jsonschema 是否启用验证，默认为true，即启用验证。filter可以根据需要对特定属性进行过滤。在本例中，我们使用了一个简单的例子来说明设置字符串正则表达式为特定属性。示例中表示属性price必须是两位小数或整数。
值得一提的是，jsonschema-markdown 支持直接在 .json 文件中嵌入注释，那么这些注释也将被用于文档生成。
生成文档
在配置完成后，我们可以在命令行中执行以下内容，以生成相应的文档：
jsonschema-markdown
如此便可以在 package.json 中指定的路径下找到生成的文档了。文档会包含我们在 jsonschema 中定义的所有限制和注释。在实际开发中，我们很容易发现在有了这个 npm 包之后，我们再也不需要手工编写令人头疼的数据结构文档了。
示例代码
以下是一个示例 jsonschema 文件，其中包含了一些基本的数据类型，如字符串、数字和布尔值：
-- -------------------- ---- -------
-
------- ---------
------------- -
------- -
------- ---------
-------------- ---- ---- -- --- ------
--
------ -
------- ---------
-------------- ---- --- -- --- ------
--
--------- -
------- ----------
-------------- ---- ------ -- --- ------
-
--
----------- -------- ------ ---------
-在使用 jsonschema-markdown 生成文档后，我们可以得到类似以下的内容：
-- -------------------- ---- -------
- --------------------
------------
-
---------- -----------------------------------------
------- ---------
------------- -
------- -
------- ---------
-------------- ---- ---- -- --- ------
--
------ -
------- ---------
-------------- ---- --- -- --- ------
--
--------- -
------- ----------
-------------- ---- ------ -- --- ------
-
--
----------- -------- ------ ---------
-
-------------可以看到，jsonschema-markdown 生成的文档是很详细的，并且可以帮助开发人员更好地了解数据结构的定义。因此，jsonschema-markdown 是一款非常有用的 npm 包，可以提高开发效率，减少开发中的交流成本。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005517e81e8991b448ced00