简介
在前端开发中，我们经常需要对数据进行校验或者生成 JSON Schema。这时候，typescript-json-schema 这个 npm 包就会很有用。它可以通过 TypeScript 的类型定义文件生成对应的 JSON Schema 数据模型，非常方便。
安装
使用 npm 或者 yarn 安装：
npm install typescript-json-schema -g
yarn global add typescript-json-schema
安装完成后，你就可以在命令行中使用 typescript-json-schema 命令了。
如何使用
假设你已经有了一个 TypeScript 类型定义文件 my-interface.ts，内容如下：
interface MyInterface { name: string; age: number; isMale: boolean; }
如果你想要生成对应的 JSON Schema 数据模型，只需要运行以下命令即可：
typescript-json-schema my-interface.ts MyInterface --no-top-ref -o my-interface-schema.json
命令解释：
my-interface.ts: TypeScript 类型定义文件路径。MyInterface: 定义的接口名。--no-top-ref: 不生成$ref标记。-o my-interface-schema.json: 输出到指定的 JSON 文件中。
执行完这个命令后，会在当前目录下生成一个名为 my-interface-schema.json 的 JSON 文件，里面包含了对应的 JSON Schema 模型定义。
示例代码
下面是一个完整的示例代码，包括 TypeScript 类型定义文件和生成 JSON Schema 的命令：
-- -------------------- ---- ------- -- --------------- ---- --------- ----------- - ----- ------- ---- ------- ------- -------- - -- ----- ---------------------- --------------- ----------- ------------ -- ------------------------展开代码
执行完这个命令后，会在当前目录下生成一个名为 my-interface-schema.json 的 JSON 文件，里面包含了对应的 JSON Schema 模型定义。
结论
使用 typescript-json-schema 可以轻松地将 TypeScript 类型定义转换成对应的 JSON Schema 数据模型，方便我们进行数据校验或者数据生成。相信在前端开发中，这个工具会帮助你提高开发效率。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/54839
