# openapi-typesafe

> OpenAPI 3.x to TypeScript types, and a type-safe fetch client

Five packages share one version: `openapi-typesafe` (generator: CLI and Node API), `openapi-typesafe-fetch` (client), `openapi-typesafe-react-query` (TanStack Query hooks), `openapi-typesafe-helpers` (utility types) and `openapi-typesafe-migrate` (a one-off migration command, run with `npx`). Coding agents can also load the agent skill: https://github.com/openapi-typesafe/openapi-typesafe/tree/main/skills/openapi-typesafe

## Table of Contents

### openapi-typesafe

- [openapi-typesafe](https://openapi-typesafe.github.io/openapi-typesafe/introduction.md): Quickstart
- [openapi-typesafe CLI](https://openapi-typesafe.github.io/openapi-typesafe/cli.md): The quickest, easiest way to generate types.
- [openapi-typesafe Node.js API](https://openapi-typesafe.github.io/openapi-typesafe/node.md): Programmatic usage and unlimited flexibility.
- [Examples](https://openapi-typesafe.github.io/openapi-typesafe/examples.md): Using openapi-typesafe in real-world applications
- [Advanced](https://openapi-typesafe.github.io/openapi-typesafe/advanced.md): Advanced usage as well as tips, tricks, and best practices

### Moving to openapi-typesafe

- [Migration guide](https://openapi-typesafe.github.io/openapi-typesafe/migration-guide.md): Move a project from openapi-typescript, openapi-fetch and openapi-react-query to openapi-typesafe
- [TypeScript 7](https://openapi-typesafe.github.io/openapi-typesafe/typescript-7.md): Why openapi-typescript fails with TypeScript 7, and how openapi-typesafe works with it
- [Compatibility report](https://openapi-typesafe.github.io/openapi-typesafe/compatibility.md): How the output of openapi-typesafe compares with openapi-typescript 7.13 on 1,820 real-world schemas.

### openapi-typesafe-fetch

- [openapi-typesafe-fetch](https://openapi-typesafe.github.io/openapi-typesafe/fetch.md): A type-safe fetch client for OpenAPI, with typed paths, parameters, bodies and responses and no generics
- [Middleware & Auth](https://openapi-typesafe.github.io/openapi-typesafe/fetch/middleware-auth.md): Change requests and responses for every call, add auth tokens, and handle fetch errors
- [Testing](https://openapi-typesafe.github.io/openapi-typesafe/fetch/testing.md): Test code that uses openapi-typesafe-fetch with a fake fetch or Mock Service Worker
- [openapi-typesafe-fetch Examples](https://openapi-typesafe.github.io/openapi-typesafe/fetch/examples.md): openapi-typesafe-fetch with React, Next.js, Svelte, Vue and other frameworks
- [API](https://openapi-typesafe.github.io/openapi-typesafe/fetch/api.md): Every option and export of openapi-typesafe-fetch, such as createClient, request options, serializers and middleware

### openapi-typesafe-react-query

- [openapi-typesafe-react-query](https://openapi-typesafe.github.io/openapi-typesafe/react-query.md): Type-safe TanStack Query hooks generated from your OpenAPI schema
- [useQuery](https://openapi-typesafe.github.io/openapi-typesafe/react-query/use-query.md): Typed useQuery for OpenAPI endpoints
- [useMutation](https://openapi-typesafe.github.io/openapi-typesafe/react-query/use-mutation.md): Typed useMutation for OpenAPI endpoints
- [useSuspenseQuery](https://openapi-typesafe.github.io/openapi-typesafe/react-query/use-suspense-query.md): Typed useSuspenseQuery for OpenAPI endpoints
- [useInfiniteQuery](https://openapi-typesafe.github.io/openapi-typesafe/react-query/use-infinite-query.md): Typed useInfiniteQuery for paginated OpenAPI endpoints
- [queryOptions](https://openapi-typesafe.github.io/openapi-typesafe/react-query/query-options.md): Build type-safe TanStack Query options for useQueries, prefetching and fetchQuery

### Project

- [About openapi-typesafe](https://openapi-typesafe.github.io/openapi-typesafe/about.md): Where this project comes from, its goals, and the people whose work it builds on
- [Threat model](https://openapi-typesafe.github.io/openapi-typesafe/security/threat-model.md): How openapi-typesafe treats untrusted OpenAPI documents, what it defends against, and the open risks