mirror of
https://github.com/OpenAPITools/openapi-generator.git
synced 2025-05-12 20:50:55 +00:00
67 lines
11 KiB
HTML
67 lines
11 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>generators/java-play-framework · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="<hr>
|
|
"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="generators/java-play-framework · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/index.html"/><meta property="og:description" content="<hr>
|
|
"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
|
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
|
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
|
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
|
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
|
|
|
ga('create', 'UA-132927057-1', 'auto');
|
|
ga('send', 'pageview');
|
|
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><link rel="stylesheet" href="/css/main.css"/></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 class="postHeaderTitle">generators/java-play-framework</h1></header><article><div><span><hr>
|
|
<p>id: generator-opts-server-java-play-framework
|
|
title: Config Options for java-play-framework
|
|
sidebar_label: java-play-framework</p>
|
|
<hr>
|
|
<table>
|
|
<thead>
|
|
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr><td>sortParamsByRequiredFlag</td><td>Sort method arguments to place required parameters before optional parameters.</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>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>prependFormOrBodyParameters</td><td>Add form or body parameters to the beginning of the parameter list.</td><td></td><td>false</td></tr>
|
|
<tr><td>modelPackage</td><td>package for generated models</td><td></td><td>null</td></tr>
|
|
<tr><td>apiPackage</td><td>package for generated api classes</td><td></td><td>null</td></tr>
|
|
<tr><td>invokerPackage</td><td>root package for generated code</td><td></td><td>null</td></tr>
|
|
<tr><td>groupId</td><td>groupId in generated pom.xml</td><td></td><td>null</td></tr>
|
|
<tr><td>artifactId</td><td>artifactId in generated pom.xml</td><td></td><td>null</td></tr>
|
|
<tr><td>artifactVersion</td><td>artifact version in generated pom.xml</td><td></td><td>null</td></tr>
|
|
<tr><td>artifactUrl</td><td>artifact URL in generated pom.xml</td><td></td><td>null</td></tr>
|
|
<tr><td>artifactDescription</td><td>artifact description in generated pom.xml</td><td></td><td>null</td></tr>
|
|
<tr><td>scmConnection</td><td>SCM connection in generated pom.xml</td><td></td><td>null</td></tr>
|
|
<tr><td>scmDeveloperConnection</td><td>SCM developer connection in generated pom.xml</td><td></td><td>null</td></tr>
|
|
<tr><td>scmUrl</td><td>SCM URL in generated pom.xml</td><td></td><td>null</td></tr>
|
|
<tr><td>developerName</td><td>developer name in generated pom.xml</td><td></td><td>null</td></tr>
|
|
<tr><td>developerEmail</td><td>developer email in generated pom.xml</td><td></td><td>null</td></tr>
|
|
<tr><td>developerOrganization</td><td>developer organization in generated pom.xml</td><td></td><td>null</td></tr>
|
|
<tr><td>developerOrganizationUrl</td><td>developer organization URL in generated pom.xml</td><td></td><td>null</td></tr>
|
|
<tr><td>licenseName</td><td>The name of the license</td><td></td><td>null</td></tr>
|
|
<tr><td>licenseUrl</td><td>The URL of the license</td><td></td><td>null</td></tr>
|
|
<tr><td>sourceFolder</td><td>source folder for generated code</td><td></td><td>null</td></tr>
|
|
<tr><td>localVariablePrefix</td><td>prefix for generated code members and local variables</td><td></td><td>null</td></tr>
|
|
<tr><td>serializableModel</td><td>boolean - toggle "implements Serializable" for generated models</td><td></td><td>false</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>fullJavaUtil</td><td>whether to use fully qualified name for classes under java.util. This option only works for Java API client</td><td></td><td>false</td></tr>
|
|
<tr><td>hideGenerationTimestamp</td><td>hides the timestamp when files were generated</td><td></td><td>null</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>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 (if you really have a good reason not to use threetenbp</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+) - note: this also sets "java8" to true</dd><dt><strong>threetenbp</strong></dt><dd>Backport of JSR310 (preferred for jdk < 1.8)</dd><dl></td><td>null</td></tr>
|
|
<tr><td>java8</td><td>Option. Use Java8 classes instead of third party equivalents</td><td><dl><dt><strong>true</strong></dt><dd>Use Java 8 classes such as Base64</dd><dt><strong>false</strong></dt><dd>Various third party libraries as needed</dd><dl></td><td>null</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>booleanGetterPrefix</td><td>Set booleanGetterPrefix (default value 'get')</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>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>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>title</td><td>server title name or client service name</td><td></td><td>null</td></tr>
|
|
<tr><td>configPackage</td><td>configuration package for generated code</td><td></td><td>null</td></tr>
|
|
<tr><td>basePackage</td><td>base package for generated code</td><td></td><td>null</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>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>handleExceptions</td><td>Add a 'throw exception' 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>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>
|
|
<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>
|
|
</tbody>
|
|
</table>
|
|
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2019-1-18</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://gitter.im/OpenAPITools/openapi-generator">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2019 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html> |