About openapi-typescript
Used by
- Bigcommerce: Node SDK for the BigCommerce API
- Budibase: low code platform for creating internal tools, workflows, and admin panels
- Fedora
fmn
: tools and APIs for Fedora’s messaging infra - Fingerprint: device fingerprinting for high-scale applications
- Google Firebase CLI: Official CLI for Google’s Firebase platform
- GitHub Octokit: Official SDK for the GitHub API
- Lotus: open source pricing & packaging infra
- Jitsu: modern, open source data ingestion / data pipelines
- Medusa: building blocks for digital commerce
- Netlify: the modern development platform
- Nuxt: The Intuitive Vue framework
- Relevance AI: build and deploy AI chains
- Revolt: open source user-first chat platform
- Spacebar: a free, open source, self-hostable Discord-compatible chat/voice/video platform
- Supabase: The open source Firebase alternative.
Project goals
openapi-typescript
- Support converting any valid OpenAPI schema to TypeScript types, no matter how complicated.
- Generated types should be statically-analyzable and runtime-free (with minor exceptions like enums.
- Generated types should match your original schema as closely as possible, preserving original capitalization, etc.
- Typegen only needs Node.js to run (no Java, Python, etc.) and works in any environment.
- Support fetching OpenAPI schemas from files as well as local and remote servers.
openapi-fetch
- Types should be strict and inferred automatically from OpenAPI schemas with the absolute minimum number of generics needed.
- Respect the native Fetch API while reducing boilerplate (such as
await res.json()
). - Be as light and performant as possible.
openapi-react-query
- Types should be strict and inferred automatically from OpenAPI schemas with the absolute minimum number of generics needed.
- Respect the original
@tanstack/react-query
APIs while reducing boilerplate. - Be as light and performant as possible.
swr-openapi
- Types should be strict and inferred automatically from OpenAPI schemas with the absolute minimum number of generics needed.
- Respect the original
swr
APIs while reducing boilerplate. - Be as light and performant as possible.
openapi-metadata
- Must respect the OpenAPI V3 specification
- Be extensible and easily integrated inside backend frameworks
- Be focused around developer experience
Maintainers
This library is currently maintained by these amazing individuals:
Contributors
And thanks to 100+ amazing contributors, without whom these projects wouldn’t be possible: