spec2ts

spec2ts is an utility to create TypeScript types from JSON schemas and OpenAPI v3 specifications. Unlike other code generators spec2ts does not use templates to generate code but uses TypeScript's built-in API to generate and pretty-print an abstract syntax tree (AST).

Features

• AST-based: Unlike other code generators spec2ts does not use templates to generate code but uses TypeScript's built-in API to generate and pretty-print an abstract syntax tree.
• Tree-shakeable: Individually exported types allows you to bundle only the ones you actually use.
• YAML or JSON: Use YAML or JSON for your or OpenAPI Specifications and JSON Schemas.
• External references: Resolves automatically external references and bundle or import them in generated files.
• Implementation agnostic: Use generated types in any projet or framework.

Components

• @spec2ts/core: Helpers methods to generate TypeScript code.
• @spec2ts/jsonschema: Utility to generate types from JSON schemas. More details.
• @spec2ts/openapi: Utility to generate types from Open API v3 specifications. More details.
• @spec2ts/openapi-client: Utility to generate HTTP Client from Open API v3 specifications. More details.
• @spec2ts/cli: CLI wrapper to generate types from Open API v3 specifications and JSON schemas. More details.

Installation

Install in your project:

npm install @spec2ts/cli

CLI Usage

# Generate TypeScript types from JSON Schemas
spec2ts jsonschema -o path/to/output path/to/my/*.schema.json

# Generate TypeScript types from Open API specification
spec2ts openapi -o path/to/output path/to/my/specification.yml

# Generate TypeScript HTTP Client from Open API specification
spec2ts openapi-client -o path/to/output.ts path/to/my/specification.yml

You can find more details in the @spec2ts documentation.

Programmatic Usage

Generate TypeScript types from JSON Schemas

import { printer } from "@spec2ts/core";
import { parseSchema, JSONSchema } from "@spec2ts/jsonschema";

async function generateSchema(schema: JSONSchema): Promise<string> {
    const result = await parseSchema(schema);
    return printer.printNodes(result);
}

Generate TypeScript types from OpenAPI Specifications

import { printer } from "@spec2ts/core";
import { parseOpenApiFile } from "@spec2ts/openapi";

async function generateSpec(path: string): Promise<string> {
    const result = await parseOpenApiFile(path);
    return printer.printNodes(result);
}

Generate TypeScript Client types from OpenAPI Specifications

import { printer } from "@spec2ts/core";
import { generateClientFile } from "@spec2ts/openapi-client";

async function generateClient(path: string): Promise<string> {
    const result = await generateClientFile(path);
    return printer.printNodes(result);
}

Compatibility Matrix

TypeScript version	spec2ts version
v3.x.x	v1
v4.x.x	v2
v5.x.x	v3

License

This project is under MIT License. See the LICENSE file for the full license text.