fast-typescript-to-jsonschema

English | 简体中文

a tool generate json schema from typescript.

Feature

• compile Typescript to get all type information
• convert properties, extends, annotations, and initial values to jsonschema

Usage

1. install

yarn add fast-typescript-to-jsonschema -D

2. create type.ts

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

3. create test.js

3.1. gen jsonschema from file.

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

// target file
const file = path.resolve(__dirname, './type.ts');

// generate data
genTypeSchema.genJsonDataFormFile(file);

// get all jsonschema data of current file
const json = genTypeSchema.genJsonData();

// get jsonschema of specific type
const jsonSchema = genTypeSchema.getJsonSchema(file, 'ITest');

// result
console.log(jsonSchema); 

3.2. gen jsonschema from code.

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

const code = `
interface ITest {
  attr1: string;
  attr2: number;
  attr3?: boolean;
}
`
// generate data
genTypeSchema.genJsonDataFromCode(code);

// get all jsonschema data of current file
const json = genTypeSchema.genJsonData();

// get jsonschema of specific type
const jsonSchema = genTypeSchema.getJsonSchema('ITest');

// result
console.log(jsonSchema); 

4. execute script

node ./test.js

jsonSchema result:

{
  "additionalProperties": false,
  "properties": {
    "attr1": {
      "type": "string",
    },
    "attr2": {
      "type": "number",
    },
    "attr3": {
      "type": "boolean",
    },
  },
  "required": [
    "attr1",
    "attr2",
  ],
  "type": "object",
}

see more examples at example.

Comments

Example1

interface Interface_1 {
  attr: string;
}

result:

{
  "additionalProperties": false,
  "properties": {
    "attr": {
      "type": "string",
    },
  },
  "required": [
    "attr",
  ],
  "type": "object",
}

Example2

interface Interface_4 {
  attr: string[];
}

result:

{
  "additionalProperties": false,
  "properties": {
    "attr": {
      "items": {
        "type": "string",
      },
      "type": "array",
    },
  },
  "required": [
    "attr",
  ],
  "type": "object",
}

Read more supported types here

• Interface
  • 1.1 Basic Types
  • 1.2 Union Types
  • 1.3 Intersection Types
  • 1.4 Array Types
    • 1.4.1 Basic Array Types
    • 1.4.2 Complex Array Types
  • 1.5 Nesting
    • 1.5.1 Nested Basic Types
    • 1.5.2 Nested Union Types
    • 1.5.3 Nested Intersection Types
    • 1.5.4 Nested Intersection Array Types
    • 1.5.5 Nested loop
  • 1.6 Index Types
• Modules
  • 1.1 Basic Modules
  • 1.2 Named Export Modules
• Extending Types
  • 1.1 Basic Extending Types
  • 1.2 Multiple Extending Types
• Enums
  • 1.1 Numeric Enums
  • 1.2 String Enums
  • 1.3 Computed Enums
  • 1.4 Complex Enums
    • 1.4.1 Basic Interface to Enums
    • 1.4.2 Complex Interface to Enums
• Generics
  • 1.1 Basic Generics
  • 1.2 Complex Generics
• Namespaces
  • 1.1 Basic Namespaces
  • 1.2 Complex Namespaces
• Type
  • 1.1 Basic Types
  • 1.2 Complex Types
    • 1.2.1 Union Types
    • 1.2.2 Union Array Types
    • 1.2.2 Import Enums
• Utility Types
  • 1.1 Utility for Objects
    • 1.1.1 Omit
      • 1.1.1.1 Basic Omit
      • 1.1.1.2 Union Omit
      • 1.1.1.3 Import Omit
    • 1.1.2 Pick
      • 1.1.2.1 Basic Pick
      • 1.1.2.2 Import Pick
    • 1.1.3 Record
      • 1.1.2.1 Basic Record
      • 1.1.2.2 Import Record
• Type Annotations
  • 1.1 Single-line annotations
  • 1.2 Single-line annotations with default value
  • 1.3 Multi-line annotations
  • 1.4 Multi-line annotations with default value
  • 1.5 Mixed annotations with default value

Contribution

Contributions are extremely welcomed by our team, you can contribute to this repository by several ways below.

• Submit GitHub Issue to report errors or ask questions
• Create Pull Request to improve our code
• Contribution guide