Orval provides a set of options that allow you to generate your models or the API calls of your application. This page contains a complete list of all Orval options available.
To download and install Orval, follow the instructions here.
orval command is used to generate client with appropriate type-signatures. By default search for an
--input option, shorthand
-i, can be used to set the path or link to your OpenApi specification.
--output option, shorthand
-o, can be used to set the path to where you want to generate your models and HTTP calls.
--config option, shorthand
-c, can be used to set the path to your Orval config.
--project option, shorthand
-p, can be used to focus on one project of your Orval config.
--watch option, shorthand
-w, can be used to watch some files and execute orval when they change. if path is not specified, it watches the specification files. Repeat "--watch" for more than one path
--clean, can be used to clean generated files. Be carefull clean all output target and schemas folder.
--prettier, can be used to prettier generated files. You need to have prettier in your dependencies.
--tslint, can be used to specify
tslint (TSLint is deprecated in favour of eslint + plugins) as typescript linter instead of
eslint. You need to have tslint in your dependencies.
--tsconfig, can be used to specify the path to your