forked from loafle/openapi-generator-original
55 lines
29 KiB
HTML
55 lines
29 KiB
HTML
<!doctype html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="generator" content="Docusaurus">
|
|
<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="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>
|
|
<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>
|
|
|
|
<title data-react-helmet="true">Documentation for the kotlin Generator</title>
|
|
|
|
<meta data-react-helmet="true" http-equiv="x-ua-compatible" content="ie=edge"><meta data-react-helmet="true" property="og:title" content="OpenAPI Generator · Generate clients, servers, and documentation from OpenAPI 2.0/3.x documents"><meta data-react-helmet="true" property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"><meta data-react-helmet="true" property="twitter:image" content="https://openapi-generator.tech/img/docusaurus.png"><meta data-react-helmet="true" name="twitter:image:alt" content="Image for OpenAPI Generator · Generate clients, servers, and documentation from OpenAPI 2.0/3.x documents"><meta data-react-helmet="true" name="twitter:card" content="summary"><meta data-react-helmet="true" name="description" content="## METADATA"><meta data-react-helmet="true" property="og:description" content="## METADATA"><meta data-react-helmet="true" property="og:url" content="https://openapi-generator.tech/docs/generators/kotlin">
|
|
|
|
<link data-react-helmet="true" rel="shortcut icon" href="/img/favicon.png">
|
|
|
|
|
|
<link rel="stylesheet" href="/styles.7682a635.css">
|
|
|
|
</head>
|
|
<body>
|
|
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}function e(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}var n=window.matchMedia("(prefers-color-scheme: dark)");n.addListener((function(n){null===e()&&t(n.matches?"dark":"")}));var a=e();null!==a?t(a):n.matches&&t("dark")}()</script>
|
|
<div id="__docusaurus">
|
|
<nav class="navbar navbar--light navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><div aria-label="Navigation bar toggle" class="navbar__toggle" role="button" tabindex="0"><svg xmlns="http://www.w3.org/2000/svg" width="30" height="30" viewBox="0 0 30 30" role="img" focusable="false"><title>Menu</title><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></div><a aria-current="page" class="navbar__brand active" href="/"><img class="navbar__logo" src="/img/mono-logo.svg" alt="OpenAPI Tools logo"><strong>OpenAPI Generator</strong></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 class="navbar__item navbar__link" activeclassname="navbar__link--active" to="https://api.openapi-generator.tech" href="https://api.openapi-generator.tech">API</a></div><div class="navbar__items navbar__items--right"><div class="react-toggle react-toggle--disabled displayOnlyInLargeViewport_1gtM"><div class="react-toggle-track"><div class="react-toggle-track-check"><span class="toggle_keGJ moon_1gwN"></span></div><div class="react-toggle-track-x"><span class="toggle_keGJ sun_3CPA"></span></div></div><div class="react-toggle-thumb"></div><input type="checkbox" disabled="" aria-label="Dark mode toggle" class="react-toggle-screenreader-only"></div><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input type="search" id="search_input_react" placeholder="Search" aria-label="Search" class="navbar__search-input search-bar"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div><div class="navbar-sidebar"><div class="navbar-sidebar__brand"><a aria-current="page" class="navbar__brand active" href="/"><img class="navbar__logo" src="/img/mono-logo.svg" alt="OpenAPI Tools logo"><strong>OpenAPI Generator</strong></a></div><div class="navbar-sidebar__items"><div class="menu"><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" href="/docs/installation">Getting Started</a></li><li class="menu__list-item"><a aria-current="page" class="menu__link navbar__link--active" href="/docs/generators">Generators</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/roadmap">Roadmap</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/faq">FAQ</a></li><li class="menu__list-item"><a class="menu__link" href="/team">Team</a></li><li class="menu__list-item"><a class="menu__link" href="/blog">Blog</a></li><li class="menu__list-item"><a class="menu__link" activeclassname="navbar__link--active" to="https://api.openapi-generator.tech" href="https://api.openapi-generator.tech">API</a></li></ul></div></div></div></nav><div class="main-wrapper"><div class="docPage_1kjD"><main class="docMainContainer_FFX1"><div class="padding-vert--lg"><div class="container"><div class="row"><div class="col"><div class="docItemContainer_2cwg"><article><header><h1 class="docTitle_1vWb">Documentation for the kotlin Generator</h1></header><div class="markdown"><h2><a aria-hidden="true" tabindex="-1" class="anchor" id="metadata"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#metadata" title="Direct link to heading">#</a>METADATA</h2><table><thead><tr><th>Property</th><th>Value</th><th>Notes</th></tr></thead><tbody><tr><td>generator name</td><td>kotlin</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>CLIENT</td><td></td></tr><tr><td>generator language</td><td>Kotlin</td><td></td></tr><tr><td>generator default templating engine</td><td>mustache</td><td></td></tr><tr><td>helpTxt</td><td>Generates a Kotlin client.</td><td></td></tr></tbody></table><h2><a aria-hidden="true" tabindex="-1" class="anchor" id="config-options"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#config-options" title="Direct link to heading">#</a>CONFIG OPTIONS</h2><p>These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to <a href="https://openapi-generator.tech/docs/configuration">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>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>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>kotlin-client</td></tr><tr><td>artifactVersion</td><td>Generated artifact's package version.</td><td></td><td>1.0.0</td></tr><tr><td>collectionType</td><td>Option. Collection type to use</td><td><dl><dt><strong>array</strong></dt><dd>kotlin.Array</dd><dt><strong>list</strong></dt><dd>kotlin.collections.List</dd></dl></td><td>list</td></tr><tr><td>dateLibrary</td><td>Option. Date library to use</td><td><dl><dt><strong>threetenbp-localdatetime</strong></dt><dd>Threetenbp - Backport of JSR310 (jvm only, for legacy app only)</dd><dt><strong>string</strong></dt><dd>String</dd><dt><strong>java8-localdatetime</strong></dt><dd>Java 8 native JSR310 (jvm only, for legacy app only)</dd><dt><strong>java8</strong></dt><dd>Java 8 native JSR310 (jvm only, preferred for jdk 1.8+)</dd><dt><strong>threetenbp</strong></dt><dd>Threetenbp - Backport of JSR310 (jvm only, preferred for jdk < 1.8)</dd></dl></td><td>java8</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>generateRoomModels</td><td>Generate Android Room database models in addition to API models (JVM Volley library only)</td><td></td><td>false</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>idea</td><td>Add IntellJ Idea plugin and mark Kotlin main and test folders as source folders.</td><td></td><td>false</td></tr><tr><td>library</td><td>Library template (sub-template) to use</td><td><dl><dt><strong>jvm-ktor</strong></dt><dd>Platform: Java Virtual Machine. HTTP client: Ktor 1.6.7. JSON processing: Gson, Jackson (default).</dd><dt><strong>jvm-okhttp4</strong></dt><dd>[DEFAULT] Platform: Java Virtual Machine. HTTP client: OkHttp 4.2.0 (Android 5.0+ and Java 8+). JSON processing: Moshi 1.8.0.</dd><dt><strong>jvm-okhttp3</strong></dt><dd>Platform: Java Virtual Machine. HTTP client: OkHttp 3.12.4 (Android 2.3+ and Java 7+). JSON processing: Moshi 1.8.0.</dd><dt><strong>jvm-retrofit2</strong></dt><dd>Platform: Java Virtual Machine. HTTP client: Retrofit 2.6.2.</dd><dt><strong>multiplatform</strong></dt><dd>Platform: Kotlin multiplatform. HTTP client: Ktor 1.6.7. JSON processing: Kotlinx Serialization: 1.2.1.</dd><dt><strong>jvm-volley</strong></dt><dd>Platform: JVM for Android. HTTP client: Volley 1.2.1. JSON processing: gson 2.8.9</dd><dt><strong>jvm-vertx</strong></dt><dd>Platform: Java Virtual Machine. HTTP client: Vert.x Web Client. JSON processing: Moshi, Gson or Jackson.</dd></dl></td><td>jvm-okhttp4</td></tr><tr><td>modelMutable</td><td>Create mutable models</td><td></td><td>false</td></tr><tr><td>moshiCodeGen</td><td>Whether to enable codegen with the Moshi library. Refer to the <a href="https://github.com/square/moshi#codegen">official Moshi doc</a> for more info.</td><td></td><td>false</td></tr><tr><td>omitGradlePluginVersions</td><td>Whether to declare Gradle plugin versions in build files.</td><td></td><td>false</td></tr><tr><td>omitGradleWrapper</td><td>Whether to omit Gradle wrapper for creating a sub project.</td><td></td><td>false</td></tr><tr><td>packageName</td><td>Generated artifact package name.</td><td></td><td>org.openapitools.client</td></tr><tr><td>parcelizeModels</td><td>toggle "@Parcelize" for generated models</td><td></td><td>null</td></tr><tr><td>requestDateConverter</td><td>JVM-Option. Defines in how to handle date-time objects that are used for a request (as query or parameter)</td><td><dl><dt><strong>toJson</strong></dt><dd>[DEFAULT] Date formatter option using a json converter.</dd><dt><strong>toString</strong></dt><dd>Use the 'toString'-method of the date-time object to retrieve the related string representation.</dd></dl></td><td>toJson</td></tr><tr><td>serializableModel</td><td>boolean - toggle "implements Serializable" for generated models</td><td></td><td>null</td></tr><tr><td>serializationLibrary</td><td>What serialization library to use: 'moshi' (default), or 'gson' or 'jackson'</td><td></td><td>moshi</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>supportAndroidApiLevel25AndBelow</td><td>[WARNING] This flag will generate code that has a known security vulnerability. It uses <code>kotlin.io.createTempFile</code> instead of <code>java.nio.file.Files.createTempFile</code> in order to support Android API level 25 and bellow. For more info, please check the following links <a href="https://github.com/OpenAPITools/openapi-generator/security/advisories/GHSA-23x4-m842-fmwf">https://github.com/OpenAPITools/openapi-generator/security/advisories/GHSA-23x4-m842-fmwf</a>, <a href="https://github.com/OpenAPITools/openapi-generator/pull/9284">https://github.com/OpenAPITools/openapi-generator/pull/9284</a></td><td></td><td>false</td></tr><tr><td>useCoroutines</td><td>Whether to use the Coroutines adapter with the retrofit2 library.</td><td></td><td>false</td></tr><tr><td>useRxJava</td><td>Whether to use the RxJava adapter with the retrofit2 library. IMPORTANT: this option has been deprecated. Please use <code>useRxJava3</code> instead.</td><td></td><td>false</td></tr><tr><td>useRxJava2</td><td>Whether to use the RxJava2 adapter with the retrofit2 library. IMPORTANT: this option has been deprecated. Please use <code>useRxJava3</code> instead.</td><td></td><td>false</td></tr><tr><td>useRxJava3</td><td>Whether to use the RxJava3 adapter with the retrofit2 library.</td><td></td><td>false</td></tr></tbody></table><h2><a aria-hidden="true" tabindex="-1" class="anchor" id="import-mapping"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#import-mapping" title="Direct link to heading">#</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 aria-hidden="true" tabindex="-1" class="anchor" id="instantiation-types"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#instantiation-types" title="Direct link to heading">#</a>INSTANTIATION TYPES</h2><table><thead><tr><th>Type/Alias</th><th>Instantiated By</th></tr></thead><tbody><tr><td>array</td><td>kotlin.collections.ArrayList</td></tr><tr><td>list</td><td>kotlin.collections.ArrayList</td></tr><tr><td>map</td><td>kotlin.collections.HashMap</td></tr></tbody></table><h2><a aria-hidden="true" tabindex="-1" class="anchor" id="language-primitives"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#language-primitives" title="Direct link to heading">#</a>LANGUAGE PRIMITIVES</h2><ul class="column-ul"><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.MutableList</li><li>kotlin.collections.MutableMap</li><li>kotlin.collections.MutableSet</li><li>kotlin.collections.Set</li></ul><h2><a aria-hidden="true" tabindex="-1" class="anchor" id="reserved-words"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#reserved-words" title="Direct link to heading">#</a>RESERVED WORDS</h2><ul class="column-ul"><li>ApiResponse</li><li>abstract</li><li>actual</li><li>annotation</li><li>as</li><li>break</li><li>class</li><li>companion</li><li>const</li><li>constructor</li><li>continue</li><li>contract</li><li>crossinline</li><li>data</li><li>delegate</li><li>do</li><li>dynamic</li><li>else</li><li>enum</li><li>expect</li><li>external</li><li>false</li><li>field</li><li>final</li><li>finally</li><li>for</li><li>fun</li><li>if</li><li>import</li><li>in</li><li>infix</li><li>init</li><li>inline</li><li>inner</li><li>interface</li><li>internal</li><li>is</li><li>it</li><li>lateinit</li><li>noinline</li><li>null</li><li>object</li><li>open</li><li>operator</li><li>out</li><li>override</li><li>package</li><li>param</li><li>private</li><li>property</li><li>protected</li><li>public</li><li>receiver</li><li>reified</li><li>return</li><li>sealed</li><li>setparam</li><li>super</li><li>suspend</li><li>tailrec</li><li>this</li><li>throw</li><li>true</li><li>try</li><li>typealias</li><li>typeof</li><li>val</li><li>value</li><li>var</li><li>vararg</li><li>when</li><li>where</li><li>while</li></ul><h2><a aria-hidden="true" tabindex="-1" class="anchor" id="feature-set"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#feature-set" title="Direct link to heading">#</a>FEATURE SET</h2><h3><a aria-hidden="true" tabindex="-1" class="anchor" id="client-modification-feature"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#client-modification-feature" title="Direct link to heading">#</a>Client Modification Feature</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><a aria-hidden="true" tabindex="-1" class="anchor" id="data-type-feature"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#data-type-feature" title="Direct link to heading">#</a>Data Type Feature</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><a aria-hidden="true" tabindex="-1" class="anchor" id="documentation-feature"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#documentation-feature" title="Direct link to heading">#</a>Documentation Feature</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><a aria-hidden="true" tabindex="-1" class="anchor" id="global-feature"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#global-feature" title="Direct link to heading">#</a>Global Feature</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><a aria-hidden="true" tabindex="-1" class="anchor" id="parameter-feature"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#parameter-feature" title="Direct link to heading">#</a>Parameter Feature</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><a aria-hidden="true" tabindex="-1" class="anchor" id="schema-support-feature"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#schema-support-feature" title="Direct link to heading">#</a>Schema Support Feature</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><a aria-hidden="true" tabindex="-1" class="anchor" id="security-feature"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#security-feature" title="Direct link to heading">#</a>Security Feature</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></tbody></table><h3><a aria-hidden="true" tabindex="-1" class="anchor" id="wire-format-feature"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#wire-format-feature" title="Direct link to heading">#</a>Wire Format Feature</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></article><div class="margin-vert--xl"><div class="row"><div class="col"><a href="https://github.com/OpenAPITools/openapi-generator/edit/master/website/../docs/generators/kotlin.md" target="_blank" rel="noreferrer noopener"><svg fill="currentColor" height="1.2em" width="1.2em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 40 40" style="margin-right:0.3em;vertical-align:sub"><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 text--right"><em><small>Last updated on <time datetime="2022-10-28T12:49:28.000Z" class="docLastUpdatedAt_1sqk">2022-10-28</time> by <strong>신진호</strong></small></em></div></div></div><div class="margin-vert--lg"><nav class="pagination-nav"><div class="pagination-nav__item"></div><div class="pagination-nav__item pagination-nav__item--next"></div></nav></div></div></div><div class="col col--3"><div class="tableOfContents_TbNY"><ul class="contents contents__left-border"><li><a href="#metadata" class="contents__link">METADATA</a></li><li><a href="#config-options" class="contents__link">CONFIG OPTIONS</a></li><li><a href="#import-mapping" class="contents__link">IMPORT MAPPING</a></li><li><a href="#instantiation-types" class="contents__link">INSTANTIATION TYPES</a></li><li><a href="#language-primitives" class="contents__link">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words" class="contents__link">RESERVED WORDS</a></li><li><a href="#feature-set" class="contents__link">FEATURE SET</a><ul><li><a href="#client-modification-feature" class="contents__link">Client Modification Feature</a></li><li><a href="#data-type-feature" class="contents__link">Data Type Feature</a></li><li><a href="#documentation-feature" class="contents__link">Documentation Feature</a></li><li><a href="#global-feature" class="contents__link">Global Feature</a></li><li><a href="#parameter-feature" class="contents__link">Parameter Feature</a></li><li><a href="#schema-support-feature" class="contents__link">Schema Support Feature</a></li><li><a href="#security-feature" class="contents__link">Security Feature</a></li><li><a href="#wire-format-feature" class="contents__link">Wire Format Feature</a></li></ul></li></ul></div></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container"><div class="row footer__links"><div class="col footer__col"><h4 class="footer__title">Docs</h4><ul class="footer__items"><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"><h4 class="footer__title">Community</h4><ul class="footer__items"><li class="footer__item"><a class="footer__link-item" href="/users">User Showcase</a></li><li class="footer__item"><a class="footer__link-item" target="_blank" rel="noopener noreferrer" href="https://stackoverflow.com/questions/tagged/openapi-generator">Stack Overflow</a></li><li class="footer__item"><a class="footer__link-item" target="_blank" rel="noopener noreferrer" href="https://join.slack.com/t/openapi-generator/shared_invite/zt-12jxxd7p2-XUeQM~4pzsU9x~eGLQqX2g">Chat Room</a></li><li class="footer__item"><a class="footer__link-item" target="_blank" rel="noopener noreferrer" href="https://twitter.com/oas_generator">Twitter</a></li></ul></div><div class="col footer__col"><h4 class="footer__title">More</h4><ul class="footer__items"><li class="footer__item"><a class="footer__link-item" href="/blog">Blog</a></li><li class="footer__item"><a class="footer__link-item" target="_blank" rel="noopener noreferrer" href="https://github.com/OpenAPITools/openapi-generator">GitHub</a></li></ul></div></div><div class="text--center"><div class="margin-bottom--sm"><a href="https://openapi-generator.tech/" target="_blank" rel="noopener noreferrer" class="footerLogoLink_1Wg7"><img class="footer__logo" alt="OpenAPI Tools" src="/img/mono-logo.svg"></a></div>Copyright © 2022 OpenAPI-Generator Contributors (https://openapi-generator.tech)</div></div></footer>
|
|
</div>
|
|
|
|
<script src="/styles.79447035.js"></script>
|
|
|
|
<script src="/runtime~main.af8dbc76.js"></script>
|
|
|
|
<script src="/main.1f0632a6.js"></script>
|
|
|
|
<script src="/1.b1ac5afe.js"></script>
|
|
|
|
<script src="/2.bbf510e2.js"></script>
|
|
|
|
<script src="/3.5d50623a.js"></script>
|
|
|
|
<script src="/1be78505.4a0221f8.js"></script>
|
|
|
|
<script src="/20ac7829.ee7ca853.js"></script>
|
|
|
|
<script src="/17896441.149fbaab.js"></script>
|
|
|
|
<script src="/209b41dc.86870599.js"></script>
|
|
|
|
|
|
</body>
|
|
</html> |