给你推荐一款快速通过 typescript 生成 jsonschema 的包处理器

只此一生的我

已于 2023-07-26 18:01:58 修改

阅读量627

点赞数

CC 4.0 BY-SA版权

分类专栏： node 文章标签： typescript ubuntu javascript

于 2023-07-26 15:14:48 首次发布

本文链接：https://blog.youkuaiyun.com/wangweianger/article/details/131939943

本文介绍了一个用于将Typescript类型转换为JSON Schema的高效工具，包括其性能、主要特性及使用方法。支持各种复杂的类型转换，如接口、数组、嵌套、继承、枚举、泛型、命名空间和注释等，并提供了丰富的注解处理。此外，还鼓励读者通过提交问题和拉取请求参与项目贡献。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

theme: github

fast-typescript-to-jsonschema

Test

Typescript 生成 jsonschema 数据插件

性能

案例

interface AAA {
   
    a: number;
    b: string;
    c: boolean;
}

解析器	解析耗时
fast-typescript-to-jsonschema	15ms
typescript-json-schema	5430ms

特性

编译Typescript文件以获取完整的类型信息
将所需的属性、继承、注释、属性初始值转换为jsonschema

使用

1.安装依赖

yarn add fast-typescript-to-jsonschema -D

2.创建type.ts文件，内容如下:

interface ITest {
   
  attr1: string;
  attr2: number;
  attr3?: boolean;
}

创建test.js文件，内容如下:

3.1 通过文件生成 jsonschema

const {
    default: genTypeSchema } = require('fast-typescript-to-jsonschema');
const path = require('path');

// 目标文件
const file = path.resolve(__dirname, './type.ts');

// 生成数据
genTypeSchema.genJsonDataFormFile(file);

// 获得当前文件对应的所有jsonschema数据
const json = genTypeSchema.genJsonData();

// 获得具体的某个type的jsonschema数据
const jsonSchema