generators/java-play-framework

id: generator-opts-server-java-play-framework title: Config Options for java-play-frameworksidebar_label: java-play-framework

OptionDescriptionValuesDefault
sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
modelPackagepackage for generated modelsapimodels
apiPackagepackage for generated api classescontrollers
invokerPackageroot package for generated codeorg.openapitools.api
groupIdgroupId in generated pom.xmlorg.openapitools
artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-java-playframework
artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename1.0.0
artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
licenseNameThe name of the licenseUnlicense
licenseUrlThe URL of the licensehttp://unlicense.org
sourceFoldersource folder for generated code/app
serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
fullJavaUtilwhether to use fully qualified name for classes under java.util. This option only works for Java API clientfalse
hideGenerationTimestampHides the generation timestamp when files are generated.false
withXmlwhether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)false
dateLibraryOption. Date library to use- joda- Joda (for legacy app only)- legacy- Legacy java.util.Date (if you really have a good reason not to use threetenbp- java8-localdatetime- Java 8 using LocalDateTime (for legacy app only)- java8- Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true- threetenbp- Backport of JSR310 (preferred for jdk < 1.8)threetenbp
java8Option. Use Java8 classes instead of third party equivalents- true- Use Java 8 classes such as Base64- false- Various third party libraries as neededfalse
disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
booleanGetterPrefixSet booleanGetterPrefixget
parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
snapshotVersionUses a SNAPSHOT version.- true- Use a SnapShot Version- false- Use a Release Versionnull
titleserver title name or client service nameopenapi-java-playframework
configPackageconfiguration package for generated codeorg.openapitools.configuration
basePackagebase package for generated codeorg.openapitools
controllerOnlyWhether to generate only API interface stubs without the server files.false
useBeanValidationUse BeanValidation API annotationstrue
useInterfacesMakes the controllerImp implements an interface to facilitate automatic completion when updating from version x to y of your spectrue
handleExceptionsAdd a 'throw exception' to each controller function. Add also a custom error handler where you can put your custom logictrue
wrapCallsAdd a wrapper to each controller function to handle things like metrics, response modification, etc..true
useSwaggerUIAdd a route to /api which show your documentation in swagger-ui. Will also import needed dependenciestrue