wing328 9c284211ce Deploy website
Deploy website version based on c51f333f6c9d0a58366879e85dafb4c0b0afdc2d
2019-01-18 14:51:53 +00:00

34 lines
7.6 KiB
HTML

<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>generators/kotlin-spring · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="&lt;hr&gt;
"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="generators/kotlin-spring · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://OpenAPITools.github.io/openapi-generator/index.html"/><meta property="og:description" content="&lt;hr&gt;
"/><meta property="og:image" content="https://OpenAPITools.github.io/openapi-generator/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://OpenAPITools.github.io/openapi-generator/img/icons/twitter.svg"/><link rel="shortcut icon" href="/openapi-generator/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://OpenAPITools.github.io/openapi-generator/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://OpenAPITools.github.io/openapi-generator/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><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="/openapi-generator/js/code-block-buttons.js"></script><link rel="stylesheet" href="/openapi-generator/css/main.css"/></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/openapi-generator/"><img class="logo" src="/openapi-generator/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="/openapi-generator/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/openapi-generator/docs/generators" target="_self">Generators</a></li><li class=""><a href="/openapi-generator/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/openapi-generator/team" target="_self">Team</a></li><li class=""><a href="/openapi-generator/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/openapi-generator/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/kotlin-spring</h1></header><article><div><span><hr>
<p>id: generator-opts-server-kotlin-spring
title: Config Options for kotlin-spring
sidebar_label: kotlin-spring</p>
<hr>
<table>
<thead>
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
</thead>
<tbody>
<tr><td>sourceFolder</td><td>source folder for generated code</td><td></td><td>src/main/kotlin</td></tr>
<tr><td>packageName</td><td>Generated artifact package name.</td><td></td><td>org.openapitools</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>artifactId</td><td>Generated artifact id (name of jar).</td><td></td><td>null</td></tr>
<tr><td>artifactVersion</td><td>Generated artifact's package version.</td><td></td><td>1.0.0</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>parcelizeModels</td><td>toggle &quot;@Parcelize&quot; for generated models</td><td></td><td>null</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>basePackage</td><td>base package (invokerPackage) for generated code</td><td></td><td>org.openapitools</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>modelPackage</td><td>model package for generated code</td><td></td><td>org.openapitools.model</td></tr>
<tr><td>apiPackage</td><td>api package for generated code</td><td></td><td>org.openapitools.api</td></tr>
<tr><td>exceptionHandler</td><td>generate default global exception handlers</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>swaggerAnnotations</td><td>generate swagger annotations to go alongside controllers and models</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>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>useBeanValidation</td><td>Use BeanValidation API annotations to validate data types</td><td></td><td>true</td></tr>
<tr><td>library</td><td>library template (sub-template) to use</td><td><dl><dt><strong>spring-boot</strong></dt><dd>Spring-boot Server application.</dd><dl></td><td>spring-boot</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="/openapi-generator/" class="nav-home"><img src="/openapi-generator/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/openapi-generator/docs/en/customization.html">Customizing Generators</a><a href="/openapi-generator/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/openapi-generator/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">Project Chat</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/openapi-generator/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="attribution"><a href="https://code.facebook.com/projects/" target="_blank" rel="noreferrer noopener" class="fbOpenSource"><img src="/openapi-generator/img/oss_logo.png" alt="Facebook Open Source" width="170" height="45"/></a><a href="https://fontawesome.com/license/free" target="_blank" rel="noreferrer noopener" class="fbOpenSource"><img src="/openapi-generator/img/fa-logo.svg" alt="Fontawesome (Free)" width="170" height="45"/></a></section><section class="copyright">Copyright © 2019 OpenAPI-Generator Contributors (https://openapi-generator.tech)</section></footer></div></body></html>