loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity
openapi-generator/docs/generators/kotlin-spring/index.html
wing328 83e04efef2 Deploy website 
Deploy website version based on e32a2f012135c394a128051c2e220fd3b9b2936c
2020-01-31 11:52:18 +00:00

128 lines
14 KiB
HTML
Raw Blame History

<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for kotlin-spring · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for kotlin-spring · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><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><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
document.addEventListener('DOMContentLoaded', function() {
addBackToTop(
{"zIndex":100}
)
});
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></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 docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for kotlin-spring</h1></header><article><div><span><table>
<thead>
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
</thead>
<tbody>
<tr><td>apiPackage</td><td>api package for generated code</td><td></td><td>org.openapitools.api</td></tr>
<tr><td>apiSuffix</td><td>suffix for api classes</td><td></td><td>Api</td></tr>
<tr><td>artifactId</td><td>Generated artifact id (name of jar).</td><td></td><td>openapi-spring</td></tr>
<tr><td>artifactVersion</td><td>Generated artifact's package version.</td><td></td><td>1.0.0</td></tr>
<tr><td>basePackage</td><td>base package (invokerPackage) for generated code</td><td></td><td>org.openapitools</td></tr>
<tr><td>delegatePattern</td><td>Whether to generate the server files using the delegate pattern</td><td></td><td>false</td></tr>
<tr><td>enumPropertyNaming</td><td>Naming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'</td><td></td><td>camelCase</td></tr>
<tr><td>exceptionHandler</td><td>generate default global exception handlers (not compatible with reactive. enabling reactive will disable exceptionHandler )</td><td></td><td>true</td></tr>
<tr><td>gradleBuildFile</td><td>generate a gradle build file using the Kotlin DSL</td><td></td><td>true</td></tr>
<tr><td>groupId</td><td>Generated artifact package's organization (i.e. maven groupId).</td><td></td><td>org.openapitools</td></tr>
<tr><td>interfaceOnly</td><td>Whether to generate only API interface stubs without the server files.</td><td></td><td>false</td></tr>
<tr><td>library</td><td>library template (sub-template)</td><td><dl><dt><strong>spring-boot</strong></dt><dd>Spring-boot Server application.</dd><dl></td><td>spring-boot</td></tr>
<tr><td>modelMutable</td><td>Create mutable models</td><td></td><td>false</td></tr>
<tr><td>modelPackage</td><td>model package for generated code</td><td></td><td>org.openapitools.model</td></tr>
<tr><td>packageName</td><td>Generated artifact package name.</td><td></td><td>org.openapitools</td></tr>
<tr><td>parcelizeModels</td><td>toggle &quot;@Parcelize&quot; for generated models</td><td></td><td>null</td></tr>
<tr><td>reactive</td><td>use coroutines for reactive behavior</td><td></td><td>false</td></tr>
<tr><td>serializableModel</td><td>boolean - toggle &quot;implements Serializable&quot; for generated models</td><td></td><td>null</td></tr>
<tr><td>serializationLibrary</td><td>What serialization library to use: 'moshi' (default), or 'gson'</td><td></td><td>moshi</td></tr>
<tr><td>serverPort</td><td>configuration the port in which the sever is to run on</td><td></td><td>8080</td></tr>
<tr><td>serviceImplementation</td><td>generate stub service implementations that extends service interfaces. If this is set to true service interfaces will also be generated</td><td></td><td>false</td></tr>
<tr><td>serviceInterface</td><td>generate service interfaces to go alongside controllers. In most cases this option would be used to update an existing project, so not to override implementations. Useful to help facilitate the generation gap pattern</td><td></td><td>false</td></tr>
<tr><td>sortModelPropertiesByRequiredFlag</td><td>Sort model properties to place required parameters before optional parameters.</td><td></td><td>null</td></tr>
<tr><td>sortParamsByRequiredFlag</td><td>Sort method arguments to place required parameters before optional parameters.</td><td></td><td>null</td></tr>
<tr><td>sourceFolder</td><td>source folder for generated code</td><td></td><td>src/main/kotlin</td></tr>
<tr><td>swaggerAnnotations</td><td>generate swagger annotations to go alongside controllers and models</td><td></td><td>false</td></tr>
<tr><td>title</td><td>server title name or client service name</td><td></td><td>OpenAPI Kotlin Spring</td></tr>
<tr><td>useBeanValidation</td><td>Use BeanValidation API annotations to validate data types</td><td></td><td>true</td></tr>
</tbody>
</table>
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
<table>
<thead>
<tr><th>Type/Alias</th><th>Imports</th></tr>
</thead>
<tbody>
<tr><td>BigDecimal</td><td>java.math.BigDecimal</td></tr>
<tr><td>Date</td><td>java.time.LocalDate</td></tr>
<tr><td>DateTime</td><td>java.time.OffsetDateTime</td></tr>
<tr><td>File</td><td>java.io.File</td></tr>
<tr><td>LocalDate</td><td>java.time.LocalDate</td></tr>
<tr><td>LocalDateTime</td><td>java.time.LocalDateTime</td></tr>
<tr><td>LocalTime</td><td>java.time.LocalTime</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><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
<table>
<thead>
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
</thead>
<tbody>
<tr><td>array</td><td>kotlin.arrayOf</td></tr>
<tr><td>list</td><td>kotlin.arrayOf</td></tr>
<tr><td>map</td><td>kotlin.mapOf</td></tr>
</tbody>
</table>
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>kotlin.Array</li>
<li>kotlin.Boolean</li>
<li>kotlin.Byte</li>
<li>kotlin.ByteArray</li>
<li>kotlin.Char</li>
<li>kotlin.Double</li>
<li>kotlin.Float</li>
<li>kotlin.Int</li>
<li>kotlin.Long</li>
<li>kotlin.Short</li>
<li>kotlin.String</li>
<li>kotlin.collections.List</li>
<li>kotlin.collections.Map</li>
<li>kotlin.collections.Set</li>
</ul>
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>ApiClient</li>
<li>ApiException</li>
<li>ApiResponse</li>
<li>as</li>
<li>break</li>
<li>class</li>
<li>continue</li>
<li>do</li>
<li>else</li>
<li>false</li>
<li>for</li>
<li>fun</li>
<li>if</li>
<li>in</li>
<li>interface</li>
<li>is</li>
<li>null</li>
<li>object</li>
<li>package</li>
<li>return</li>
<li>super</li>
<li>this</li>
<li>throw</li>
<li>true</li>
<li>try</li>
<li>typealias</li>
<li>typeof</li>
<li>val</li>
<li>var</li>
<li>when</li>
<li>while</li>
</ul>
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 1/20/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li></ul></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://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">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 © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both &quot;OpenAPI Tools&quot; (https://OpenAPITools.org) and &quot;OpenAPI Generator&quot; are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
View Git Blame Copy Permalink