介绍
在前端开发中，我们通常需要对数据进行验证和格式转换。而为了方便地进行数据操作，一些开发者利用 json 格式对数据进行了描述。而对于这些 json 格式的数据，我们通常需要一个工具或者库来完成验证和格式转换的操作。在此，我们就要介绍 npm 包 @trungdt/ts-json-schema-generator，它是一个用来生成 TypeScript 类型和 JSON Schema 的工具。
使用方法
安装
在使用 @trungdt/ts-json-schema-generator 前，我们需要先安装它。可以通过以下指令完成安装：
npm install @trungdt/ts-json-schema-generator --save-dev
命令行使用
在安装完成后，@trungdt/ts-json-schema-generator 提供了命令行的方式来使用它。在 package.json 中添加以下脚本即可运行该命令：
"scripts": {
"generate-schema": "tjgs --path \"path/to/your.ts\" --type yourType --outDir \"path/to/output\""
}--path参数指定你要生成 JSON Schema 的 TypeScript 文件；--type参数指定你要生成 JSON Schema 的 TypeScript 类型；--outDir参数指定生成的 JSON Schema 文件的输出目录。
API 使用
在使用 @trungdt/ts-json-schema-generator 时，还可以通过 API 来进行调用。在 js/ts 文件中，可以通过以下方式来使用它：
-- -------------------- ---- ------- ------ - -- ---- ---- ------------------------------------ ----- ------- - --- ----------------------- ----- ----------- ----- ------------------ ------- ---------------- --- ----- --------- - --- ---------------------------------- -------------------------------- -- - -------------------- -- -- ---- ------ ---
示例代码
以下是示例代码：
-- -------------------- ---- ------- ------ - ----------- --------- -------- - ---- ------------------ ------ ----- ------------- - ----------- ----- ------- ----------- ---- ------- ------------- ----------- --------- ------- -
运行命令行：
tjgs --path "src/dto/create-user.dto.ts" --type CreateUserDto --outDir "src/schemas"
会生成以下 JSON Schema：
-- -------------------- ---- -------
-
---------- ------------------------------------------
------- ---------
------------- -
------- -
------- --------
--
------ -
------- --------
--
---------- -
------- --------
-
--
----------- -
-------
-----
-
-总结
在本篇文章中，我们介绍了 npm 包 @trungdt/ts-json-schema-generator 的使用方法和示例代码。它可以有效地帮助前端开发者进行数据的验证和格式转换。在实际开发中，通过 @trungdt/ts-json-schema-generator 可以减少手动编写 JSON Schema 的时间和成本，提高开发效率。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600672663660cf7123b364f4