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