在前端开发中，我们经常需要使用 TypeScript 来规范化项目的代码，而 JSON Schema 则是一种用于描述 JSON 数据格式的语言。那么如何将 TypeScript 类型自动生成 JSON Schema 呢？这时候就可以使用 ts-json-schema-generator 这个 npm 包来帮助我们快速生成 JSON Schema。
安装
安装 ts-json-schema-generator 很简单，只需要在终端输入以下命令即可：
npm install -g ts-json-schema-generator
这样就可以全局安装 ts-json-schema-generator 了，也可以在项目中使用本地安装。
使用
在命令行中输入以下命令来生成 JSON Schema：
ts-json-schema-generator path/to/file.ts -p
path/to/file.ts是用来生成 JSON Schema 的类或接口所在的文件路径，-p参数表示不要将接口或类的名字作为根节点输出，而是直接输出类或接口的结构。根据生成的 JSON Schema 对数据进行格式验证。我们经常使用一些工具来对请求或响应数据进行格式验证，例如 Ajv。
下面我们来看一个具体的示例，假设有以下一个 Person 类：
-- -------------------- ---- -------
--------- ------ -
----- -------
---- -------
------- ------ - ---------
-------- ---------
-------- -
------- -------
----- -------
------ -------
---- -------
--
-我们可以将这个类转换为 JSON Schema，使用以下命令：
ts-json-schema-generator path/to/person.ts
输出结果如下：
-- -------------------- ---- -------
-
------- ---------
------------- -
------- -
------- --------
--
------ -
------- --------
--
--------- -
------- ---------
------- -
-------
--------
-
--
---------- -
------- --------
-------- -
------- --------
-
--
---------- -
------- ---------
------------- -
--------- -
------- --------
--
------- -
------- --------
--
-------- -
------- --------
--
------ -
------- --------
-
--
----------- -
---------
-------
--------
-----
-
-
--
----------- -
-------
------
---------
----------
---------
-
-此时，我们就可以将这个 JSON Schema 用于数据格式验证，例如使用 Ajv：
-- -------------------- ---- -------
----- --- - ---------------
----- ------ - -
------- ---------
------------- -
------- -
------- --------
--
------ -
------- --------
--
--------- -
------- ---------
------- -
-------
--------
-
--
---------- -
------- --------
-------- -
------- --------
-
--
---------- -
------- ---------
------------- -
--------- -
------- --------
--
------- -
------- --------
--
-------- -
------- --------
--
------ -
------- --------
-
--
----------- -
---------
-------
--------
-----
-
-
--
----------- -
-------
------
---------
----------
---------
-
--
----- --- - --- ------
----- -------- - --------------------
----- ------ - -
----- ------
---- ---
------- -------
-------- ----------- ------------
-------- -
------- ----- ----
----- ---- ------
------ -----
---- -------
-
--
----- ----- - -----------------
-- ------- -
----------------------
- ---- -
---------------------- -----------------
-指导意义
使用 ts-json-schema-generator 可以让我们更加方便地将 TypeScript 类型转换为 JSON Schema，并且可以在数据格式验证时使用这个 JSON Schema。这样就可以有效地避免一些数据格式错误，提高代码的健壮性和可维护性。同时也可以提高开发者的工作效率。
此外，通过阅读 ts-json-schema-generator 的源码，我们也可以深入地了解 TypeScript 的类型系统和 JSON Schema 的相关知识。这对于加深对类型系统和数据格式验证的理解都具有很大的帮助。
结论
本文介绍了如何使用 npm 包 ts-json-schema-generator 来自动生成 JSON Schema。通过使用这个工具，我们可以将 TypeScript 类型转换为 JSON Schema，并且在数据格式验证时使用这个 JSON Schema。这样可以提高代码的健壮性和可维护性，同时也可以加深对类型系统和数据格式验证的理解。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5eedcbf1b5cbfe1ea06126c5