Skip to main content

Overview

Orval is able to generate client with appropriate type-signatures (TypeScript) from any valid OpenAPI v3 or Swagger v2 specification, in either YAML or JSON format.

Motivation

Developers often use swagger as a contract between the frontend and backend. Before Orval, tools such as Swagger Editor or Swagger Codegen did the job. But that is not enough for modern development needs. Enter Orval.

Main goals:

  • Generate TypeScript models
  • Generate HTTP request functions
  • Generate mocks with MSW

The default generated clients use Axios, but you may configure any client and underlying HTTP client, for your project needs. Orval supports most major JavaScript frameworks such as Angular, React or Vue. Learn more about configuring Orval

Orval can also generate the following client:

Edit this page on GitHub
Was this page helpful?