openapi-generator-original/docs/generators/java-play-framework/index.html

<!doctype html>
<html lang="en" dir="ltr" class="docs-wrapper docs-doc-page docs-version-current plugin-docs plugin-id-default docs-doc-id-generators/java-play-framework">
<head>
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v2.3.1">
<title data-rh="true">Documentation for the java-play-framework Generator | OpenAPI Generator</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"><meta data-rh="true" name="twitter:image" content="https://openapi-generator.tech/img/docusaurus.png"><meta data-rh="true" property="og:url" content="https://openapi-generator.tech/docs/generators/java-play-framework"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Documentation for the java-play-framework Generator | OpenAPI Generator"><meta data-rh="true" name="description" content="METADATA"><meta data-rh="true" property="og:description" content="METADATA"><link data-rh="true" rel="icon" href="/img/favicon.png"><link data-rh="true" rel="canonical" href="https://openapi-generator.tech/docs/generators/java-play-framework"><link data-rh="true" rel="alternate" href="https://openapi-generator.tech/docs/generators/java-play-framework" hreflang="en"><link data-rh="true" rel="alternate" href="https://openapi-generator.tech/docs/generators/java-play-framework" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://51ITDG8FYN-dsn.algolia.net" crossorigin="anonymous"><link rel="alternate" type="application/rss+xml" href="/blog/rss.xml" title="OpenAPI Generator RSS Feed">
<link rel="alternate" type="application/atom+xml" href="/blog/atom.xml" title="OpenAPI Generator Atom Feed">

<link rel="preconnect" href="https://www.google-analytics.com">
<script>window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)},ga.l=+new Date,ga("create","UA-132927057-1","auto"),ga("send","pageview")</script>
<script async src="https://www.google-analytics.com/analytics.js"></script>


<link rel="search" type="application/opensearchdescription+xml" title="OpenAPI Generator" href="/opensearch.xml">
<script src="https://buttons.github.io/buttons.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script>
<script src="/js/code-block-buttons.js"></script><link rel="stylesheet" href="/assets/css/styles.fcd3a3ce.css">
<link rel="preload" href="/assets/js/runtime~main.90490b2f.js" as="script">
<link rel="preload" href="/assets/js/main.324bcbba.js" as="script">
</head>
<body class="navigation-with-keyboard">
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script><div id="__docusaurus">
<div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/mono-logo.svg" alt="OpenAPI Tools logo" class="themedImage_ToTc themedImage--light_HNdA"><img src="/img/mono-logo.svg" alt="OpenAPI Tools logo" class="themedImage_ToTc themedImage--dark_i4oU"></div><b class="navbar__title text--truncate">OpenAPI Generator</b></a><a class="navbar__item navbar__link" href="/docs/installation">Getting Started</a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/docs/generators">Generators</a><a class="navbar__item navbar__link" href="/docs/roadmap">Roadmap</a><a class="navbar__item navbar__link" href="/docs/faq">FAQ</a><a class="navbar__item navbar__link" href="/team">Team</a><a class="navbar__item navbar__link" href="/blog">Blog</a><a href="https://api.openapi-generator.tech" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">API</a></div><div class="navbar__items navbar__items--right"><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="Switch between dark and light mode (currently light mode)" aria-label="Switch between dark and light mode (currently light mode)" aria-live="polite"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg></button></div><div class="searchBox_ZlJk"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0 docsWrapper_BCFX"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docPage__5DB"><main class="docMainContainer_gTbr docMainContainerEnhanced_Uz_u"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Documentation for the java-play-framework Generator</h1></header><h2 class="anchor anchorWithStickyNavbar_LWe7" id="metadata">METADATA<a href="#metadata" class="hash-link" aria-label="Direct link to METADATA" title="Direct link to METADATA"></a></h2><table><thead><tr><th>Property</th><th>Value</th><th>Notes</th></tr></thead><tbody><tr><td>generator name</td><td>java-play-framework</td><td>pass this to the generate command after -g</td></tr><tr><td>generator stability</td><td>STABLE</td><td></td></tr><tr><td>generator type</td><td>SERVER</td><td></td></tr><tr><td>generator language</td><td>Java</td><td></td></tr><tr><td>generator default templating engine</td><td>mustache</td><td></td></tr><tr><td>helpTxt</td><td>Generates a Java Play Framework Server application.</td><td></td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="config-options">CONFIG OPTIONS<a href="#config-options" class="hash-link" aria-label="Direct link to CONFIG OPTIONS" title="Direct link to CONFIG OPTIONS"></a></h2><p>These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to <a href="https://openapi-generator.tech/docs/configuration" target="_blank" rel="noopener noreferrer">configuration docs</a> for more details.</p><table><thead><tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr></thead><tbody><tr><td>additionalEnumTypeAnnotations</td><td>Additional annotations for enum type(class level annotations)</td><td></td><td>null</td></tr><tr><td>additionalModelTypeAnnotations</td><td>Additional annotations for model type(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)</td><td></td><td>null</td></tr><tr><td>additionalOneOfTypeAnnotations</td><td>Additional annotations for oneOf interfaces(class level annotations). List separated by semicolon(;) or new line (Linux or Windows)</td><td></td><td>null</td></tr><tr><td>allowUnicodeIdentifiers</td><td>boolean, toggles whether unicode identifiers are allowed in names or not, default is false</td><td></td><td>false</td></tr><tr><td>apiPackage</td><td>package for generated api classes</td><td></td><td>controllers</td></tr><tr><td>artifactDescription</td><td>artifact description in generated pom.xml</td><td></td><td>OpenAPI Java</td></tr><tr><td>artifactId</td><td>artifactId in generated pom.xml. This also becomes part of the generated library&#x27;s filename</td><td></td><td>openapi-java-playframework</td></tr><tr><td>artifactUrl</td><td>artifact URL in generated pom.xml</td><td></td><td><a href="https://github.com/openapitools/openapi-generator" target="_blank" rel="noopener noreferrer">https://github.com/openapitools/openapi-generator</a></td></tr><tr><td>artifactVersion</td><td>artifact version in generated pom.xml. This also becomes part of the generated library&#x27;s filename. If not provided, uses the version from the OpenAPI specification file. If that&#x27;s also not present, uses the default value of the artifactVersion option.</td><td></td><td>1.0.0</td></tr><tr><td>basePackage</td><td>base package for generated code</td><td></td><td>org.openapitools</td></tr><tr><td>bigDecimalAsString</td><td>Treat BigDecimal values as Strings to avoid precision loss.</td><td></td><td>false</td></tr><tr><td>booleanGetterPrefix</td><td>Set booleanGetterPrefix</td><td></td><td>get</td></tr><tr><td>camelCaseDollarSign</td><td>Fix camelCase when starting with $ sign. when true : $Value when false : $value</td><td></td><td>false</td></tr><tr><td>configPackage</td><td>configuration package for generated code</td><td></td><td>org.openapitools.configuration</td></tr><tr><td>containerDefaultToNull</td><td>Set containers (array, set, map) default to null</td><td></td><td>false</td></tr><tr><td>controllerOnly</td><td>Whether to generate only API interface stubs without the server files.</td><td></td><td>false</td></tr><tr><td>dateLibrary</td><td>Option. Date library to use</td><td><dl><dt><strong>joda</strong></dt><dd>Joda (for legacy app only)</dd><dt><strong>legacy</strong></dt><dd>Legacy java.util.Date</dd><dt><strong>java8-localdatetime</strong></dt><dd>Java 8 using LocalDateTime (for legacy app only)</dd><dt><strong>java8</strong></dt><dd>Java 8 native JSR310 (preferred for jdk 1.8+)</dd></dl></td><td>java8</td></tr><tr><td>developerEmail</td><td>developer email in generated pom.xml</td><td></td><td><a href="mailto:team@openapitools.org" target="_blank" rel="noopener noreferrer">team@openapitools.org</a></td></tr><tr><td>developerName</td><td>developer name in generated pom.xml</td><td></td><td>OpenAPI-Generator Contributors</td></tr><tr><td>developerOrganization</td><td>developer organization in generated pom.xml</td><td></td><td>OpenAPITools.org</td></tr><tr><td>developerOrganizationUrl</td><td>developer organization URL in generated pom.xml</td><td></td><td><a href="http://openapitools.org" target="_blank" rel="noopener noreferrer">http://openapitools.org</a></td></tr><tr><td>disableHtmlEscaping</td><td>Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)</td><td></td><td>false</td></tr><tr><td>disallowAdditionalPropertiesIfNotPresent</td><td>If false, the &#x27;additionalProperties&#x27; implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that &#x27;additionalProperties&#x27; is set to false by default.</td><td><dl><dt><strong>false</strong></dt><dd>The &#x27;additionalProperties&#x27; implementation is compliant with the OAS and JSON schema specifications.</dd><dt><strong>true</strong></dt><dd>Keep the old (incorrect) behaviour that &#x27;additionalProperties&#x27; is set to false by default.</dd></dl></td><td>true</td></tr><tr><td>discriminatorCaseSensitive</td><td>Whether the discriminator value lookup should be case-sensitive or not. This option only works for Java API client</td><td></td><td>true</td></tr><tr><td>ensureUniqueParams</td><td>Whether to ensure parameter names are unique in an operation (rename parameters that are not).</td><td></td><td>true</td></tr><tr><td>enumUnknownDefaultCase</td><td>If the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, &#x27;unknown_default_open_api&#x27;, so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.</td><td><dl><dt><strong>false</strong></dt><dd>No changes to the enum&#x27;s are made, this is the default option.</dd><dt><strong>true</strong></dt><dd>With this option enabled, each enum will have a new case, &#x27;unknown_default_open_api&#x27;, so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.</dd></dl></td><td>false</td></tr><tr><td>groupId</td><td>groupId in generated pom.xml</td><td></td><td>org.openapitools</td></tr><tr><td>handleExceptions</td><td>Add a &#x27;throw exception&#x27; to each controller function. Add also a custom error handler where you can put your custom logic</td><td></td><td>true</td></tr><tr><td>hideGenerationTimestamp</td><td>Hides the generation timestamp when files are generated.</td><td></td><td>false</td></tr><tr><td>ignoreAnyOfInEnum</td><td>Ignore anyOf keyword in enum</td><td></td><td>false</td></tr><tr><td>implicitHeaders</td><td>Skip header parameters in the generated API methods using @ApiImplicitParams annotation.</td><td></td><td>false</td></tr><tr><td>implicitHeadersRegex</td><td>Skip header parameters that matches given regex in the generated API methods using @ApiImplicitParams annotation. Note: this parameter is ignored when implicitHeaders=true</td><td></td><td>null</td></tr><tr><td>invokerPackage</td><td>root package for generated code</td><td></td><td>org.openapitools.api</td></tr><tr><td>legacyDiscriminatorBehavior</td><td>Set to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).</td><td><dl><dt><strong>true</strong></dt><dd>The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.</dd><dt><strong>false</strong></dt><dd>The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.</dd></dl></td><td>true</td></tr><tr><td>licenseName</td><td>The name of the license</td><td></td><td>Unlicense</td></tr><tr><td>licenseUrl</td><td>The URL of the license</td><td></td><td><a href="http://unlicense.org" target="_blank" rel="noopener noreferrer">http://unlicense.org</a></td></tr><tr><td>modelPackage</td><td>package for generated models</td><td></td><td>apimodels</td></tr><tr><td>openApiNullable</td><td>Enable OpenAPI Jackson Nullable library</td><td></td><td>true</td></tr><tr><td>parentArtifactId</td><td>parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect</td><td></td><td>null</td></tr><tr><td>parentGroupId</td><td>parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect</td><td></td><td>null</td></tr><tr><td>parentVersion</td><td>parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect</td><td></td><td>null</td></tr><tr><td>prependFormOrBodyParameters</td><td>Add form or body parameters to the beginning of the parameter list.</td><td></td><td>false</td></tr><tr><td>scmConnection</td><td>SCM connection in generated pom.xml</td><td></td><td>scm:git:<a href="mailto:git@github.com" target="_blank" rel="noopener noreferrer">git@github.com</a>:openapitools/openapi-generator.git</td></tr><tr><td>scmDeveloperConnection</td><td>SCM developer connection in generated pom.xml</td><td></td><td>scm:git:<a href="mailto:git@github.com" target="_blank" rel="noopener noreferrer">git@github.com</a>:openapitools/openapi-generator.git</td></tr><tr><td>scmUrl</td><td>SCM URL in generated pom.xml</td><td></td><td><a href="https://github.com/openapitools/openapi-generator" target="_blank" rel="noopener noreferrer">https://github.com/openapitools/openapi-generator</a></td></tr><tr><td>serializableModel</td><td>boolean - toggle <!-- -->&quot;<!-- -->implements Serializable<!-- -->&quot;<!-- --> for generated models</td><td></td><td>false</td></tr><tr><td>snapshotVersion</td><td>Uses a SNAPSHOT version.</td><td><dl><dt><strong>true</strong></dt><dd>Use a SnapShot Version</dd><dt><strong>false</strong></dt><dd>Use a Release Version</dd></dl></td><td>null</td></tr><tr><td>sortModelPropertiesByRequiredFlag</td><td>Sort model properties to place required parameters before optional parameters.</td><td></td><td>true</td></tr><tr><td>sortParamsByRequiredFlag</td><td>Sort method arguments to place required parameters before optional parameters.</td><td></td><td>true</td></tr><tr><td>sourceFolder</td><td>source folder for generated code</td><td></td><td>/app</td></tr><tr><td>supportAsync</td><td>Support Async operations</td><td></td><td>false</td></tr><tr><td>testOutput</td><td>Set output folder for models and APIs tests</td><td></td><td>${project.build.directory}/generated-test-sources/openapi</td></tr><tr><td>title</td><td>server title name or client service name</td><td></td><td>openapi-java-playframework</td></tr><tr><td>useBeanValidation</td><td>Use BeanValidation API annotations</td><td></td><td>true</td></tr><tr><td>useInterfaces</td><td>Makes the controllerImp implements an interface to facilitate automatic completion when updating from version x to y of your spec</td><td></td><td>true</td></tr><tr><td>useJakartaEe</td><td>whether to use Jakarta EE namespace instead of javax</td><td></td><td>false</td></tr><tr><td>useOneOfInterfaces</td><td>whether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interface</td><td></td><td>false</td></tr><tr><td>useSwaggerUI</td><td>Add a route to /api which show your documentation in swagger-ui. Will also import needed dependencies</td><td></td><td>true</td></tr><tr><td>withXml</td><td>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)</td><td></td><td>false</td></tr><tr><td>wrapCalls</td><td>Add a wrapper to each controller function to handle things like metrics, response modification, etc..</td><td></td><td>true</td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="supported-vendor-extensions">SUPPORTED VENDOR EXTENSIONS<a href="#supported-vendor-extensions" class="hash-link" aria-label="Direct link to SUPPORTED VENDOR EXTENSIONS" title="Direct link to SUPPORTED VENDOR EXTENSIONS"></a></h2><table><thead><tr><th>Extension name</th><th>Description</th><th>Applicable for</th><th>Default value</th></tr></thead><tbody><tr><td>x-discriminator-value</td><td>Used with model inheritance to specify value for discriminator that identifies current model</td><td>MODEL</td><td></td></tr><tr><td>x-implements</td><td>Ability to specify interfaces that model must implements</td><td>MODEL</td><td>empty array</td></tr><tr><td>x-setter-extra-annotation</td><td>Custom annotation that can be specified over java setter for specific field</td><td>FIELD</td><td>When field is array &amp; uniqueItems, then this extension is used to add <code>@JsonDeserialize(as = LinkedHashSet.class)</code> over setter, otherwise no value</td></tr><tr><td>x-tags</td><td>Specify multiple swagger tags for operation</td><td>OPERATION</td><td>null</td></tr><tr><td>x-accepts</td><td>Specify custom value for &#x27;Accept&#x27; header for operation</td><td>OPERATION</td><td>null</td></tr><tr><td>x-content-type</td><td>Specify custom value for &#x27;Content-Type&#x27; header for operation</td><td>OPERATION</td><td>null</td></tr><tr><td>x-class-extra-annotation</td><td>List of custom annotations to be added to model</td><td>MODEL</td><td>null</td></tr><tr><td>x-field-extra-annotation</td><td>List of custom annotations to be added to property</td><td>FIELD</td><td>null</td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="import-mapping">IMPORT MAPPING<a href="#import-mapping" class="hash-link" aria-label="Direct link to IMPORT MAPPING" title="Direct link to IMPORT MAPPING"></a></h2><table><thead><tr><th>Type/Alias</th><th>Imports</th></tr></thead><tbody><tr><td>Array</td><td>java.util.List</td></tr><tr><td>ArrayList</td><td>java.util.ArrayList</td></tr><tr><td>BigDecimal</td><td>java.math.BigDecimal</td></tr><tr><td>Date</td><td>java.util.Date</td></tr><tr><td>DateTime</td><td>org.joda.time.*</td></tr><tr><td>File</td><td>java.io.File</td></tr><tr><td>HashMap</td><td>java.util.HashMap</td></tr><tr><td>LinkedHashSet</td><td>java.util.LinkedHashSet</td></tr><tr><td>List</td><td>java.util.*</td></tr><tr><td>LocalDate</td><td>org.joda.time.*</td></tr><tr><td>LocalDateTime</td><td>org.joda.time.*</td></tr><tr><td>LocalTime</td><td>org.joda.time.*</td></tr><tr><td>Map</td><td>java.util.Map</td></tr><tr><td>Set</td><td>java.util.*</td></tr><tr><td>Timestamp</td><td>java.sql.Timestamp</td></tr><tr><td>URI</td><td>java.net.URI</td></tr><tr><td>UUID</td><td>java.util.UUID</td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="instantiation-types">INSTANTIATION TYPES<a href="#instantiation-types" class="hash-link" aria-label="Direct link to INSTANTIATION TYPES" title="Direct link to INSTANTIATION TYPES"></a></h2><table><thead><tr><th>Type/Alias</th><th>Instantiated By</th></tr></thead><tbody><tr><td>array</td><td>ArrayList</td></tr><tr><td>map</td><td>HashMap</td></tr><tr><td>set</td><td>LinkedHashSet</td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="language-primitives">LANGUAGE PRIMITIVES<a href="#language-primitives" class="hash-link" aria-label="Direct link to LANGUAGE PRIMITIVES" title="Direct link to LANGUAGE PRIMITIVES"></a></h2><ul class="column-ul"><li>Boolean</li><li>Double</li><li>Float</li><li>Integer</li><li>Long</li><li>Object</li><li>String</li><li>boolean</li><li>byte[]</li></ul><h2 class="anchor anchorWithStickyNavbar_LWe7" id="reserved-words">RESERVED WORDS<a href="#reserved-words" class="hash-link" aria-label="Direct link to RESERVED WORDS" title="Direct link to RESERVED WORDS"></a></h2><ul class="column-ul"><li>_</li><li>abstract</li><li>apiclient</li><li>apiexception</li><li>apiresponse</li><li>assert</li><li>boolean</li><li>break</li><li>byte</li><li>case</li><li>catch</li><li>char</li><li>class</li><li>configuration</li><li>const</li><li>continue</li><li>default</li><li>do</li><li>double</li><li>else</li><li>enum</li><li>extends</li><li>file</li><li>final</li><li>finally</li><li>float</li><li>for</li><li>goto</li><li>if</li><li>implements</li><li>import</li><li>instanceof</li><li>int</li><li>interface</li><li>list</li><li>localdate</li><li>localreturntype</li><li>localtime</li><li>localvaraccept</li><li>localvaraccepts</li><li>localvarauthnames</li><li>localvarcollectionqueryparams</li><li>localvarcontenttype</li><li>localvarcontenttypes</li><li>localvarcookieparams</li><li>localvarformparams</li><li>localvarheaderparams</li><li>localvarpath</li><li>localvarpostbody</li><li>localvarqueryparams</li><li>long</li><li>native</li><li>new</li><li>null</li><li>object</li><li>offsetdatetime</li><li>package</li><li>private</li><li>protected</li><li>public</li><li>return</li><li>short</li><li>static</li><li>strictfp</li><li>stringutil</li><li>super</li><li>switch</li><li>synchronized</li><li>this</li><li>throw</li><li>throws</li><li>transient</li><li>try</li><li>void</li><li>volatile</li><li>while</li></ul><h2 class="anchor anchorWithStickyNavbar_LWe7" id="feature-set">FEATURE SET<a href="#feature-set" class="hash-link" aria-label="Direct link to FEATURE SET" title="Direct link to FEATURE SET"></a></h2><h3 class="anchor anchorWithStickyNavbar_LWe7" id="client-modification-feature">Client Modification Feature<a href="#client-modification-feature" class="hash-link" aria-label="Direct link to Client Modification Feature" title="Direct link to Client Modification Feature"></a></h3><table><thead><tr><th>Name</th><th>Supported</th><th>Defined By</th></tr></thead><tbody><tr><td>BasePath</td><td>✓</td><td>ToolingExtension</td></tr><tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr><tr><td>UserAgent</td><td>✗</td><td>ToolingExtension</td></tr><tr><td>MockServer</td><td>✗</td><td>ToolingExtension</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="data-type-feature">Data Type Feature<a href="#data-type-feature" class="hash-link" aria-label="Direct link to Data Type Feature" title="Direct link to Data Type Feature"></a></h3><table><thead><tr><th>Name</th><th>Supported</th><th>Defined By</th></tr></thead><tbody><tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr><tr><td>Int32</td><td>✓</td><td>OAS2,OAS3</td></tr><tr><td>Int64</td><td>✓</td><td>OAS2,OAS3</td></tr><tr><td>Float</td><td>✓</td><td>OAS2,OAS3</td></tr><tr><td>Double</td><td>✓</td><td>OAS2,OAS3</td></tr><tr><td>Decimal</td><td>✓</td><td>ToolingExtension</td></tr><tr><td>String</td><td>✓</td><td>OAS2,OAS3</td></tr><tr><td>Byte</td><td>✓</td><td>OAS2,OAS3</td></tr><tr><td>Binary</td><td>✓</td><td>OAS2,OAS3</td></tr><tr><td>Boolean</td><td>✓</td><td>OAS2,OAS3</td></tr><tr><td>Date</td><td>✓</td><td>OAS2,OAS3</td></tr><tr><td>DateTime</td><td>✓</td><td>OAS2,OAS3</td></tr><tr><td>Password</td><td>✓</td><td>OAS2,OAS3</td></tr><tr><td>File</td><td>✓</td><td>OAS2</td></tr><tr><td>Uuid</td><td>✗</td><td></td></tr><tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr><tr><td>Null</td><td>✗</td><td>OAS3</td></tr><tr><td>AnyType</td><td>✗</td><td>OAS2,OAS3</td></tr><tr><td>Object</td><td>✓</td><td>OAS2,OAS3</td></tr><tr><td>Maps</td><td>✓</td><td>ToolingExtension</td></tr><tr><td>CollectionFormat</td><td>✓</td><td>OAS2</td></tr><tr><td>CollectionFormatMulti</td><td>✓</td><td>OAS2</td></tr><tr><td>Enum</td><td>✓</td><td>OAS2,OAS3</td></tr><tr><td>ArrayOfEnum</td><td>✓</td><td>ToolingExtension</td></tr><tr><td>ArrayOfModel</td><td>✓</td><td>ToolingExtension</td></tr><tr><td>ArrayOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr><tr><td>ArrayOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr><tr><td>ArrayOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr><tr><td>MapOfEnum</td><td>✓</td><td>ToolingExtension</td></tr><tr><td>MapOfModel</td><td>✓</td><td>ToolingExtension</td></tr><tr><td>MapOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr><tr><td>MapOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr><tr><td>MapOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="documentation-feature">Documentation Feature<a href="#documentation-feature" class="hash-link" aria-label="Direct link to Documentation Feature" title="Direct link to Documentation Feature"></a></h3><table><thead><tr><th>Name</th><th>Supported</th><th>Defined By</th></tr></thead><tbody><tr><td>Readme</td><td>✓</td><td>ToolingExtension</td></tr><tr><td>Model</td><td>✓</td><td>ToolingExtension</td></tr><tr><td>Api</td><td>✓</td><td>ToolingExtension</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="global-feature">Global Feature<a href="#global-feature" class="hash-link" aria-label="Direct link to Global Feature" title="Direct link to Global Feature"></a></h3><table><thead><tr><th>Name</th><th>Supported</th><th>Defined By</th></tr></thead><tbody><tr><td>Host</td><td>✓</td><td>OAS2,OAS3</td></tr><tr><td>BasePath</td><td>✓</td><td>OAS2,OAS3</td></tr><tr><td>Info</td><td>✓</td><td>OAS2,OAS3</td></tr><tr><td>Schemes</td><td>✗</td><td>OAS2,OAS3</td></tr><tr><td>PartialSchemes</td><td>✓</td><td>OAS2,OAS3</td></tr><tr><td>Consumes</td><td>✓</td><td>OAS2</td></tr><tr><td>Produces</td><td>✓</td><td>OAS2</td></tr><tr><td>ExternalDocumentation</td><td>✓</td><td>OAS2,OAS3</td></tr><tr><td>Examples</td><td>✓</td><td>OAS2,OAS3</td></tr><tr><td>XMLStructureDefinitions</td><td>✗</td><td>OAS2,OAS3</td></tr><tr><td>MultiServer</td><td>✗</td><td>OAS3</td></tr><tr><td>ParameterizedServer</td><td>✗</td><td>OAS3</td></tr><tr><td>ParameterStyling</td><td>✗</td><td>OAS3</td></tr><tr><td>Callbacks</td><td>✗</td><td>OAS3</td></tr><tr><td>LinkObjects</td><td>✗</td><td>OAS3</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="parameter-feature">Parameter Feature<a href="#parameter-feature" class="hash-link" aria-label="Direct link to Parameter Feature" title="Direct link to Parameter Feature"></a></h3><table><thead><tr><th>Name</th><th>Supported</th><th>Defined By</th></tr></thead><tbody><tr><td>Path</td><td>✓</td><td>OAS2,OAS3</td></tr><tr><td>Query</td><td>✓</td><td>OAS2,OAS3</td></tr><tr><td>Header</td><td>✓</td><td>OAS2,OAS3</td></tr><tr><td>Body</td><td>✓</td><td>OAS2</td></tr><tr><td>FormUnencoded</td><td>✓</td><td>OAS2</td></tr><tr><td>FormMultipart</td><td>✓</td><td>OAS2</td></tr><tr><td>Cookie</td><td>✓</td><td>OAS3</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="schema-support-feature">Schema Support Feature<a href="#schema-support-feature" class="hash-link" aria-label="Direct link to Schema Support Feature" title="Direct link to Schema Support Feature"></a></h3><table><thead><tr><th>Name</th><th>Supported</th><th>Defined By</th></tr></thead><tbody><tr><td>Simple</td><td>✓</td><td>OAS2,OAS3</td></tr><tr><td>Composite</td><td>✓</td><td>OAS2,OAS3</td></tr><tr><td>Polymorphism</td><td>✗</td><td>OAS2,OAS3</td></tr><tr><td>Union</td><td>✗</td><td>OAS3</td></tr><tr><td>allOf</td><td>✗</td><td>OAS2,OAS3</td></tr><tr><td>anyOf</td><td>✗</td><td>OAS3</td></tr><tr><td>oneOf</td><td>✗</td><td>OAS3</td></tr><tr><td>not</td><td>✗</td><td>OAS3</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="security-feature">Security Feature<a href="#security-feature" class="hash-link" aria-label="Direct link to Security Feature" title="Direct link to Security Feature"></a></h3><table><thead><tr><th>Name</th><th>Supported</th><th>Defined By</th></tr></thead><tbody><tr><td>BasicAuth</td><td>✓</td><td>OAS2,OAS3</td></tr><tr><td>ApiKey</td><td>✓</td><td>OAS2,OAS3</td></tr><tr><td>OpenIDConnect</td><td>✗</td><td>OAS3</td></tr><tr><td>BearerToken</td><td>✓</td><td>OAS3</td></tr><tr><td>OAuth2_Implicit</td><td>✓</td><td>OAS2,OAS3</td></tr><tr><td>OAuth2_Password</td><td>✗</td><td>OAS2,OAS3</td></tr><tr><td>OAuth2_ClientCredentials</td><td>✗</td><td>OAS2,OAS3</td></tr><tr><td>OAuth2_AuthorizationCode</td><td>✗</td><td>OAS2,OAS3</td></tr><tr><td>SignatureAuth</td><td>✗</td><td>OAS3</td></tr><tr><td>AWSV4Signature</td><td>✗</td><td>ToolingExtension</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="wire-format-feature">Wire Format Feature<a href="#wire-format-feature" class="hash-link" aria-label="Direct link to Wire Format Feature" title="Direct link to Wire Format Feature"></a></h3><table><thead><tr><th>Name</th><th>Supported</th><th>Defined By</th></tr></thead><tbody><tr><td>JSON</td><td>✓</td><td>OAS2,OAS3</td></tr><tr><td>XML</td><td>✓</td><td>OAS2,OAS3</td></tr><tr><td>PROTOBUF</td><td>✗</td><td>ToolingExtension</td></tr><tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr></tbody></table></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/OpenAPITools/openapi-generator/edit/master/website/../docs/generators/java-play-framework.md" target="_blank" rel="noreferrer noopener" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_vwxv"><span class="theme-last-updated">Last updated<!-- --> on <b><time datetime="2024-04-09T04:21:54.000Z">Apr 9, 2024</time></b> by <b>William Cheng</b></span></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages navigation"></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#metadata" class="table-of-contents__link toc-highlight">METADATA</a></li><li><a href="#config-options" class="table-of-contents__link toc-highlight">CONFIG OPTIONS</a></li><li><a href="#supported-vendor-extensions" class="table-of-contents__link toc-highlight">SUPPORTED VENDOR EXTENSIONS</a></li><li><a href="#import-mapping" class="table-of-contents__link toc-highlight">IMPORT MAPPING</a></li><li><a href="#instantiation-types" class="table-of-contents__link toc-highlight">INSTANTIATION TYPES</a></li><li><a href="#language-primitives" class="table-of-contents__link toc-highlight">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words" class="table-of-contents__link toc-highlight">RESERVED WORDS</a></li><li><a href="#feature-set" class="table-of-contents__link toc-highlight">FEATURE SET</a><ul><li><a href="#client-modification-feature" class="table-of-contents__link toc-highlight">Client Modification Feature</a></li><li><a href="#data-type-feature" class="table-of-contents__link toc-highlight">Data Type Feature</a></li><li><a href="#documentation-feature" class="table-of-contents__link toc-highlight">Documentation Feature</a></li><li><a href="#global-feature" class="table-of-contents__link toc-highlight">Global Feature</a></li><li><a href="#parameter-feature" class="table-of-contents__link toc-highlight">Parameter Feature</a></li><li><a href="#schema-support-feature" class="table-of-contents__link toc-highlight">Schema Support Feature</a></li><li><a href="#security-feature" class="table-of-contents__link toc-highlight">Security Feature</a></li><li><a href="#wire-format-feature" class="table-of-contents__link toc-highlight">Wire Format Feature</a></li></ul></li></ul></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs/customization">Customizing Generators</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/installation">Installation</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/integrations">Workflow Integrations</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/users">User Showcase</a></li><li class="footer__item"><a href="https://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noopener noreferrer" class="footer__link-item">Stack Overflow<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://join.slack.com/t/openapi-generator/shared_invite/zt-12jxxd7p2-XUeQM~4pzsU9x~eGLQqX2g" target="_blank" rel="noopener noreferrer" class="footer__link-item">Chat Room<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://twitter.com/oas_generator" target="_blank" rel="noopener noreferrer" class="footer__link-item">Twitter<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/blog">Blog</a></li><li class="footer__item"><a href="https://github.com/OpenAPITools/openapi-generator" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="margin-bottom--sm"><a href="https://openapi-generator.tech/" rel="noopener noreferrer" class="footerLogoLink_BH7S"><img src="/img/mono-logo.svg" alt="OpenAPI Tools" class="themedImage_ToTc themedImage--light_HNdA footer__logo"><img src="/img/mono-logo.svg" alt="OpenAPI Tools" class="themedImage_ToTc themedImage--dark_i4oU footer__logo"></a></div><div class="footer__copyright">Copyright © 2024 OpenAPI-Generator Contributors (https://openapi-generator.tech)</div></div></div></footer></div>
<script src="/assets/js/runtime~main.90490b2f.js"></script>
<script src="/assets/js/main.324bcbba.js"></script>
</body>
</html>