| title | description |
|---|---|
About openapi-fetch |
openapi-fetch Project Goals, comparisons, and more |
- 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.
Axios doesn’t automatically typecheck against your OpenAPI schema. Further, there’s no easy way to do that. Axios does have more features than openapi-fetch such as interceptors and advanced cancellation.
tRPC is meant for projects where both the backend and frontend are written in TypeScript (Node.js). openapi-fetch is universal, and can work with any backend that follows an OpenAPI 3.x schema.
openapi-typescript-fetch predates openapi-fetch, and is nearly identical in purpose, but differs mostly in syntax (so it’s more of an opinionated choice):
- openapi-typescript-fetch throws exceptions for non-OK responses (requiring you to wrap things in
try/catch) rather than follow the fetch API spec of not throwing. - openapi-typescript-fetch’s syntax is more verbose, and relies on chaining (
.path(…).method(…).create()).
openapi-typescript-codegen is a codegen library, which is fundamentally different from openapi-fetch’s “no codegen” approach. openapi-fetch uses static TypeScript typechecking that all happens at build time with no client weight and no performance hit to runtime. Traditional codegen generates hundreds (if not thousands) of different functions that all take up client weight and slow down runtime.
Swagger Codegen is the original codegen project for Swagger/OpenAPI, and has the same problems of other codgen approaches of size bloat and runtime performance problems. Further, Swagger Codegen require the Java runtime to work, whereas openapi-typescript/openapi-fetch don’t as native Node.js projects.
This library wouldn’t be possible without all these amazing contributors: