Quick Start

Example without a configuration file

$ orval --input ./petstore.yaml --output ./src/petstore.ts

--input accepts any YAML- or JSON-formatted specification.

--output specifies the target path for the generated files.

Example with a configuration file

You may also provide a configuration file through the --config option.

1$ orval --config ./orval.config.js
2# or
3$ orval

File orval.config.js

1import { defineConfig } from 'orval';
2
3export default defineConfig({
4  'petstore-file': {
5    input: './petstore.yaml',
6    output: './src/petstore.ts',
7  },
8});