Basics

Start by generating or defining an OpenAPI specification (example petstore.yaml).

Then create a file orval.config.js at the root of your project:

Example of orval.config.js

1import { defineConfig } from 'orval';
2
3export default defineConfig({
4  'petstore-file-transformer': {
5    output: {
6      mode: 'single',
7      target: './src/petstore.ts',
8      schemas: './src/model',
9      mock: true,
10    },
11    input: {
12      target: './petstore.yaml',
13    },
14  },
15});

The output options configure how and where you want to write the generated code.

• mode specifies how files are generated (default: single - only one file with everything)
• target specifies where the generated file(s) will be written by default
• schemas specifies where the models will be written.
• mock generates mocks with the mocks generator (by default MSW). Mocks will be generated in the target file. Refer to the MSW documentation to set it up correctly in your project.

The input options configure the imported specification and any optional overrides.

• target specifies the path to the OpenAPI specification file
• override specifies options to override the input specification
  • transformer is used to transform the specification, such as adding a parameter to every request.

Consult the orval configuration reference to see all available options.