05Project
Examples
Runnable projects from the repository, each generated and type-checked in CI.
Each example is a project in the repository's examples/ directory. CI generates its client, type-checks it with its framework's compiler and builds it; the numbers below come from generating it for this build of the site.
- Custom plugin exampleTwo small plugins applied to a Swagger 2.0 document (swagger.json):
- Node.js JavaScript exampleA plain JavaScript Node.js script using a client generated as JavaScript with JSDoc and .d.ts declarations from an OpenAPI 3.0 document (openapi.yaml).
- React Query exampleA task list built with React, TanStack Query and a client generated from an OpenAPI 3.1 document (openapi.yaml).
- Solid Query exampleThe task list of the React Query example, built with Solid and TanStack Solid Query, from the same OpenAPI 3.1 document (openapi.yaml).
- Svelte Query exampleThe task list of the React Query example, built with Svelte 5 (runes) and TanStack Svelte Query 6, from the same OpenAPI 3.1 document (openapi.yaml).
- SWR exampleThe task list of the React Query example, built with SWR hooks and ArkType validation, from the same OpenAPI 3.1 document (openapi.yaml).
- Vue Query exampleThe task list of the React Query example, built with Vue 3 single-file components, TanStack Vue Query and Valibot validation, from the same OpenAPI 3.1 document (openapi.yaml).
Run any of them from the repository root with pnpm example:<name>, for examplepnpm example:react-query.