Generate Typescript clients from OpenAPI specification!

⚠️ Actively searching for contributors, if you want to help, please contact me on discord ⚠️

Code Generation

orval generates type-safe JS clients (TypeScript) from any valid OpenAPI v3 or Swagger v2 specification, either in yaml or json formats.

Supported clients

generate models, requests, hooks, mocks and more, for these supported clients:

• React
• React Query
• React with swr
• Vue Query
• Svelte Query
• Solid Query
• SolidStart
• Angular
• Angular Query
• Hono
• zod
• native fetch
• mcp

Samples

You can find some samples below:

• react app
• react query
• svelte query
• vue query
• react app with swr
• angular app
• angular query
• hono
• next app with fetch
• mcp server

Playground

Try Orval out for yourself using our Playground application!

Developers

This project uses Yarn for package management and building. Here are the key scripts available for development:

Prerequisites

Before using Yarn scripts, ensure you have Yarn installed. You can install it globally using npm:

npm install -g yarn

Alternatively, you can enable Corepack (which comes with Node.js 16.10+) to manage Yarn:

corepack enable

Build Scripts

• yarn nuke:all - Completely clean your workspace by removing all build artifacts, node_modules, and cached files. Use this when you want to start fresh.

• yarn build - Build the project and make changes available to the workspace. Run this after making code changes to compile TypeScript and prepare the project for use.

Test Scripts

• yarn test - Run unit tests in all packages.

• yarn update-samples - Generate sample outputs using the newly built version of Orval. This regenerates the sample code based on the current build.

• yarn test:samples - Run tests in the samples directory using the newly generated output from update-samples.

• yarn test:cli - Test that the generated output (not samples) is valid TypeScript. This validates the TypeScript compilation of the generated code.

Development Workflow

A typical development workflow would be:

1. Make your code changes
2. Run yarn build to compile your changes
3. Run yarn test to ensure unit tests pass
4. Run yarn update-samples to regenerate sample outputs
5. Run yarn test:samples to verify samples work correctly
6. Run yarn test:cli to validate TypeScript compilation

If you encounter issues or want to start completely fresh:

1. Run yarn nuke:all to clean everything
2. Reinstall dependencies and rebuild from scratch

Sponsors

Thank you to all our sponsors! 🍻

Support orval development by Open Collective and your logo will be displayed here with a link to your website.

Backers

Thank you to all our backers! 🙏

Support us with a one-time donation and help us continue our activities on Open Collective.

Note: After becoming a sponsor or backer, please contact us on Discord to upload your logo.

Star History

All Thanks To Our Contributors: