Get Started

openapi-ts allows you to create TypeScript interfaces, REST clients, and JSON Schemas from an OpenAPI specification.

Features

• use with CLI, Node.js, or npx
• export TypeScript interfaces from OpenAPI v2.0, v3.0, and v3.1 specifications
• support JSON or YAML input files
• support external references using json-schema-ref-parser
• create fetch, axios, angular, node.js, or xhr REST clients
• export JSON Schemas from OpenAPI specifications
• abortable requests through cancellable promise pattern

Quick Start

The fastest way to use openapi-ts is via npx

npx @hey-api/openapi-ts -i path/to/openapi.json -o src/client

Congratulations on creating your first client! 🎉

Installation

npm

npm install @hey-api/openapi-ts --save-dev

pnpm

pnpm add @hey-api/openapi-ts -D

yarn

yarn add @hey-api/openapi-ts -D

bun

bun add @hey-api/openapi-ts -D

If you want to use openapi-ts with CLI, add a script to your package.json file

"scripts": {
  "openapi-ts": "openapi-ts"
}

You can also generate your client programmatically by importing openapi-ts in a .ts file.

import { createClient } from '@hey-api/openapi-ts';

createClient({
  input: 'path/to/openapi.json',
  output: 'src/client',
});

WARNING

You need to be running Node.js v18 or newer