Option | Description | Values | Default |
allowUnicodeIdentifiers | boolean, toggles whether unicode identifiers are allowed in names or not, default is false | | false |
apiPackage | package for generated api classes | | null |
basePackage | Base package in which supporting classes are generated. | | org.openapitools |
ensureUniqueParams | Whether to ensure parameter names are unique in an operation (rename parameters that are not). | | true |
generateCustomExceptions | If set, generates custom exception types. | | true |
modelPackage | package for generated models | | null |
prependFormOrBodyParameters | Add form or body parameters to the beginning of the parameter list. | | false |
routesFileName | Name of the routes file to generate. | | routes |
skipStubs | If set, skips generation of stub classes. | | false |
sortModelPropertiesByRequiredFlag | Sort model properties to place required parameters before optional parameters. | | true |
sortParamsByRequiredFlag | Sort method arguments to place required parameters before optional parameters. | | true |
sourceFolder | source folder for generated code | | null |
supportAsync | If set, wraps API return types with Futures and generates async actions. | | false |
useSwaggerUI | Add a route to /api which show your documentation in swagger-ui. Will also import needed dependencies | | true |
IMPORT MAPPING
Type/Alias | Imports |
Array | java.util.List |
ArrayList | java.util.ArrayList |
Date | java.util.Date |
DateTime | org.joda.time.* |
File | java.io.File |
HashMap | java.util.HashMap |
List | java.util.* |
ListBuffer | scala.collection.mutable.ListBuffer |
ListSet | scala.collection.immutable.ListSet |
LocalDate | java.time.LocalDate |
LocalDateTime | org.joda.time.* |
LocalTime | org.joda.time.* |
Map | java.util.Map |
OffsetDateTime | java.time.OffsetDateTime |
Seq | scala.collection.immutable.Seq |
Set | scala.collection.immutable.Set |
TemporaryFile | play.api.libs.Files.TemporaryFile |
Timestamp | java.sql.Timestamp |
URI | java.net.URI |
UUID | java.util.UUID |
INSTANTIATION TYPES
Type/Alias | Instantiated By |
array | List |
map | Map |
set | Set |
LANGUAGE PRIMITIVES
- Any
- Array
- Boolean
- Double
- Float
- Int
- List
- Long
- Map
- Object
- Seq
- String
- boolean
RESERVED WORDS
- abstract
- case
- catch
- class
- def
- do
- else
- extends
- false
- final
- finally
- for
- forSome
- if
- implicit
- import
- lazy
- match
- new
- null
- object
- override
- package
- private
- protected
- return
- sealed
- super
- this
- throw
- trait
- true
- try
- type
- val
- var
- while
- with
- yield
Last updated on 1/20/2020