OpenAPI TypeScript
“OpenAPI codegen that just works.”
— Guillermo Rauch, CEO of Vercel
Demo
•
Manual
•
Issues
•
Contribute
## About
The OpenAPI to TypeScript code generator used by Vercel, OpenCode, and PayPal.
Generate production-grade SDKs, Zod schemas, TanStack Query hooks, or choose from 20+ other plugins.
Part of the Hey API ecosystem.
## Features
- production-grade code that compiles
- runs in any Node.js 22+ environment
- accepts any OpenAPI specification
- core plugins for SDKs, types, and schemas
- HTTP clients for Fetch API, Angular, Axios, Next.js, Nuxt, and more
- 20+ plugins to reduce third-party boilerplate
- highly customizable via plugins
- [sync with Hey API Registry](https://heyapi.dev/docs/openapi/typescript/integrations) for spec management
## Contributing
Want to see your code in products used by millions?
Start with our [Contributing](https://heyapi.dev/docs/openapi/typescript/community/contributing) guide and release your first feature.
## Sponsors
Partners behind the future of API tooling. [Become a sponsor](https://github.com/sponsors/hey-api).
Gold
Silver
Bronze
## Quick Start
The fastest way to use `@hey-api/openapi-ts` is via npx
```sh
npx @hey-api/openapi-ts -i hey-api/backend -o src/client
```
Congratulations on creating your first client! 🎉 You can learn more about the generated files on the [Output](https://heyapi.dev/docs/openapi/typescript/output) page.
## Installation
You can download `@hey-api/openapi-ts` from npm using your favorite package manager.
#### npm
```sh
npm install @hey-api/openapi-ts -D -E
```
#### pnpm
```sh
pnpm add @hey-api/openapi-ts -D -E
```
#### yarn
```sh
yarn add @hey-api/openapi-ts -D -E
```
#### bun
```sh
bun add @hey-api/openapi-ts -D
```
### Versioning
This package is in [initial development](https://semver.org/#spec-item-4). Please pin an exact version so you can safely upgrade when you're ready.
We publish [migration notes](https://heyapi.dev/docs/openapi/typescript/migrating) for every breaking release. You might not be impacted by a breaking change if you don't use the affected features.
## Usage
### 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"
}
```
The above script can be executed by running `npm run openapi-ts` or equivalent command in other package managers. Next, we will create a [configuration](https://heyapi.dev/docs/openapi/typescript/configuration) file and move our options from Quick Start to it.
### Node.js
You can also generate output programmatically by calling `createClient()` in a JavaScript/TypeScript file.
#### `script.ts`
```ts
import { createClient } from '@hey-api/openapi-ts';
createClient({
input: 'hey-api/backend', // sign up at app.heyapi.dev
output: 'src/client',
});
```
### Vite
If you're using [Vite](https://vite.dev), you can integrate `@hey-api/openapi-ts` directly into your build pipeline with `@hey-api/vite-plugin`. Install it alongside the main package:
#### npm
```sh
npm install @hey-api/vite-plugin -D -E
```
#### pnpm
```sh
pnpm add @hey-api/vite-plugin -D -E
```
#### yarn
```sh
yarn add @hey-api/vite-plugin -D -E
```
#### bun
```sh
bun add @hey-api/vite-plugin -D
```
Then add the plugin to your Vite configuration:
#### `vite.config.ts`
```ts
import { heyApiPlugin } from '@hey-api/vite-plugin';
import { defineConfig } from 'vite';
export default defineConfig({
plugins: [
heyApiPlugin({
config: {
input: 'hey-api/backend', // sign up at app.heyapi.dev
output: 'src/client',
},
}),
],
});
```
See the [Vite](https://heyapi.dev/docs/openapi/typescript/configuration/vite) page for full configuration options.
## Configuration
`@hey-api/openapi-ts` supports loading configuration from any file inside your project root folder supported by [jiti loader](https://github.com/unjs/c12?tab=readme-ov-file#-features). Below are the most common file formats.
#### `openapi-ts.config.ts`
```js
import { defineConfig } from '@hey-api/openapi-ts';
export default defineConfig({
input: 'hey-api/backend', // sign up at app.heyapi.dev
output: 'src/client',
});
```
#### `openapi-ts.config.cjs`
```js
/** @type {import('@hey-api/openapi-ts').UserConfig} */
module.exports = {
input: 'hey-api/backend', // sign up at app.heyapi.dev
output: 'src/client',
};
```
#### `openapi-ts.config.mjs`
```js
/** @type {import('@hey-api/openapi-ts').UserConfig} */
export default {
input: 'hey-api/backend', // sign up at app.heyapi.dev
output: 'src/client',
};
```
Alternatively, you can use `openapi-ts.config.js` and configure the export statement depending on your project setup.
### Input
You must set the input so we can load your OpenAPI specification. It can be a path or URL, object containing a path or URL, or an object representing 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`](https://github.com/hey-api/openapi-ts/issues/276#issuecomment-2043143501) in your environment.
### Output
You must set the output so we know where to generate your files. It can be a path to the destination folder or an object containing the destination folder path and optional settings.
> 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.
## Parser
We parse your input before making it available to plugins. While configuring the parser is optional, it's the perfect place to modify or validate your input if needed.
## 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!
### Client
Clients are responsible for sending the actual HTTP requests. We default to Fetch client if you're generating SDKs, but you can choose a different option from the available clients.
### Available Clients
- [`@hey-api/client-fetch`](https://heyapi.dev/docs/openapi/typescript/clients/fetch)
- [`@hey-api/client-angular`](https://heyapi.dev/docs/openapi/typescript/clients/angular)
- [`@hey-api/client-axios`](https://heyapi.dev/docs/openapi/typescript/clients/axios)
- [`@hey-api/client-ky`](https://heyapi.dev/docs/openapi/typescript/clients/ky)
- [`@hey-api/client-next`](https://heyapi.dev/docs/openapi/typescript/clients/next-js)
- [`@hey-api/client-nuxt`](https://heyapi.dev/docs/openapi/typescript/clients/nuxt)
- [`@hey-api/client-ofetch`](https://heyapi.dev/docs/openapi/typescript/clients/ofetch)
### Proposed Clients (Vote to Prioritize)
The following clients are roadmap proposals and are not started yet. You can help us prioritize them by voting on [GitHub](https://github.com/hey-api/openapi-ts/issues?q=state%3Aopen%20label%3A%22vote%20%F0%9F%93%A9%22).
- [`@hey-api/client-effect`](https://heyapi.dev/docs/openapi/typescript/clients/effect)
Don't see your client? [Build your own](https://heyapi.dev/docs/openapi/typescript/clients/custom) or let us know your interest by [opening an issue](https://github.com/hey-api/openapi-ts/issues).
### Available 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](https://github.com/hey-api/openapi-ts/issues) if you'd like us to support your favorite package.
- [`@angular/common`](https://heyapi.dev/docs/openapi/typescript/plugins/angular)
- [`@hey-api/schemas`](https://heyapi.dev/docs/openapi/typescript/plugins/schemas)
- [`@hey-api/sdk`](https://heyapi.dev/docs/openapi/typescript/plugins/sdk)
- [`@hey-api/transformers`](https://heyapi.dev/docs/openapi/typescript/plugins/transformers)
- [`@hey-api/typescript`](https://heyapi.dev/docs/openapi/typescript/plugins/typescript)
- [`@pinia/colada`](https://heyapi.dev/docs/openapi/typescript/plugins/pinia-colada)
- [`@tanstack/angular-query-experimental`](https://heyapi.dev/docs/openapi/typescript/plugins/tanstack-query)
- [`@tanstack/preact-query`](https://heyapi.dev/docs/openapi/typescript/plugins/tanstack-query)
- [`@tanstack/react-query`](https://heyapi.dev/docs/openapi/typescript/plugins/tanstack-query)
- [`@tanstack/solid-query`](https://heyapi.dev/docs/openapi/typescript/plugins/tanstack-query)
- [`@tanstack/svelte-query`](https://heyapi.dev/docs/openapi/typescript/plugins/tanstack-query)
- [`@tanstack/vue-query`](https://heyapi.dev/docs/openapi/typescript/plugins/tanstack-query)
- [`fastify`](https://heyapi.dev/docs/openapi/typescript/plugins/fastify)
- [`orpc`](https://heyapi.dev/docs/openapi/typescript/plugins/orpc)
- [`nestjs`](https://heyapi.dev/docs/openapi/typescript/plugins/nest)
- [`valibot`](https://heyapi.dev/docs/openapi/typescript/plugins/valibot)
- [`zod`](https://heyapi.dev/docs/openapi/typescript/plugins/zod)
### Proposed Plugins (Vote to Prioritize)
The following plugins are roadmap proposals and are not started yet. You can help us prioritize them by voting on [GitHub](https://github.com/hey-api/openapi-ts/issues?q=state%3Aopen%20label%3A%22vote%20%F0%9F%93%A9%22).
- [Adonis](https://heyapi.dev/docs/openapi/typescript/plugins/adonis)
- [Ajv](https://heyapi.dev/docs/openapi/typescript/plugins/ajv)
- [Arktype](https://heyapi.dev/docs/openapi/typescript/plugins/arktype)
- [Chance](https://heyapi.dev/docs/openapi/typescript/plugins/chance)
- [Elysia](https://heyapi.dev/docs/openapi/typescript/plugins/elysia)
- [Express](https://heyapi.dev/docs/openapi/typescript/plugins/express)
- [Faker](https://heyapi.dev/docs/openapi/typescript/plugins/faker)
- [Falso](https://heyapi.dev/docs/openapi/typescript/plugins/falso)
- [Hono](https://heyapi.dev/docs/openapi/typescript/plugins/hono)
- [Joi](https://heyapi.dev/docs/openapi/typescript/plugins/joi)
- [Koa](https://heyapi.dev/docs/openapi/typescript/plugins/koa)
- [MSW](https://heyapi.dev/docs/openapi/typescript/plugins/msw)
- [Nock](https://heyapi.dev/docs/openapi/typescript/plugins/nock)
- [Superstruct](https://heyapi.dev/docs/openapi/typescript/plugins/superstruct)
- [Supertest](https://heyapi.dev/docs/openapi/typescript/plugins/supertest)
- [SWR](https://heyapi.dev/docs/openapi/typescript/plugins/swr)
- [TanStack Start](https://heyapi.dev/docs/openapi/typescript/plugins/tanstack-start)
- [TypeBox](https://heyapi.dev/docs/openapi/typescript/plugins/typebox)
- [Yup](https://heyapi.dev/docs/openapi/typescript/plugins/yup)
- [Zustand](https://heyapi.dev/docs/openapi/typescript/plugins/zustand)
Don't see your plugin? [Build your own](https://heyapi.dev/docs/openapi/typescript/plugins/custom) or let us know your interest by [opening an issue](https://github.com/hey-api/openapi-ts/issues).
## Migrating
You can learn more on the [Migrating](https://heyapi.dev/docs/openapi/typescript/migrating) page.
## License
Released under the [MIT License](https://github.com/hey-api/openapi-ts/blob/main/LICENSE.md).
