openapi-generator/docs/generators/java-play-framework.md

---

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

Option	Description	Values	Default
sortParamsByRequiredFlag	Sort method arguments 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
invokerPackage	root package for generated code		null
groupId	groupId in generated pom.xml		null
artifactId	artifactId in generated pom.xml		null
artifactVersion	artifact version in generated pom.xml		null
artifactUrl	artifact URL in generated pom.xml		null
artifactDescription	artifact description in generated pom.xml		null
scmConnection	SCM connection in generated pom.xml		null
scmDeveloperConnection	SCM developer connection in generated pom.xml		null
scmUrl	SCM URL in generated pom.xml		null
developerName	developer name in generated pom.xml		null
developerEmail	developer email in generated pom.xml		null
developerOrganization	developer organization in generated pom.xml		null
developerOrganizationUrl	developer organization URL in generated pom.xml		null
licenseName	The name of the license		null
licenseUrl	The URL of the license		null
sourceFolder	source folder for generated code		null
localVariablePrefix	prefix for generated code members and local variables		null
serializableModel	boolean - toggle "implements Serializable" for generated models		false
bigDecimalAsString	Treat BigDecimal values as Strings to avoid precision loss.		false
fullJavaUtil	whether to use fully qualified name for classes under java.util. This option only works for Java API client		false
hideGenerationTimestamp	hides the timestamp when files were generated		null
withXml	whether 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
dateLibrary	Option. 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)	null
java8	Option. Use Java8 classes instead of third party equivalents	true Use Java 8 classes such as Base64 false Various third party libraries as needed	null
disableHtmlEscaping	Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)		false
booleanGetterPrefix	Set booleanGetterPrefix (default value 'get')		null
parentGroupId	parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect		null
parentArtifactId	parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect		null
parentVersion	parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect		null
title	server title name or client service name		null
configPackage	configuration package for generated code		null
basePackage	base package for generated code		null
controllerOnly	Whether to generate only API interface stubs without the server files.		false
useBeanValidation	Use BeanValidation API annotations		true
useInterfaces	Makes the controllerImp implements an interface to facilitate automatic completion when updating from version x to y of your spec		true
handleExceptions	Add a 'throw exception' to each controller function. Add also a custom error handler where you can put your custom logic		true
wrapCalls	Add a wrapper to each controller function to handle things like metrics, response modification, etc..		true
useSwaggerUI	Add a route to /api which show your documentation in swagger-ui. Will also import needed dependencies		true