Package Exports

Readme

OpenAPI TypeScript

🚀 The OpenAPI to TypeScript codegen. Generate clients, SDKs, validators, and more.

Demo • Documentation • Issues • Roadmap • npm

Features

works with CLI, Node.js 18+, or npx
supports OpenAPI 2.0, 3.0, and 3.1 specifications
supports JSON and YAML input files
generates TypeScript interfaces and SDKs
Fetch API, Axios, Nuxt, Angular, Node.js, and XHR clients available
plugin ecosystem to reduce third-party boilerplate
platform for automating codegen builds

Platform

Our platform for OpenAPI specifications is now available. Automatically update your code when the APIs it depends on change. Find out more.

Quick Start

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

npx @hey-api/openapi-ts \
  -i https://get.heyapi.dev/hey-api/backend \
  -o src/client \
  -c @hey-api/client-fetch

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

Before you can make API requests with the client you've just created, you need to install @hey-api/client-fetch and configure it.

Installation

npm

npm install @hey-api/client-fetch && npm install @hey-api/openapi-ts -D

pnpm

pnpm add @hey-api/client-fetch && pnpm add @hey-api/openapi-ts -D

yarn

yarn add @hey-api/client-fetch && yarn add @hey-api/openapi-ts -D

bun

bun add @hey-api/client-fetch && 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.

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

The above script can be executed by running npm run openapi-ts or equivalent command in other package managers. Next, we need to create a configuration file and move our options from Quick Start to it.

Node.js

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

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

createClient({
  input: 'https://get.heyapi.dev/hey-api/backend',
  output: 'src/client',
  plugins: ['@hey-api/client-fetch'],
});

Configuration

@hey-api/openapi-ts supports loading configuration from any file inside your project root folder supported by jiti loader. Below are the most common file formats.

`openapi-ts.config.ts`

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

export default defineConfig({
  input: 'https://get.heyapi.dev/hey-api/backend',
  output: 'src/client',
  plugins: ['@hey-api/client-fetch'],
});

`openapi-ts.config.cjs`

/** @type {import('@hey-api/openapi-ts').UserConfig} */
module.exports = {
  input: 'https://get.heyapi.dev/hey-api/backend',
  output: 'src/client',
  plugins: ['@hey-api/client-fetch'],
};

`openapi-ts.config.mjs`

/** @type {import('@hey-api/openapi-ts').UserConfig} */
export default {
  input: 'https://get.heyapi.dev/hey-api/backend',
  output: 'src/client',
  plugins: ['@hey-api/client-fetch'],
};

Alternatively, you can use openapi-ts.config.js and configure the export statement depending on your project setup.

Input

Input is the first thing you must define. It can be a path, URL, or a string content resolving to an OpenAPI specification. Hey API supports all valid OpenAPI versions and file formats.

If you use an HTTPS URL with a self-signed certificate in development, you will need to set NODE_TLS_REJECT_UNAUTHORIZED=0 in your environment.

Output

Output is the next thing to define. It can be either a string pointing to the destination folder or a configuration object containing the destination folder path and optional settings (these are described below).

You should treat the output folder as a dependency. Do not directly modify its contents as your changes might be erased when you run @hey-api/openapi-ts again.

Client

Clients are responsible for sending the actual HTTP requests. Using clients is not required, but you must add a client to plugins if you're generating SDKs (enabled by default).

You can learn more on the Clients page.

Plugins

Plugins are responsible for generating artifacts from your input. By default, Hey API will generate TypeScript interfaces and SDK from your OpenAPI specification. You can add, remove, or customize any of the plugins. In fact, we highly encourage you to do so!

Native Plugins

These plugins help reduce boilerplate associated with third-party dependencies. Hey API natively supports the most popular packages. Please open an issue on GitHub if you'd like us to support your favorite package.

Planned Plugins

The following plugins are planned but not in development yet. You can help us prioritize them by voting on GitHub.

Migration Guides

OpenAPI Typescript Codegen

License

Released under the MIT License.

JSPM

@hey-api/openapi-ts