Hey API

Appearance

Get Started ​

Generate TypeScript interfaces, REST clients, and JSON Schemas from OpenAPI specifications.

Features ​

  • works with CLI, Node.js 18+, or npx
  • supports OpenAPI 2.0, 3.0, and 3.1 specifications
  • supports both JSON and YAML input files
  • generates TypeScript interfaces, REST clients, and JSON Schemas
  • Fetch API, Axios, Angular, Node.js, and XHR clients available

Quick Start ​

The fastest way to use @hey-api/openapi-ts is via npx

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

Congratulations on creating your first client! 🎉 You can learn more about the generated files on the Output page.

While you can already make API requests with the client you've just created, you will probably want to configure it or pin a specific version. Let's start by adding @hey-api/openapi-ts to your dependencies.

Installation ​

sh
npm install @hey-api/openapi-ts --save-dev
sh
pnpm add @hey-api/openapi-ts -D
sh
yarn add @hey-api/openapi-ts -D
sh
bun add @hey-api/openapi-ts -D

We recommend pinning an exact version so you can safely upgrade when you're ready. This package is in initial development and its API might change before v1.

CLI ​

Most people run @hey-api/openapi-ts via CLI. To do that, add a script to your package.json file which will make openapi-ts executable through script.

json
"scripts": {
  "openapi-ts": "openapi-ts -i path/to/openapi.json -o src/client"
}

The above script can be executed by running npm run openapi-ts or equivalent command if you're not using npm.

Node.js ​

You can also generate clients programmatically by importing @hey-api/openapi-ts in a TypeScript file.

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

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

Configuration ​

It is a good practice to extract your configuration into a separate file. Learn how to do that and discover available options on the Configuration page.

Examples ​

You can view live examples on StackBlitz.