什么是 json-dereference-cli？
json-dereference-cli 是一个 npm 包，用来解析和展开 JSON 文件中的 $ref 引用。$ref 在 JSON 中表示引用另一个 JSON 文件的某个路径，可以使 JSON 文件更加 modulized 和可复用。json-dereference-cli 可以解析 $ref 引用，并将其展开为实际 JSON 的内容。
安装 json-dereference-cli
要安装 json-dereference-cli，首先需要在电脑上安装 Node.js 和 NPM。然后，可以通过下面的命令在终端中安装 json-dereference-cli：
--- ------- -- --------------------
安装完成后，就可以在终端中运行 json-dereference-cli。
使用 json-dereference-cli
json-dereference-cli 的使用非常简单，只需要在终端中输入以下命令：
-------------------- --------- ------
其中，[options] 是可选参数，可以用来指定输出格式和一些其他选项。<file> 则是必选参数，表示要解析和展开的 JSON 文件的文件名或文件路径。
输出格式
json-dereference-cli 支持多种输出格式，可以通过 -f 或 --format 参数指定。支持的输出格式有：
json：默认格式。输出展开后的 JSON。yaml：输出展开后的 YAML。json-schema：输出展开后的 JSON Schema。json-schema-draft-06：输出 Draft 06 的 JSON Schema。json-schema-draft-07：输出 Draft 07 的 JSON Schema。
例如，要将一个 JSON 文件展开为 YAML 格式，可以输入以下命令：
-------------------- -- ---- ---------
inline 引用
json-dereference-cli 还支持 inline 引用。inline 引用是一种技术，它允许在 JSON 文件中嵌入其他 JSON 片段，以复用和模块化 JSON 文件的结构和内容。
要使用 inline 引用，只需要在 JSON 文件中添加 $ref 属性和 $id 属性即可。$id 指定当前 JSON 片段的唯一标识符，$ref 则指向要引用的 JSON 片段的 $id。code.demo.json：
-
------ --------------------------------
------- ----- --------
------------- -
------ -
------ -------
------- --------
--
------ -
------- ------
-
-
-在上面的例子中，$id 指定了当前 JSON 的唯一标识符，foo 属性的 $id 指定了它的标识符，而 bar 属性的 $ref 指向 foo 属性的 $id。这种形式的引用就是 inline 引用。
如果要使用 inline 引用，需要在运行 json-dereference-cli 命令时指定 --inline 参数，例如：
-------------------- -------- -- ---- --------------
综合示例
下面是一个综合的使用示例。
假设有以下两个 JSON 文件：
user.json：
-
------ --------------------------------
------- -
------ --------
------- --------
--
---------- -
------- ---------
------------- -
--------- -
------ ----------
------- --------
--
------- -
------- --------
--
-------- -
------- --------
-
--
----------- ---------- ------- --------
-
-order.json：
-
------ ---------------------------------
-------- -
------- --------
-------- -
------- ---------
------------- -
---------- -
------- --------
--
----------- -
------- ---------
--
-------- -
------- --------
--
-------- -
------- -------------------------------------
--
------------------- -
------- ----------------------------------------
-
--
----------- ----------- ----------- -------- -------- -------------------
-
-
-其中，order.json 中使用了 inline 引用来复用 user.json 中定义的部分内容。
现在，要将 order.json 文件展开为 JSON 形式，并输出到控制台，可以输入以下命令：
-------------------- -------- -- ---- ----------
输出结果如下：
-
-------- -
------- --------
-------- -
------- ---------
------------- -
---------- -
------- --------
--
----------- -
------- ---------
--
-------- -
------- --------
--
-------- -
------- --------
--
------------------- -
------- ---------
------------- -
--------- -
------- --------
--
------- -
------- --------
--
-------- -
------- --------
-
--
----------- -
---------
-------
-------
-
-
--
----------- -
----------
-----------
--------
--------
------------------
-
-
-
-可以看到，inline 引用已经被展开为实际的 JSON 内容。
总结
json-dereference-cli 是一个非常实用的 npm 包，它可以帮助开发者轻松解析和展开 JSON 文件中的 $ref 引用。在开发过程中，经常会遇到需要复用和模块化 JSON 内容的情况，使用 json-dereference-cli 可以帮助开发者更加高效地完成开发任务，提高代码质量和可复用性。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/60055cf581e8991b448da912