The processor reads the configuration from the (mandatory)
mapping.yaml file. It does contain
some general options and the mapping type information.
A mapping yaml looks like this:
options: package-name: io.openapiprocessor.sample bean-validation: true javadoc: true map: # java type mappings
package-name: (required) the root package name of the generated interfaces & models. The package folder tree will be created inside the
targetDir(see using gradle).
Interfaces and models will be generated into the
so the final package name of the generated interfaces will be
and the final package name of the generated models will be
false) enables generation of bean validation annotations. Default is
false. See Bean Validation.
false) enables generation of JavaDoc comments from the OpenAPI
descriptions on the API interfaces and model pojos. Default is
false. This is still experimental.
Using type mapping we can tell the processor to map types (schemas) from an
description to a specific existing java type instead of generating a model class from the source
This is one of the core features and has his own description in mapping.