# Hey API

> 🌀 OpenAPI to TypeScript codegen. Production-ready SDKs, Zod schemas, TanStack Query hooks, and 20+ plugins. Used by Vercel, OpenCode, and PayPal.

## Documentation Sets

- [Abridged documentation](https://heyapi.dev/llms-small.txt): a compact version of the documentation for Hey API, with non-essential content removed
- [Complete documentation](https://heyapi.dev/llms-full.txt): the full documentation for Hey API

## Pages

- [OpenAPI to Python in seconds.](/codegen/openapi/python.md): Generate production-grade API infrastructure from your OpenAPI spec. Typed SDKs and Pydantic models. Free and open source.
- [OpenAPI to TypeScript in seconds.](/codegen/openapi/typescript.md): Generate production-grade API infrastructure from your OpenAPI spec. Typed SDKs, Zod schemas, TanStack Query hooks, and 20+ plugins. Free and open source.
- [Clients](/docs/openapi/typescript/clients.md): HTTP clients for Hey API. Compatible with all our features.
- [Angular v19 Client](/docs/openapi/typescript/clients/angular/v19.md): Generate a type-safe Angular v19 client from OpenAPI with the Angular client for openapi-ts. Fully compatible with validators, transformers, and all core features.
- [Angular v20 Client](/docs/openapi/typescript/clients/angular/v20.md): Generate a type-safe Angular v20 client from OpenAPI with the Angular client for openapi-ts. Fully compatible with validators, transformers, and all core features.
- [Axios v1 Client](/docs/openapi/typescript/clients/axios.md): Generate a type-safe Axios v1 client from OpenAPI with the Axios client for openapi-ts. Fully compatible with validators, transformers, and all core features.
- [Custom Client](/docs/openapi/typescript/clients/custom.md): Learn how to create your own Hey API client.
- [Effect client](/docs/openapi/typescript/clients/effect.md): Effect client for Hey API. Compatible with all our features.
- [Fetch API Client](/docs/openapi/typescript/clients/fetch.md): Generate a type-safe Fetch API client from OpenAPI with the Fetch API client for openapi-ts. Fully compatible with validators, transformers, and all core features.
- [Got client](/docs/openapi/typescript/clients/got.md): Got client for Hey API. Compatible with all our features.
- [Ky v1 Client](/docs/openapi/typescript/clients/ky.md): Generate a type-safe Ky v1 client from OpenAPI with the Ky client for openapi-ts. Fully compatible with validators, transformers, and all core features.
- [Next.js Client](/docs/openapi/typescript/clients/next-js.md): Generate a type-safe Next.js client from OpenAPI with the Next.js client for openapi-ts. Fully compatible with validators, transformers, and all core features.
- [Nuxt v3 Client](/docs/openapi/typescript/clients/nuxt.md): Generate a type-safe Nuxt v3 client from OpenAPI with the Nuxt client for openapi-ts. Fully compatible with validators, transformers, and all core features.
- [OFetch Client](/docs/openapi/typescript/clients/ofetch.md): Generate a type-safe ofetch client from OpenAPI with the ofetch client for openapi-ts. Fully compatible with validators, transformers, and all core features.
- [Contributing](/docs/openapi/typescript/community/contributing.md): Learn how to contribute to Hey API.
- [Building](/docs/openapi/typescript/community/contributing/building.md): Learn how to contribute to Hey API.
- [Developing](/docs/openapi/typescript/community/contributing/developing.md): Learn how to contribute to Hey API.
- [Testing](/docs/openapi/typescript/community/contributing/testing.md): Learn how to contribute to Hey API.
- [Spotlight](/docs/openapi/typescript/community/spotlight.md): Meet the people behind Hey API.
- [Configuration](/docs/openapi/typescript/configuration.md): Configure @hey-api/openapi-ts.
- [Input](/docs/openapi/typescript/configuration/input.md): Configure @hey-api/openapi-ts.
- [Output](/docs/openapi/typescript/configuration/output.md): Configure @hey-api/openapi-ts.
- [Parser](/docs/openapi/typescript/configuration/parser.md): Configure @hey-api/openapi-ts.
- [Vite Plugin](/docs/openapi/typescript/configuration/vite.md): Integrate @hey-api/openapi-ts into your Vite 5, 6, 7, or 8 build pipeline with the official Vite plugin.
- [Core Plugins](/docs/openapi/typescript/core.md): Learn about the core plugins provided by Hey API.
- [Get Started](/docs/openapi/typescript/get-started.md): Get started with @hey-api/openapi-ts.
- [Hey API Platform](/docs/openapi/typescript/integrations.md): Automate your client generation with our OpenAPI specifications storage.
- [License](/docs/openapi/typescript/license.md): License FAQ.
- [Migrating](/docs/openapi/typescript/migrating.md): Migrating to @hey-api/openapi-ts.
- [Mocks](/docs/openapi/typescript/mocks.md): Learn about mocking HTTP servers with @hey-api/openapi-ts.
- [Output](/docs/openapi/typescript/output.md): Learn about files generated with @hey-api/openapi-ts.
- [AdonisJS](/docs/openapi/typescript/plugins/adonis.md): AdonisJS plugin for Hey API. Compatible with all our features.
- [Ajv](/docs/openapi/typescript/plugins/ajv.md): Ajv plugin for Hey API. Compatible with all our features.
- [Angular v19 Plugin](/docs/openapi/typescript/plugins/angular/v19.md): Generate Angular v19 HTTP requests and resources from OpenAPI with the Angular plugin for openapi-ts. Fully compatible with validators, transformers, and all core features.
- [Angular v20 Plugin](/docs/openapi/typescript/plugins/angular/v20.md): Generate Angular v20 HTTP requests and resources from OpenAPI with the Angular plugin for openapi-ts. Fully compatible with validators, transformers, and all core features.
- [Arktype](/docs/openapi/typescript/plugins/arktype.md): Arktype plugin for Hey API. Compatible with all our features.
- [Chance](/docs/openapi/typescript/plugins/chance.md): Chance plugin for Hey API. Compatible with all our features.
- [Resolvers](/docs/openapi/typescript/plugins/concepts/resolvers.md): Understand the concepts behind plugins.
- [Custom Plugin](/docs/openapi/typescript/plugins/custom.md): Learn how to create your own Hey API plugin.
- [Elysia](/docs/openapi/typescript/plugins/elysia.md): Elysia plugin for Hey API. Compatible with all our features.
- [Express](/docs/openapi/typescript/plugins/express.md): Express plugin for Hey API. Compatible with all our features.
- [Faker](/docs/openapi/typescript/plugins/faker.md): Faker plugin for Hey API. Compatible with all our features.
- [Falso](/docs/openapi/typescript/plugins/falso.md): Falso plugin for Hey API. Compatible with all our features.
- [Fastify v5 Plugin](/docs/openapi/typescript/plugins/fastify.md): Generate Fastify v5 route handlers from OpenAPI with the Fastify plugin for openapi-ts. Fully compatible with validators, transformers, and all core features.
- [Hono](/docs/openapi/typescript/plugins/hono.md): Hono plugin for Hey API. Compatible with all our features.
- [Joi](/docs/openapi/typescript/plugins/joi.md): Joi plugin for Hey API. Compatible with all our features.
- [Koa](/docs/openapi/typescript/plugins/koa.md): Koa plugin for Hey API. Compatible with all our features.
- [MSW](/docs/openapi/typescript/plugins/msw.md): MSW plugin for Hey API. Compatible with all our features.
- [NestJS v11 Plugin](/docs/openapi/typescript/plugins/nest.md): Generate NestJS v11 controller methods from OpenAPI with the NestJS plugin for openapi-ts. Fully compatible with validators, transformers, and all core features.
- [Nock](/docs/openapi/typescript/plugins/nock.md): Nock plugin for Hey API. Compatible with all our features.
- [oRPC v1 Plugin](/docs/openapi/typescript/plugins/orpc.md): Generate oRPC v1 contracts from OpenAPI with the oRPC plugin for openapi-ts. Fully compatible with validators, transformers, and all core features.
- [Pinia Colada v0 Plugin](/docs/openapi/typescript/plugins/pinia-colada.md): Generate Pinia Colada v0 functions and query keys from OpenAPI with the Pinia Colada plugin for openapi-ts. Fully compatible with validators, transformers, and all core features.
- [JSON Schema](/docs/openapi/typescript/plugins/schemas.md): Learn about files generated with @hey-api/openapi-ts.
- [SDK Plugin](/docs/openapi/typescript/plugins/sdk.md): Generate SDKs from OpenAPI with the SDK plugin for openapi-ts. Fully compatible with validators, transformers, and all core features.
- [Superstruct](/docs/openapi/typescript/plugins/superstruct.md): Superstruct plugin for Hey API. Compatible with all our features.
- [Supertest](/docs/openapi/typescript/plugins/supertest.md): Supertest plugin for Hey API. Compatible with all our features.
- [SWR](/docs/openapi/typescript/plugins/swr.md): SWR plugin for Hey API. Compatible with all our features.
- [TanStack Query v5 Plugin](/docs/openapi/typescript/plugins/tanstack-query.md): Generate TanStack Query v5 functions and query keys from OpenAPI with the TanStack Query plugin for openapi-ts. Fully compatible with validators, transformers, and all core features.
- [Transformers](/docs/openapi/typescript/plugins/transformers.md): Learn about transforming data with @hey-api/openapi-ts.
- [TypeBox](/docs/openapi/typescript/plugins/typebox.md): TypeBox plugin for Hey API. Compatible with all our features.
- [TypeScript](/docs/openapi/typescript/plugins/typescript.md): Learn about files generated with @hey-api/openapi-ts.
- [Valibot v1 Plugin](/docs/openapi/typescript/plugins/valibot.md): Generate Valibot v1 schemas from OpenAPI with the Valibot plugin for openapi-ts. Fully compatible with validators, transformers, and all core features.
- [Yup](/docs/openapi/typescript/plugins/yup.md): Yup plugin for Hey API. Compatible with all our features.
- [Zod Mini Plugin](/docs/openapi/typescript/plugins/zod/mini.md): Generate Zod Mini schemas from OpenAPI with the Zod plugin for openapi-ts. Fully compatible with validators, transformers, and all core features.
- [Zod v3 Plugin](/docs/openapi/typescript/plugins/zod/v3.md): Generate Zod v3 schemas from OpenAPI with the Zod plugin for openapi-ts. Fully compatible with validators, transformers, and all core features.
- [Zod v4 Plugin](/docs/openapi/typescript/plugins/zod/v4.md): Generate Zod v4 schemas from OpenAPI with the Zod plugin for openapi-ts. Fully compatible with validators, transformers, and all core features.
- [Zustand](/docs/openapi/typescript/plugins/zustand.md): Zustand plugin for Hey API. Compatible with all our features.
- [State Management](/docs/openapi/typescript/state-management.md): Learn about handling state with @hey-api/openapi-ts.
- [Validators](/docs/openapi/typescript/validators.md): Learn about validating data with @hey-api/openapi-ts.
- [Web Frameworks](/docs/openapi/typescript/web-frameworks.md): Learn about generating web framework code with @hey-api/openapi-ts.
- [OpenAPI to code in seconds.](/index.md): Generate production-grade API infrastructure from your OpenAPI spec. SDKs, validators, query hooks, and 20+ plugins across TypeScript and Python. Free and open source.
- [Sponsors](/sponsors.md): Fuel the future of API tooling.

## Notes

- The complete documentation includes all content from the official documentation
- The content is automatically generated from the same source as the official documentation