forked from loafle/openapi-generator-original
[docs] Sorted doc outputs and clean up duplicated CliOptions (#5046)
* [config-help] Sort all outputs
* Remove old/stale generator docs (these have been renamed previously)
* Sort config doc outputs, making it easier to find relevant info
* Fixes cliOptions duplicates
Erlang client/proper improperly set the version option as packageName
(causing duplicate for packageName).
The java and swift option removals are because the options are added in
parent classes, resulting in duplication of the options.
* Add --github-nested-index for generating docs/generators/README.md
* 📝 Regenerate generator docs
This commit is contained in:
Jim Schubert
GitHub
parent
bbe88ba635
commit
644f720db8
@ -1,123 +1,138 @@
|
||||
<!-- Generate with: openapi-generator list --github-nested-index -->
|
||||
The following generators are available:
|
||||
|
||||
* CLIENT generators:
|
||||
- [ada](ada.md)
|
||||
- [android](android.md)
|
||||
- [apex](apex.md)
|
||||
- [bash](bash.md)
|
||||
- [c](c.md)
|
||||
- [clojure](clojure.md)
|
||||
- [cpp-qt5-client](cpp-qt5-client.md)
|
||||
- [cpp-restsdk](cpp-restsdk.md)
|
||||
- [cpp-tizen](cpp-tizen.md)
|
||||
- [csharp](csharp.md)
|
||||
- [csharp-dotnet2](csharp-dotnet2.md)
|
||||
- [csharp-refactor](csharp-refactor.md)
|
||||
- [dart](dart.md)
|
||||
- [dart-dio](dart-dio.md)
|
||||
- [dart-jaguar](dart-jaguar.md)
|
||||
- [eiffel](eiffel.md)
|
||||
- [elixir](elixir.md)
|
||||
- [elm](elm.md)
|
||||
- [erlang-client](erlang-client.md)
|
||||
- [erlang-proper](erlang-proper.md)
|
||||
- [flash](flash.md)
|
||||
- [go](go.md)
|
||||
- [groovy](groovy.md)
|
||||
- [haskell-http-client](haskell-http-client.md)
|
||||
- [java](java.md)
|
||||
- [javascript](javascript.md)
|
||||
- [javascript-closure-angular](javascript-closure-angular.md)
|
||||
- [javascript-flowtyped](javascript-flowtyped.md)
|
||||
- [jaxrs-cxf-client](jaxrs-cxf-client.md)
|
||||
- [jmeter](jmeter.md)
|
||||
- [kotlin](kotlin.md)
|
||||
- [lua](lua.md)
|
||||
- [objc](objc.md)
|
||||
- [perl](perl.md)
|
||||
- [php](php.md)
|
||||
- [powershell](powershell.md)
|
||||
- [python](python.md)
|
||||
- [r](r.md)
|
||||
- [ruby](ruby.md)
|
||||
- [rust](rust.md)
|
||||
- [scala-akka](scala-akka.md)
|
||||
- [scala-gatling](scala-gatling.md)
|
||||
- [scala-httpclient](scala-httpclient.md)
|
||||
- [scalaz](scalaz.md)
|
||||
- [swift2-deprecated](swift2-deprecated.md)
|
||||
- [swift3-deprecated](swift3-deprecated.md)
|
||||
- [swift4](swift4.md)
|
||||
- [typescript-angular](typescript-angular.md)
|
||||
- [typescript-angularjs](typescript-angularjs.md)
|
||||
- [typescript-aurelia](typescript-aurelia.md)
|
||||
- [typescript-axios](typescript-axios.md)
|
||||
- [typescript-fetch](typescript-fetch.md)
|
||||
- [typescript-inversify](typescript-inversify.md)
|
||||
- [typescript-jquery](typescript-jquery.md)
|
||||
- [typescript-node](typescript-node.md)
|
||||
- [typescript-rxjs](typescript-rxjs.md)
|
||||
## CLIENT generators
|
||||
* [ada](ada.md)
|
||||
* [android](android.md)
|
||||
* [apex](apex.md)
|
||||
* [bash](bash.md)
|
||||
* [c](c.md)
|
||||
* [clojure](clojure.md)
|
||||
* [cpp-qt5-client](cpp-qt5-client.md)
|
||||
* [cpp-restsdk](cpp-restsdk.md)
|
||||
* [cpp-tizen](cpp-tizen.md)
|
||||
* [csharp](csharp.md)
|
||||
* [csharp-netcore](csharp-netcore.md)
|
||||
* [dart](dart.md)
|
||||
* [dart-dio](dart-dio.md)
|
||||
* [dart-jaguar](dart-jaguar.md)
|
||||
* [eiffel](eiffel.md)
|
||||
* [elixir](elixir.md)
|
||||
* [elm](elm.md)
|
||||
* [erlang-client](erlang-client.md)
|
||||
* [erlang-proper](erlang-proper.md)
|
||||
* [flash](flash.md)
|
||||
* [go](go.md)
|
||||
* [go-experimental (experimental)](go-experimental.md)
|
||||
* [groovy](groovy.md)
|
||||
* [haskell-http-client](haskell-http-client.md)
|
||||
* [java](java.md)
|
||||
* [javascript](javascript.md)
|
||||
* [javascript-closure-angular](javascript-closure-angular.md)
|
||||
* [javascript-flowtyped](javascript-flowtyped.md)
|
||||
* [jaxrs-cxf-client](jaxrs-cxf-client.md)
|
||||
* [jmeter](jmeter.md)
|
||||
* [kotlin](kotlin.md)
|
||||
* [lua](lua.md)
|
||||
* [nim (beta)](nim.md)
|
||||
* [objc](objc.md)
|
||||
* [ocaml](ocaml.md)
|
||||
* [perl](perl.md)
|
||||
* [php](php.md)
|
||||
* [powershell](powershell.md)
|
||||
* [python](python.md)
|
||||
* [python-experimental (experimental)](python-experimental.md)
|
||||
* [r](r.md)
|
||||
* [ruby](ruby.md)
|
||||
* [rust](rust.md)
|
||||
* [scala-akka](scala-akka.md)
|
||||
* [scala-gatling](scala-gatling.md)
|
||||
* [scalaz](scalaz.md)
|
||||
* [swift4](swift4.md)
|
||||
* [swift5 (beta)](swift5.md)
|
||||
* [typescript-angular](typescript-angular.md)
|
||||
* [typescript-angularjs](typescript-angularjs.md)
|
||||
* [typescript-aurelia](typescript-aurelia.md)
|
||||
* [typescript-axios](typescript-axios.md)
|
||||
* [typescript-fetch](typescript-fetch.md)
|
||||
* [typescript-inversify](typescript-inversify.md)
|
||||
* [typescript-jquery](typescript-jquery.md)
|
||||
* [typescript-node](typescript-node.md)
|
||||
* [typescript-redux-query](typescript-redux-query.md)
|
||||
* [typescript-rxjs](typescript-rxjs.md)
|
||||
|
||||
|
||||
* SERVER generators:
|
||||
- [ada-server](ada-server.md)
|
||||
- [aspnetcore](aspnetcore.md)
|
||||
- [cpp-pistache-server](cpp-pistache-server.md)
|
||||
- [cpp-qt5-qhttpengine-server](cpp-qt5-qhttpengine-server.md)
|
||||
- [cpp-restbed-server](cpp-restbed-server.md)
|
||||
- [csharp-nancyfx](csharp-nancyfx.md)
|
||||
- [erlang-server](erlang-server.md)
|
||||
- [go-gin-server](go-gin-server.md)
|
||||
- [go-server](go-server.md)
|
||||
- [graphql-server](graphql-server.md)
|
||||
- [haskell](haskell.md)
|
||||
- [java-inflector](java-inflector.md)
|
||||
- [java-msf4j](java-msf4j.md)
|
||||
- [java-pkmst](java-pkmst.md)
|
||||
- [java-play-framework](java-play-framework.md)
|
||||
- [java-undertow-server](java-undertow-server.md)
|
||||
- [java-vertx](java-vertx.md)
|
||||
- [jaxrs-cxf](jaxrs-cxf.md)
|
||||
- [jaxrs-cxf-cdi](jaxrs-cxf-cdi.md)
|
||||
- [jaxrs-jersey](jaxrs-jersey.md)
|
||||
- [jaxrs-resteasy](jaxrs-resteasy.md)
|
||||
- [jaxrs-resteasy-eap](jaxrs-resteasy-eap.md)
|
||||
- [jaxrs-spec](jaxrs-spec.md)
|
||||
- [kotlin-server](kotlin-server.md)
|
||||
- [kotlin-spring](kotlin-spring.md)
|
||||
- [nodejs-server](nodejs-server.md)
|
||||
- [php-laravel](php-laravel.md)
|
||||
- [php-lumen](php-lumen.md)
|
||||
- [php-silex](php-silex.md)
|
||||
- [php-slim](php-slim.md)
|
||||
- [php-symfony](php-symfony.md)
|
||||
- [php-ze-ph](php-ze-ph.md)
|
||||
- [python-flask](python-flask.md)
|
||||
- [ruby-on-rails](ruby-on-rails.md)
|
||||
- [ruby-sinatra](ruby-sinatra.md)
|
||||
- [rust-server](rust-server.md)
|
||||
- [scala-finch](scala-finch.md)
|
||||
- [scala-lagom-server](scala-lagom-server.md)
|
||||
- [scalatra](scalatra.md)
|
||||
- [spring](spring.md)
|
||||
## SERVER generators
|
||||
* [ada-server](ada-server.md)
|
||||
* [aspnetcore](aspnetcore.md)
|
||||
* [cpp-pistache-server](cpp-pistache-server.md)
|
||||
* [cpp-qt5-qhttpengine-server](cpp-qt5-qhttpengine-server.md)
|
||||
* [cpp-restbed-server](cpp-restbed-server.md)
|
||||
* [csharp-nancyfx](csharp-nancyfx.md)
|
||||
* [erlang-server](erlang-server.md)
|
||||
* [fsharp-functions (beta)](fsharp-functions.md)
|
||||
* [fsharp-giraffe-server (beta)](fsharp-giraffe-server.md)
|
||||
* [go-gin-server](go-gin-server.md)
|
||||
* [go-server](go-server.md)
|
||||
* [graphql-nodejs-express-server](graphql-nodejs-express-server.md)
|
||||
* [haskell](haskell.md)
|
||||
* [java-inflector](java-inflector.md)
|
||||
* [java-msf4j](java-msf4j.md)
|
||||
* [java-pkmst](java-pkmst.md)
|
||||
* [java-play-framework](java-play-framework.md)
|
||||
* [java-undertow-server](java-undertow-server.md)
|
||||
* [java-vertx](java-vertx.md)
|
||||
* [java-vertx-web (beta)](java-vertx-web.md)
|
||||
* [jaxrs-cxf](jaxrs-cxf.md)
|
||||
* [jaxrs-cxf-cdi](jaxrs-cxf-cdi.md)
|
||||
* [jaxrs-cxf-extended](jaxrs-cxf-extended.md)
|
||||
* [jaxrs-jersey](jaxrs-jersey.md)
|
||||
* [jaxrs-resteasy](jaxrs-resteasy.md)
|
||||
* [jaxrs-resteasy-eap](jaxrs-resteasy-eap.md)
|
||||
* [jaxrs-spec](jaxrs-spec.md)
|
||||
* [kotlin-server](kotlin-server.md)
|
||||
* [kotlin-spring](kotlin-spring.md)
|
||||
* [kotlin-vertx (beta)](kotlin-vertx.md)
|
||||
* [nodejs-express-server (beta)](nodejs-express-server.md)
|
||||
* [php-laravel](php-laravel.md)
|
||||
* [php-lumen](php-lumen.md)
|
||||
* [php-silex](php-silex.md)
|
||||
* [php-slim4](php-slim4.md)
|
||||
* [php-symfony](php-symfony.md)
|
||||
* [php-ze-ph](php-ze-ph.md)
|
||||
* [python-aiohttp](python-aiohttp.md)
|
||||
* [python-blueplanet](python-blueplanet.md)
|
||||
* [python-flask](python-flask.md)
|
||||
* [ruby-on-rails](ruby-on-rails.md)
|
||||
* [ruby-sinatra](ruby-sinatra.md)
|
||||
* [rust-server](rust-server.md)
|
||||
* [scala-finch](scala-finch.md)
|
||||
* [scala-lagom-server](scala-lagom-server.md)
|
||||
* [scala-play-server](scala-play-server.md)
|
||||
* [scalatra](scalatra.md)
|
||||
* [spring](spring.md)
|
||||
|
||||
|
||||
* DOCUMENTATION generators:
|
||||
- [cwiki](cwiki.md)
|
||||
- [dynamic-html](dynamic-html.md)
|
||||
- [html](html.md)
|
||||
- [html2](html2.md)
|
||||
- [openapi](openapi.md)
|
||||
- [openapi-yaml](openapi-yaml.md)
|
||||
## DOCUMENTATION generators
|
||||
* [asciidoc](asciidoc.md)
|
||||
* [cwiki](cwiki.md)
|
||||
* [dynamic-html](dynamic-html.md)
|
||||
* [html](html.md)
|
||||
* [html2](html2.md)
|
||||
* [markdown (beta)](markdown.md)
|
||||
* [openapi](openapi.md)
|
||||
* [openapi-yaml](openapi-yaml.md)
|
||||
|
||||
|
||||
* SCHEMA generators:
|
||||
- [mysql-schema](mysql-schema.md)
|
||||
## SCHEMA generators
|
||||
* [avro-schema (beta)](avro-schema.md)
|
||||
* [mysql-schema](mysql-schema.md)
|
||||
|
||||
|
||||
* CONFIG generators:
|
||||
- [apache2](apache2.md)
|
||||
- [graphql-schema](graphql-schema.md)
|
||||
## CONFIG generators
|
||||
* [apache2](apache2.md)
|
||||
* [graphql-schema](graphql-schema.md)
|
||||
* [protobuf-schema (beta)](protobuf-schema.md)
|
||||
|
||||
|
||||
|
||||
|
||||
@ -5,12 +5,12 @@ sidebar_label: ada-server
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|projectName|GNAT project name| |defaultProject|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
@ -26,88 +26,88 @@ sidebar_label: ada-server
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>Integer</li>
|
||||
<li>boolean</li>
|
||||
<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>Boolean</li>
|
||||
<li>Character</li>
|
||||
<li>Integer</li>
|
||||
<li>boolean</li>
|
||||
<li>double</li>
|
||||
<li>integer</li>
|
||||
<li>Boolean</li>
|
||||
<li>float</li>
|
||||
<li>integer</li>
|
||||
<li>long</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>exception</li>
|
||||
<li>synchronized</li>
|
||||
<li>constant</li>
|
||||
<li>mod</li>
|
||||
<li>select</li>
|
||||
<li>declare</li>
|
||||
<li>separate</li>
|
||||
<li>use</li>
|
||||
<li>do</li>
|
||||
<li>elsif</li>
|
||||
<li>body</li>
|
||||
<li>type</li>
|
||||
<li>while</li>
|
||||
<li>when</li>
|
||||
<li>aliased</li>
|
||||
<li>protected</li>
|
||||
<li>tagged</li>
|
||||
<li>else</li>
|
||||
<li>loop</li>
|
||||
<li>function</li>
|
||||
<li>record</li>
|
||||
<li>raise</li>
|
||||
<li>rem</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>others</li>
|
||||
<li>all</li>
|
||||
<li>new</li>
|
||||
<li>package</li>
|
||||
<li>in</li>
|
||||
<li>is</li>
|
||||
<li>then</li>
|
||||
<li>pragma</li>
|
||||
<li>accept</li>
|
||||
<li>entry</li>
|
||||
<li>exit</li>
|
||||
<li>at</li>
|
||||
<li>delay</li>
|
||||
<li>task</li>
|
||||
<li>null</li>
|
||||
<li>abort</li>
|
||||
<li>overriding</li>
|
||||
<li>terminate</li>
|
||||
<li>begin</li>
|
||||
<li>some</li>
|
||||
<li>private</li>
|
||||
<li>access</li>
|
||||
<li>for</li>
|
||||
<li>range</li>
|
||||
<li>interface</li>
|
||||
<li>out</li>
|
||||
<li>not</li>
|
||||
<li>goto</li>
|
||||
<li>array</li>
|
||||
<li>subtype</li>
|
||||
<li>and</li>
|
||||
<li>of</li>
|
||||
<li>end</li>
|
||||
<li>xor</li>
|
||||
<li>or</li>
|
||||
<li>limited</li>
|
||||
<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>abort</li>
|
||||
<li>abs</li>
|
||||
<li>abstract</li>
|
||||
<li>procedure</li>
|
||||
<li>reverse</li>
|
||||
<li>accept</li>
|
||||
<li>access</li>
|
||||
<li>aliased</li>
|
||||
<li>all</li>
|
||||
<li>and</li>
|
||||
<li>array</li>
|
||||
<li>at</li>
|
||||
<li>begin</li>
|
||||
<li>body</li>
|
||||
<li>case</li>
|
||||
<li>constant</li>
|
||||
<li>declare</li>
|
||||
<li>delay</li>
|
||||
<li>digits</li>
|
||||
<li>do</li>
|
||||
<li>else</li>
|
||||
<li>elsif</li>
|
||||
<li>end</li>
|
||||
<li>entry</li>
|
||||
<li>exception</li>
|
||||
<li>exit</li>
|
||||
<li>for</li>
|
||||
<li>function</li>
|
||||
<li>generic</li>
|
||||
<li>goto</li>
|
||||
<li>if</li>
|
||||
<li>in</li>
|
||||
<li>interface</li>
|
||||
<li>is</li>
|
||||
<li>limited</li>
|
||||
<li>loop</li>
|
||||
<li>mod</li>
|
||||
<li>new</li>
|
||||
<li>not</li>
|
||||
<li>null</li>
|
||||
<li>of</li>
|
||||
<li>or</li>
|
||||
<li>others</li>
|
||||
<li>out</li>
|
||||
<li>overriding</li>
|
||||
<li>package</li>
|
||||
<li>pragma</li>
|
||||
<li>private</li>
|
||||
<li>procedure</li>
|
||||
<li>protected</li>
|
||||
<li>raise</li>
|
||||
<li>range</li>
|
||||
<li>record</li>
|
||||
<li>rem</li>
|
||||
<li>renames</li>
|
||||
<li>requeue</li>
|
||||
<li>with</li>
|
||||
<li>abs</li>
|
||||
<li>digits</li>
|
||||
<li>until</li>
|
||||
<li>return</li>
|
||||
<li>reverse</li>
|
||||
<li>select</li>
|
||||
<li>separate</li>
|
||||
<li>some</li>
|
||||
<li>subtype</li>
|
||||
<li>synchronized</li>
|
||||
<li>tagged</li>
|
||||
<li>task</li>
|
||||
<li>terminate</li>
|
||||
<li>then</li>
|
||||
<li>type</li>
|
||||
<li>until</li>
|
||||
<li>use</li>
|
||||
<li>when</li>
|
||||
<li>while</li>
|
||||
<li>with</li>
|
||||
<li>xor</li>
|
||||
</ul>
|
||||
|
||||
@ -5,12 +5,12 @@ sidebar_label: ada
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|projectName|GNAT project name| |defaultProject|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
@ -26,88 +26,88 @@ sidebar_label: ada
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>Integer</li>
|
||||
<li>boolean</li>
|
||||
<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>Boolean</li>
|
||||
<li>Character</li>
|
||||
<li>Integer</li>
|
||||
<li>boolean</li>
|
||||
<li>double</li>
|
||||
<li>integer</li>
|
||||
<li>Boolean</li>
|
||||
<li>float</li>
|
||||
<li>integer</li>
|
||||
<li>long</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>exception</li>
|
||||
<li>synchronized</li>
|
||||
<li>constant</li>
|
||||
<li>mod</li>
|
||||
<li>select</li>
|
||||
<li>declare</li>
|
||||
<li>separate</li>
|
||||
<li>use</li>
|
||||
<li>do</li>
|
||||
<li>elsif</li>
|
||||
<li>body</li>
|
||||
<li>type</li>
|
||||
<li>while</li>
|
||||
<li>when</li>
|
||||
<li>aliased</li>
|
||||
<li>protected</li>
|
||||
<li>tagged</li>
|
||||
<li>else</li>
|
||||
<li>loop</li>
|
||||
<li>function</li>
|
||||
<li>record</li>
|
||||
<li>raise</li>
|
||||
<li>rem</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>others</li>
|
||||
<li>all</li>
|
||||
<li>new</li>
|
||||
<li>package</li>
|
||||
<li>in</li>
|
||||
<li>is</li>
|
||||
<li>then</li>
|
||||
<li>pragma</li>
|
||||
<li>accept</li>
|
||||
<li>entry</li>
|
||||
<li>exit</li>
|
||||
<li>at</li>
|
||||
<li>delay</li>
|
||||
<li>task</li>
|
||||
<li>null</li>
|
||||
<li>abort</li>
|
||||
<li>overriding</li>
|
||||
<li>terminate</li>
|
||||
<li>begin</li>
|
||||
<li>some</li>
|
||||
<li>private</li>
|
||||
<li>access</li>
|
||||
<li>for</li>
|
||||
<li>range</li>
|
||||
<li>interface</li>
|
||||
<li>out</li>
|
||||
<li>not</li>
|
||||
<li>goto</li>
|
||||
<li>array</li>
|
||||
<li>subtype</li>
|
||||
<li>and</li>
|
||||
<li>of</li>
|
||||
<li>end</li>
|
||||
<li>xor</li>
|
||||
<li>or</li>
|
||||
<li>limited</li>
|
||||
<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>abort</li>
|
||||
<li>abs</li>
|
||||
<li>abstract</li>
|
||||
<li>procedure</li>
|
||||
<li>reverse</li>
|
||||
<li>accept</li>
|
||||
<li>access</li>
|
||||
<li>aliased</li>
|
||||
<li>all</li>
|
||||
<li>and</li>
|
||||
<li>array</li>
|
||||
<li>at</li>
|
||||
<li>begin</li>
|
||||
<li>body</li>
|
||||
<li>case</li>
|
||||
<li>constant</li>
|
||||
<li>declare</li>
|
||||
<li>delay</li>
|
||||
<li>digits</li>
|
||||
<li>do</li>
|
||||
<li>else</li>
|
||||
<li>elsif</li>
|
||||
<li>end</li>
|
||||
<li>entry</li>
|
||||
<li>exception</li>
|
||||
<li>exit</li>
|
||||
<li>for</li>
|
||||
<li>function</li>
|
||||
<li>generic</li>
|
||||
<li>goto</li>
|
||||
<li>if</li>
|
||||
<li>in</li>
|
||||
<li>interface</li>
|
||||
<li>is</li>
|
||||
<li>limited</li>
|
||||
<li>loop</li>
|
||||
<li>mod</li>
|
||||
<li>new</li>
|
||||
<li>not</li>
|
||||
<li>null</li>
|
||||
<li>of</li>
|
||||
<li>or</li>
|
||||
<li>others</li>
|
||||
<li>out</li>
|
||||
<li>overriding</li>
|
||||
<li>package</li>
|
||||
<li>pragma</li>
|
||||
<li>private</li>
|
||||
<li>procedure</li>
|
||||
<li>protected</li>
|
||||
<li>raise</li>
|
||||
<li>range</li>
|
||||
<li>record</li>
|
||||
<li>rem</li>
|
||||
<li>renames</li>
|
||||
<li>requeue</li>
|
||||
<li>with</li>
|
||||
<li>abs</li>
|
||||
<li>digits</li>
|
||||
<li>until</li>
|
||||
<li>return</li>
|
||||
<li>reverse</li>
|
||||
<li>select</li>
|
||||
<li>separate</li>
|
||||
<li>some</li>
|
||||
<li>subtype</li>
|
||||
<li>synchronized</li>
|
||||
<li>tagged</li>
|
||||
<li>task</li>
|
||||
<li>terminate</li>
|
||||
<li>then</li>
|
||||
<li>type</li>
|
||||
<li>until</li>
|
||||
<li>use</li>
|
||||
<li>when</li>
|
||||
<li>while</li>
|
||||
<li>with</li>
|
||||
<li>xor</li>
|
||||
</ul>
|
||||
|
||||
@ -5,45 +5,45 @@ sidebar_label: android
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|modelPackage|package for generated models| |null|
|
||||
|apiPackage|package for generated api classes| |null|
|
||||
|invokerPackage|root package for generated code| |null|
|
||||
|groupId|groupId for use in the generated build.gradle and pom.xml| |null|
|
||||
|artifactId|artifactId for use in the generated build.gradle and pom.xml| |null|
|
||||
|artifactVersion|artifact version for use in the generated build.gradle and pom.xml| |null|
|
||||
|sourceFolder|source folder for generated code| |null|
|
||||
|useAndroidMavenGradlePlugin|A flag to toggle android-maven gradle plugin.| |true|
|
||||
|androidBuildToolsVersion|buildToolsVersion version for use in the generated build.gradle| |null|
|
||||
|androidGradleVersion|gradleVersion version for use in the generated build.gradle| |null|
|
||||
|androidSdkVersion|compileSdkVersion version for use in the generated build.gradle| |null|
|
||||
|androidBuildToolsVersion|buildToolsVersion version for use in the generated build.gradle| |null|
|
||||
|serializableModel|boolean - toggle "implements Serializable" for generated models| |false|
|
||||
|apiPackage|package for generated api classes| |null|
|
||||
|artifactId|artifactId for use in the generated build.gradle and pom.xml| |null|
|
||||
|artifactVersion|artifact version for use in the generated build.gradle and pom.xml| |null|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|groupId|groupId for use in the generated build.gradle and pom.xml| |null|
|
||||
|invokerPackage|root package for generated code| |null|
|
||||
|library|library template (sub-template) to use|<dl><dt>**volley**</dt><dd>HTTP client: Volley 1.0.19 (default)</dd><dt>**httpclient**</dt><dd>HTTP client: Apache HttpClient 4.3.6. JSON processing: Gson 2.3.1. IMPORTANT: Android client using HttpClient is not actively maintained and will be depecreated in the next major release.</dd><dl>|null|
|
||||
|modelPackage|package for generated models| |null|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|serializableModel|boolean - toggle "implements Serializable" for generated models| |false|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sourceFolder|source folder for generated code| |null|
|
||||
|useAndroidMavenGradlePlugin|A flag to toggle android-maven gradle plugin.| |true|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|Set|java.util.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|HashMap|java.util.HashMap|
|
||||
|Array|java.util.List|
|
||||
|ArrayList|java.util.ArrayList|
|
||||
|URI|java.net.URI|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|BigDecimal|java.math.BigDecimal|
|
||||
|Date|java.util.Date|
|
||||
|DateTime|org.joda.time.*|
|
||||
|Array|java.util.List|
|
||||
|List|java.util.*|
|
||||
|UUID|java.util.UUID|
|
||||
|File|java.io.File|
|
||||
|HashMap|java.util.HashMap|
|
||||
|List|java.util.*|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|Map|java.util.Map|
|
||||
|Set|java.util.*|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|URI|java.net.URI|
|
||||
|UUID|java.util.UUID|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
@ -56,81 +56,81 @@ sidebar_label: android
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>Integer</li>
|
||||
<li>byte[]</li>
|
||||
<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>Boolean</li>
|
||||
<li>Double</li>
|
||||
<li>Float</li>
|
||||
<li>boolean</li>
|
||||
<li>Integer</li>
|
||||
<li>Long</li>
|
||||
<li>Object</li>
|
||||
<li>String</li>
|
||||
<li>Boolean</li>
|
||||
<li>Double</li>
|
||||
<li>boolean</li>
|
||||
<li>byte[]</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>synchronized</li>
|
||||
<li>basepath</li>
|
||||
<li>do</li>
|
||||
<li>float</li>
|
||||
<li>while</li>
|
||||
<li>localvarpath</li>
|
||||
<li>protected</li>
|
||||
<li>continue</li>
|
||||
<li>else</li>
|
||||
<li>localvarqueryparams</li>
|
||||
<li>catch</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>new</li>
|
||||
<li>package</li>
|
||||
<li>static</li>
|
||||
<li>void</li>
|
||||
<li>double</li>
|
||||
<li>byte</li>
|
||||
<li>finally</li>
|
||||
<li>this</li>
|
||||
<li>strictfp</li>
|
||||
<li>throws</li>
|
||||
<li>enum</li>
|
||||
<li>extends</li>
|
||||
<li>null</li>
|
||||
<li>transient</li>
|
||||
<li>final</li>
|
||||
<li>try</li>
|
||||
<li>localvarbuilder</li>
|
||||
<li>object</li>
|
||||
<li>localvarcontenttypes</li>
|
||||
<li>implements</li>
|
||||
<li>private</li>
|
||||
<li>import</li>
|
||||
<li>const</li>
|
||||
<li>for</li>
|
||||
<li>interface</li>
|
||||
<li>long</li>
|
||||
<li>switch</li>
|
||||
<li>default</li>
|
||||
<li>goto</li>
|
||||
<li>public</li>
|
||||
<li>localvarheaderparams</li>
|
||||
<li>native</li>
|
||||
<li>localvarcontenttype</li>
|
||||
<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>abstract</li>
|
||||
<li>apiinvoker</li>
|
||||
<li>assert</li>
|
||||
<li>class</li>
|
||||
<li>localvarformparams</li>
|
||||
<li>break</li>
|
||||
<li>localvarresponse</li>
|
||||
<li>volatile</li>
|
||||
<li>abstract</li>
|
||||
<li>int</li>
|
||||
<li>instanceof</li>
|
||||
<li>super</li>
|
||||
<li>boolean</li>
|
||||
<li>throw</li>
|
||||
<li>localvarpostbody</li>
|
||||
<li>char</li>
|
||||
<li>short</li>
|
||||
<li>authnames</li>
|
||||
<li>basepath</li>
|
||||
<li>boolean</li>
|
||||
<li>break</li>
|
||||
<li>byte</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>char</li>
|
||||
<li>class</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>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>localvarbuilder</li>
|
||||
<li>localvarcontenttype</li>
|
||||
<li>localvarcontenttypes</li>
|
||||
<li>localvarformparams</li>
|
||||
<li>localvarheaderparams</li>
|
||||
<li>localvarpath</li>
|
||||
<li>localvarpostbody</li>
|
||||
<li>localvarqueryparams</li>
|
||||
<li>localvarresponse</li>
|
||||
<li>long</li>
|
||||
<li>native</li>
|
||||
<li>new</li>
|
||||
<li>null</li>
|
||||
<li>object</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>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>
|
||||
|
||||
@ -5,33 +5,33 @@ sidebar_label: apache2
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|userInfoPath|Path to the user and group files| |null|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|Set|java.util.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|HashMap|java.util.HashMap|
|
||||
|Array|java.util.List|
|
||||
|ArrayList|java.util.ArrayList|
|
||||
|URI|java.net.URI|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|BigDecimal|java.math.BigDecimal|
|
||||
|Date|java.util.Date|
|
||||
|DateTime|org.joda.time.*|
|
||||
|Array|java.util.List|
|
||||
|List|java.util.*|
|
||||
|UUID|java.util.UUID|
|
||||
|File|java.io.File|
|
||||
|HashMap|java.util.HashMap|
|
||||
|List|java.util.*|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|Map|java.util.Map|
|
||||
|Set|java.util.*|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|URI|java.net.URI|
|
||||
|UUID|java.util.UUID|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
|
||||
@ -5,15 +5,15 @@ sidebar_label: apex
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|classPrefix|Prefix for generated classes. Set this to avoid overwriting existing classes in your org.| |null|
|
||||
|apiVersion|The Metadata API version number to use for components in this package.| |null|
|
||||
|buildMethod|The build method for this package.| |null|
|
||||
|classPrefix|Prefix for generated classes. Set this to avoid overwriting existing classes in your org.| |null|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|namedCredential|The named credential name for the HTTP callouts| |null|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
@ -32,155 +32,155 @@ sidebar_label: apex
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>Blob</li>
|
||||
<li>Time</li>
|
||||
<li>String</li>
|
||||
<li>Double</li>
|
||||
<li>Boolean</li>
|
||||
<li>Date</li>
|
||||
<li>Integer</li>
|
||||
<li>Datetime</li>
|
||||
<li>Decimal</li>
|
||||
<li>Double</li>
|
||||
<li>ID</li>
|
||||
<li>Integer</li>
|
||||
<li>Long</li>
|
||||
<li>Object</li>
|
||||
<li>ID</li>
|
||||
<li>Boolean</li>
|
||||
<li>Datetime</li>
|
||||
<li>String</li>
|
||||
<li>Time</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>exception</li>
|
||||
<li>select</li>
|
||||
<li>commit</li>
|
||||
<li>type</li>
|
||||
<li>when</li>
|
||||
<li>cast</li>
|
||||
<li>number</li>
|
||||
<li>protected</li>
|
||||
<li>else</li>
|
||||
<li>merge</li>
|
||||
<li>next_90_days</li>
|
||||
<li>catch</li>
|
||||
<li>join</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>using</li>
|
||||
<li>having</li>
|
||||
<li>last_month</li>
|
||||
<li>in</li>
|
||||
<li>byte</li>
|
||||
<li>outer</li>
|
||||
<li>tomorrow</li>
|
||||
<li>upsert</li>
|
||||
<li>then</li>
|
||||
<li>enum</li>
|
||||
<li>exit</li>
|
||||
<li>as</li>
|
||||
<li>system</li>
|
||||
<li>bulk</li>
|
||||
<li>begin</li>
|
||||
<li>object</li>
|
||||
<li>global</li>
|
||||
<li>long</li>
|
||||
<li>next_week</li>
|
||||
<li>into</li>
|
||||
<li>default</li>
|
||||
<li>search</li>
|
||||
<li>goto</li>
|
||||
<li>by</li>
|
||||
<li>currency</li>
|
||||
<li>where</li>
|
||||
<li>override</li>
|
||||
<li>map</li>
|
||||
<li>rollback</li>
|
||||
<li>stat</li>
|
||||
<li>set</li>
|
||||
<li>break</li>
|
||||
<li>last_90_days</li>
|
||||
<li>abstract</li>
|
||||
<li>trigger</li>
|
||||
<li>this_week</li>
|
||||
<li>asc</li>
|
||||
<li>testmethod</li>
|
||||
<li>throw</li>
|
||||
<li>future</li>
|
||||
<li>returning</li>
|
||||
<li>char</li>
|
||||
<li>webservice</li>
|
||||
<li>return</li>
|
||||
<li>transaction</li>
|
||||
<li>date</li>
|
||||
<li>synchronized</li>
|
||||
<li>tolabel</li>
|
||||
<li>nulls</li>
|
||||
<li>next_month</li>
|
||||
<li>autonomous</li>
|
||||
<li>do</li>
|
||||
<li>float</li>
|
||||
<li>while</li>
|
||||
<li>datetime</li>
|
||||
<li>continue</li>
|
||||
<li>loop</li>
|
||||
<li>limit</li>
|
||||
<li>from</li>
|
||||
<li>export</li>
|
||||
<li>group</li>
|
||||
<li>new</li>
|
||||
<li>package</li>
|
||||
<li>static</li>
|
||||
<li>like</li>
|
||||
<li>finally</li>
|
||||
<li>this</li>
|
||||
<li>sort</li>
|
||||
<li>list</li>
|
||||
<li>inner</li>
|
||||
<li>pragma</li>
|
||||
<li>blob</li>
|
||||
<li>this_month</li>
|
||||
<li>convertcurrency</li>
|
||||
<li>extends</li>
|
||||
<li>null</li>
|
||||
<li>hint</li>
|
||||
<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>abstract</li>
|
||||
<li>activate</li>
|
||||
<li>final</li>
|
||||
<li>true</li>
|
||||
<li>retrieve</li>
|
||||
<li>undelete</li>
|
||||
<li>try</li>
|
||||
<li>decimal</li>
|
||||
<li>collect</li>
|
||||
<li>next_n_days</li>
|
||||
<li>desc</li>
|
||||
<li>implements</li>
|
||||
<li>private</li>
|
||||
<li>virtual</li>
|
||||
<li>const</li>
|
||||
<li>import</li>
|
||||
<li>for</li>
|
||||
<li>insert</li>
|
||||
<li>update</li>
|
||||
<li>interface</li>
|
||||
<li>delete</li>
|
||||
<li>switch</li>
|
||||
<li>yesterday</li>
|
||||
<li>not</li>
|
||||
<li>public</li>
|
||||
<li>array</li>
|
||||
<li>parallel</li>
|
||||
<li>savepoint</li>
|
||||
<li>and</li>
|
||||
<li>of</li>
|
||||
<li>today</li>
|
||||
<li>end</li>
|
||||
<li>any</li>
|
||||
<li>array</li>
|
||||
<li>as</li>
|
||||
<li>asc</li>
|
||||
<li>autonomous</li>
|
||||
<li>begin</li>
|
||||
<li>bigdecimal</li>
|
||||
<li>blob</li>
|
||||
<li>break</li>
|
||||
<li>bulk</li>
|
||||
<li>by</li>
|
||||
<li>byte</li>
|
||||
<li>case</li>
|
||||
<li>cast</li>
|
||||
<li>catch</li>
|
||||
<li>char</li>
|
||||
<li>class</li>
|
||||
<li>collect</li>
|
||||
<li>commit</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>convertcurrency</li>
|
||||
<li>currency</li>
|
||||
<li>date</li>
|
||||
<li>datetime</li>
|
||||
<li>decimal</li>
|
||||
<li>default</li>
|
||||
<li>delete</li>
|
||||
<li>desc</li>
|
||||
<li>do</li>
|
||||
<li>else</li>
|
||||
<li>end</li>
|
||||
<li>enum</li>
|
||||
<li>exception</li>
|
||||
<li>exit</li>
|
||||
<li>export</li>
|
||||
<li>extends</li>
|
||||
<li>false</li>
|
||||
<li>final</li>
|
||||
<li>finally</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>from</li>
|
||||
<li>future</li>
|
||||
<li>global</li>
|
||||
<li>goto</li>
|
||||
<li>group</li>
|
||||
<li>having</li>
|
||||
<li>hint</li>
|
||||
<li>if</li>
|
||||
<li>implements</li>
|
||||
<li>import</li>
|
||||
<li>in</li>
|
||||
<li>inner</li>
|
||||
<li>insert</li>
|
||||
<li>instanceof</li>
|
||||
<li>int</li>
|
||||
<li>interface</li>
|
||||
<li>into</li>
|
||||
<li>join</li>
|
||||
<li>last_90_days</li>
|
||||
<li>last_month</li>
|
||||
<li>last_n_days</li>
|
||||
<li>last_week</li>
|
||||
<li>like</li>
|
||||
<li>limit</li>
|
||||
<li>list</li>
|
||||
<li>long</li>
|
||||
<li>loop</li>
|
||||
<li>map</li>
|
||||
<li>merge</li>
|
||||
<li>new</li>
|
||||
<li>next_90_days</li>
|
||||
<li>next_month</li>
|
||||
<li>next_n_days</li>
|
||||
<li>next_week</li>
|
||||
<li>not</li>
|
||||
<li>null</li>
|
||||
<li>nulls</li>
|
||||
<li>number</li>
|
||||
<li>object</li>
|
||||
<li>of</li>
|
||||
<li>on</li>
|
||||
<li>or</li>
|
||||
<li>bigdecimal</li>
|
||||
<li>false</li>
|
||||
<li>any</li>
|
||||
<li>int</li>
|
||||
<li>instanceof</li>
|
||||
<li>super</li>
|
||||
<li>last_n_days</li>
|
||||
<li>outer</li>
|
||||
<li>override</li>
|
||||
<li>package</li>
|
||||
<li>parallel</li>
|
||||
<li>pragma</li>
|
||||
<li>private</li>
|
||||
<li>protected</li>
|
||||
<li>public</li>
|
||||
<li>retrieve</li>
|
||||
<li>return</li>
|
||||
<li>returning</li>
|
||||
<li>rollback</li>
|
||||
<li>savepoint</li>
|
||||
<li>search</li>
|
||||
<li>select</li>
|
||||
<li>set</li>
|
||||
<li>short</li>
|
||||
<li>sort</li>
|
||||
<li>stat</li>
|
||||
<li>static</li>
|
||||
<li>super</li>
|
||||
<li>switch</li>
|
||||
<li>synchronized</li>
|
||||
<li>system</li>
|
||||
<li>testmethod</li>
|
||||
<li>then</li>
|
||||
<li>this</li>
|
||||
<li>this_month</li>
|
||||
<li>this_week</li>
|
||||
<li>throw</li>
|
||||
<li>time</li>
|
||||
<li>last_week</li>
|
||||
<li>today</li>
|
||||
<li>tolabel</li>
|
||||
<li>tomorrow</li>
|
||||
<li>transaction</li>
|
||||
<li>trigger</li>
|
||||
<li>true</li>
|
||||
<li>try</li>
|
||||
<li>type</li>
|
||||
<li>undelete</li>
|
||||
<li>update</li>
|
||||
<li>upsert</li>
|
||||
<li>using</li>
|
||||
<li>virtual</li>
|
||||
<li>webservice</li>
|
||||
<li>when</li>
|
||||
<li>where</li>
|
||||
<li>while</li>
|
||||
<li>yesterday</li>
|
||||
</ul>
|
||||
|
||||
@ -5,24 +5,24 @@ sidebar_label: asciidoc
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|appName|short name of the application| |null|
|
||||
|appDescription|description of the application| |null|
|
||||
|infoUrl|a URL where users can get more information about the application| |null|
|
||||
|infoEmail|an email address to contact for inquiries about the application| |null|
|
||||
|licenseInfo|a short description of the license| |null|
|
||||
|licenseUrl|a URL pointing to the full license| |null|
|
||||
|invokerPackage|root package for generated code| |null|
|
||||
|groupId|groupId in generated pom.xml| |null|
|
||||
|appName|short name of the application| |null|
|
||||
|artifactId|artifactId in generated pom.xml. This also becomes part of the generated library's filename| |null|
|
||||
|artifactVersion|artifact version in generated pom.xml. This also becomes part of the generated library's filename| |null|
|
||||
|snippetDir|path with includable markup snippets (e.g. test output generated by restdoc, default: .)| |.|
|
||||
|specDir|path with includable markup spec files (e.g. handwritten additional docs, default: ..)| |..|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|groupId|groupId in generated pom.xml| |null|
|
||||
|headerAttributes|generation of asciidoc header meta data attributes (set to false to suppress, default: true)| |true|
|
||||
|infoEmail|an email address to contact for inquiries about the application| |null|
|
||||
|infoUrl|a URL where users can get more information about the application| |null|
|
||||
|invokerPackage|root package for generated code| |null|
|
||||
|licenseInfo|a short description of the license| |null|
|
||||
|licenseUrl|a URL pointing to the full license| |null|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|snippetDir|path with includable markup snippets (e.g. test output generated by restdoc, default: .)| |.|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|specDir|path with includable markup spec files (e.g. handwritten additional docs, default: ..)| |..|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
|
||||
@ -5,37 +5,37 @@ sidebar_label: aspnetcore
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|licenseUrl|The URL of the license| |http://localhost|
|
||||
|licenseName|The name of the license| |NoLicense|
|
||||
|packageCopyright|Specifies an AssemblyCopyright for the .NET Framework global assembly attributes stored in the AssemblyInfo file.| |No Copyright|
|
||||
|packageAuthors|Specifies Authors property in the .NET Core project file.| |OpenAPI|
|
||||
|packageTitle|Specifies an AssemblyTitle for the .NET Framework global assembly attributes stored in the AssemblyInfo file.| |OpenAPI Library|
|
||||
|packageName|C# package name (convention: Title.Case).| |Org.OpenAPITools|
|
||||
|packageVersion|C# package version.| |1.0.0|
|
||||
|packageGuid|The GUID that will be associated with the C# project| |null|
|
||||
|sourceFolder|source folder for generated code| |src|
|
||||
|compatibilityVersion|ASP.Net Core CompatibilityVersion| |Version_2_2|
|
||||
|aspnetCoreVersion|ASP.NET Core version: 3.0 (preview4 only), 2.2, 2.1, 2.0 (deprecated)| |2.2|
|
||||
|swashbuckleVersion|Swashbucke version: 3.0.0, 4.0.0| |3.0.0|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|useDateTimeOffset|Use DateTimeOffset to model date-time properties| |false|
|
||||
|useCollection|Deserialize array types to Collection<T> instead of List<T>.| |false|
|
||||
|returnICollection|Return ICollection<T> instead of the concrete type.| |false|
|
||||
|useSwashbuckle|Uses the Swashbuckle.AspNetCore NuGet package for documentation.| |true|
|
||||
|isLibrary|Is the build a library| |false|
|
||||
|useFrameworkReference|Use frameworkReference for ASP.NET Core 3.0+ and PackageReference ASP.NET Core 2.2 or earlier.| |false|
|
||||
|useNewtonsoft|Uses the Newtonsoft JSON library.| |true|
|
||||
|newtonsoftVersion|Version for Microsoft.AspNetCore.Mvc.NewtonsoftJson for ASP.NET Core 3.0+| |3.0.0-preview5-19227-01|
|
||||
|useDefaultRouting|Use default routing for the ASP.NET Core version. For 3.0 turn off default because it is not yet supported.| |true|
|
||||
|buildTarget|Target to build an application or library| |program|
|
||||
|classModifier|Class Modifier can be empty, abstract| ||
|
||||
|compatibilityVersion|ASP.Net Core CompatibilityVersion| |Version_2_2|
|
||||
|enumNameSuffix|Suffix that will be appended to all enum names.| |Enum|
|
||||
|enumValueSuffix|Suffix that will be appended to all enum values.| |Enum|
|
||||
|classModifier|Class Modifier can be empty, abstract| ||
|
||||
|operationModifier|Operation Modifier can be virtual, abstract or partial| |virtual|
|
||||
|buildTarget|Target to build an application or library| |program|
|
||||
|generateBody|Generates method body.| |true|
|
||||
|operationIsAsync|Set methods to async or sync (default).| |false|
|
||||
|operationResultTask|Set methods result to Task<>.| |false|
|
||||
|isLibrary|Is the build a library| |false|
|
||||
|licenseName|The name of the license| |NoLicense|
|
||||
|licenseUrl|The URL of the license| |http://localhost|
|
||||
|modelClassModifier|Model Class Modifier can be nothing or partial| |partial|
|
||||
|newtonsoftVersion|Version for Microsoft.AspNetCore.Mvc.NewtonsoftJson for ASP.NET Core 3.0+| |3.0.0-preview5-19227-01|
|
||||
|operationIsAsync|Set methods to async or sync (default).| |false|
|
||||
|operationModifier|Operation Modifier can be virtual, abstract or partial| |virtual|
|
||||
|operationResultTask|Set methods result to Task<>.| |false|
|
||||
|packageAuthors|Specifies Authors property in the .NET Core project file.| |OpenAPI|
|
||||
|packageCopyright|Specifies an AssemblyCopyright for the .NET Framework global assembly attributes stored in the AssemblyInfo file.| |No Copyright|
|
||||
|packageGuid|The GUID that will be associated with the C# project| |null|
|
||||
|packageName|C# package name (convention: Title.Case).| |Org.OpenAPITools|
|
||||
|packageTitle|Specifies an AssemblyTitle for the .NET Framework global assembly attributes stored in the AssemblyInfo file.| |OpenAPI Library|
|
||||
|packageVersion|C# package version.| |1.0.0|
|
||||
|returnICollection|Return ICollection<T> instead of the concrete type.| |false|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sourceFolder|source folder for generated code| |src|
|
||||
|swashbuckleVersion|Swashbucke version: 3.0.0, 4.0.0| |3.0.0|
|
||||
|useCollection|Deserialize array types to Collection<T> instead of List<T>.| |false|
|
||||
|useDateTimeOffset|Use DateTimeOffset to model date-time properties| |false|
|
||||
|useDefaultRouting|Use default routing for the ASP.NET Core version. For 3.0 turn off default because it is not yet supported.| |true|
|
||||
|useFrameworkReference|Use frameworkReference for ASP.NET Core 3.0+ and PackageReference ASP.NET Core 2.2 or earlier.| |false|
|
||||
|useNewtonsoft|Uses the Newtonsoft JSON library.| |true|
|
||||
|useSwashbuckle|Uses the Swashbuckle.AspNetCore NuGet package for documentation.| |true|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
@ -54,138 +54,138 @@ sidebar_label: aspnetcore
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>int?</li>
|
||||
<li>Dictionary</li>
|
||||
<li>string</li>
|
||||
<li>bool</li>
|
||||
<li>DateTimeOffset?</li>
|
||||
<li>String</li>
|
||||
<li>Guid</li>
|
||||
<li>System.IO.Stream</li>
|
||||
<li>bool?</li>
|
||||
<li>float</li>
|
||||
<li>long</li>
|
||||
<li>DateTime</li>
|
||||
<li>Int32</li>
|
||||
<li>float?</li>
|
||||
<li>DateTime?</li>
|
||||
<li>List</li>
|
||||
<li>Boolean</li>
|
||||
<li>long?</li>
|
||||
<li>double</li>
|
||||
<li>Guid?</li>
|
||||
<li>DateTimeOffset</li>
|
||||
<li>Double</li>
|
||||
<li>int</li>
|
||||
<li>byte[]</li>
|
||||
<li>Float</li>
|
||||
<li>Int64</li>
|
||||
<li>double?</li>
|
||||
<li>ICollection</li>
|
||||
<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>Boolean</li>
|
||||
<li>Collection</li>
|
||||
<li>DateTime</li>
|
||||
<li>DateTime?</li>
|
||||
<li>DateTimeOffset</li>
|
||||
<li>DateTimeOffset?</li>
|
||||
<li>Dictionary</li>
|
||||
<li>Double</li>
|
||||
<li>Float</li>
|
||||
<li>Guid</li>
|
||||
<li>Guid?</li>
|
||||
<li>ICollection</li>
|
||||
<li>Int32</li>
|
||||
<li>Int64</li>
|
||||
<li>List</li>
|
||||
<li>Object</li>
|
||||
<li>decimal?</li>
|
||||
<li>String</li>
|
||||
<li>System.IO.Stream</li>
|
||||
<li>bool</li>
|
||||
<li>bool?</li>
|
||||
<li>byte[]</li>
|
||||
<li>decimal</li>
|
||||
<li>decimal?</li>
|
||||
<li>double</li>
|
||||
<li>double?</li>
|
||||
<li>float</li>
|
||||
<li>float?</li>
|
||||
<li>int</li>
|
||||
<li>int?</li>
|
||||
<li>long</li>
|
||||
<li>long?</li>
|
||||
<li>string</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>struct</li>
|
||||
<li>ushort</li>
|
||||
<li>localVarQueryParams</li>
|
||||
<li>protected</li>
|
||||
<li>readonly</li>
|
||||
<li>else</li>
|
||||
<li>lock</li>
|
||||
<li>localVarPathParams</li>
|
||||
<li>catch</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>localVarHttpHeaderAccepts</li>
|
||||
<li>using</li>
|
||||
<li>localVarPostBody</li>
|
||||
<li>in</li>
|
||||
<li>byte</li>
|
||||
<li>double</li>
|
||||
<li>var</li>
|
||||
<li>is</li>
|
||||
<li>params</li>
|
||||
<li>enum</li>
|
||||
<li>explicit</li>
|
||||
<li>as</li>
|
||||
<li>object</li>
|
||||
<li>implicit</li>
|
||||
<li>internal</li>
|
||||
<li>localVarHttpHeaderAccept</li>
|
||||
<li>unsafe</li>
|
||||
<li>long</li>
|
||||
<li>out</li>
|
||||
<li>delegate</li>
|
||||
<li>default</li>
|
||||
<li>goto</li>
|
||||
<li>localVarHttpContentTypes</li>
|
||||
<li>localVarHttpContentType</li>
|
||||
<li>yield</li>
|
||||
<li>override</li>
|
||||
<li>event</li>
|
||||
<li>typeof</li>
|
||||
<li>break</li>
|
||||
<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>Client</li>
|
||||
<li>abstract</li>
|
||||
<li>uint</li>
|
||||
<li>throw</li>
|
||||
<li>char</li>
|
||||
<li>sbyte</li>
|
||||
<li>localVarFileParams</li>
|
||||
<li>return</li>
|
||||
<li>extern</li>
|
||||
<li>do</li>
|
||||
<li>float</li>
|
||||
<li>while</li>
|
||||
<li>operator</li>
|
||||
<li>ref</li>
|
||||
<li>continue</li>
|
||||
<li>checked</li>
|
||||
<li>dynamic</li>
|
||||
<li>Client</li>
|
||||
<li>new</li>
|
||||
<li>static</li>
|
||||
<li>void</li>
|
||||
<li>sizeof</li>
|
||||
<li>localVarResponse</li>
|
||||
<li>sealed</li>
|
||||
<li>finally</li>
|
||||
<li>this</li>
|
||||
<li>unchecked</li>
|
||||
<li>null</li>
|
||||
<li>localVarPath</li>
|
||||
<li>true</li>
|
||||
<li>fixed</li>
|
||||
<li>try</li>
|
||||
<li>decimal</li>
|
||||
<li>private</li>
|
||||
<li>virtual</li>
|
||||
<li>bool</li>
|
||||
<li>const</li>
|
||||
<li>string</li>
|
||||
<li>for</li>
|
||||
<li>interface</li>
|
||||
<li>switch</li>
|
||||
<li>foreach</li>
|
||||
<li>ulong</li>
|
||||
<li>public</li>
|
||||
<li>localVarStatusCode</li>
|
||||
<li>stackalloc</li>
|
||||
<li>parameter</li>
|
||||
<li>await</li>
|
||||
<li>client</li>
|
||||
<li>class</li>
|
||||
<li>localVarFormParams</li>
|
||||
<li>false</li>
|
||||
<li>volatile</li>
|
||||
<li>int</li>
|
||||
<li>as</li>
|
||||
<li>async</li>
|
||||
<li>localVarHeaderParams</li>
|
||||
<li>namespace</li>
|
||||
<li>short</li>
|
||||
<li>await</li>
|
||||
<li>base</li>
|
||||
<li>bool</li>
|
||||
<li>break</li>
|
||||
<li>byte</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>char</li>
|
||||
<li>checked</li>
|
||||
<li>class</li>
|
||||
<li>client</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>decimal</li>
|
||||
<li>default</li>
|
||||
<li>delegate</li>
|
||||
<li>do</li>
|
||||
<li>double</li>
|
||||
<li>dynamic</li>
|
||||
<li>else</li>
|
||||
<li>enum</li>
|
||||
<li>event</li>
|
||||
<li>explicit</li>
|
||||
<li>extern</li>
|
||||
<li>false</li>
|
||||
<li>finally</li>
|
||||
<li>fixed</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>foreach</li>
|
||||
<li>goto</li>
|
||||
<li>if</li>
|
||||
<li>implicit</li>
|
||||
<li>in</li>
|
||||
<li>int</li>
|
||||
<li>interface</li>
|
||||
<li>internal</li>
|
||||
<li>is</li>
|
||||
<li>localVarFileParams</li>
|
||||
<li>localVarFormParams</li>
|
||||
<li>localVarHeaderParams</li>
|
||||
<li>localVarHttpContentType</li>
|
||||
<li>localVarHttpContentTypes</li>
|
||||
<li>localVarHttpHeaderAccept</li>
|
||||
<li>localVarHttpHeaderAccepts</li>
|
||||
<li>localVarPath</li>
|
||||
<li>localVarPathParams</li>
|
||||
<li>localVarPostBody</li>
|
||||
<li>localVarQueryParams</li>
|
||||
<li>localVarResponse</li>
|
||||
<li>localVarStatusCode</li>
|
||||
<li>lock</li>
|
||||
<li>long</li>
|
||||
<li>namespace</li>
|
||||
<li>new</li>
|
||||
<li>null</li>
|
||||
<li>object</li>
|
||||
<li>operator</li>
|
||||
<li>out</li>
|
||||
<li>override</li>
|
||||
<li>parameter</li>
|
||||
<li>params</li>
|
||||
<li>private</li>
|
||||
<li>protected</li>
|
||||
<li>public</li>
|
||||
<li>readonly</li>
|
||||
<li>ref</li>
|
||||
<li>return</li>
|
||||
<li>sbyte</li>
|
||||
<li>sealed</li>
|
||||
<li>short</li>
|
||||
<li>sizeof</li>
|
||||
<li>stackalloc</li>
|
||||
<li>static</li>
|
||||
<li>string</li>
|
||||
<li>struct</li>
|
||||
<li>switch</li>
|
||||
<li>this</li>
|
||||
<li>throw</li>
|
||||
<li>true</li>
|
||||
<li>try</li>
|
||||
<li>typeof</li>
|
||||
<li>uint</li>
|
||||
<li>ulong</li>
|
||||
<li>unchecked</li>
|
||||
<li>unsafe</li>
|
||||
<li>ushort</li>
|
||||
<li>using</li>
|
||||
<li>var</li>
|
||||
<li>virtual</li>
|
||||
<li>void</li>
|
||||
<li>volatile</li>
|
||||
<li>while</li>
|
||||
<li>yield</li>
|
||||
</ul>
|
||||
|
||||
@ -5,12 +5,12 @@ sidebar_label: avro-schema
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|packageName|package for generated classes (where supported)| |null|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
@ -29,20 +29,20 @@ sidebar_label: avro-schema
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>date</li>
|
||||
<li>string</li>
|
||||
<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>BigDecimal</li>
|
||||
<li>DateTime</li>
|
||||
<li>UUID</li>
|
||||
<li>boolean</li>
|
||||
<li>bytes</li>
|
||||
<li>date</li>
|
||||
<li>double</li>
|
||||
<li>integer</li>
|
||||
<li>float</li>
|
||||
<li>int</li>
|
||||
<li>integer</li>
|
||||
<li>long</li>
|
||||
<li>BigDecimal</li>
|
||||
<li>DateTime</li>
|
||||
<li>number</li>
|
||||
<li>boolean</li>
|
||||
<li>null</li>
|
||||
<li>bytes</li>
|
||||
<li>UUID</li>
|
||||
<li>number</li>
|
||||
<li>string</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
@ -5,40 +5,40 @@ sidebar_label: bash
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|apiKeyAuthEnvironmentVariable|Name of environment variable where API key can be defined (e.g. PETSTORE_APIKEY='kjhasdGASDa5asdASD')| |false|
|
||||
|basicAuthEnvironmentVariable|Name of environment variable where username and password can be defined (e.g. PETSTORE_CREDS='username:password')| |null|
|
||||
|curlOptions|Default cURL options| |null|
|
||||
|processMarkdown|Convert all Markdown Markup into terminal formatting| |false|
|
||||
|scriptName|The name of the script that will be generated (e.g. petstore-cli)| |null|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|generateBashCompletion|Whether to generate the Bash completion script| |false|
|
||||
|generateZshCompletion|Whether to generate the Zsh completion script| |false|
|
||||
|hostEnvironmentVariable|Name of environment variable where host can be defined (e.g. PETSTORE_HOST='http://api.openapitools.org:8080')| |null|
|
||||
|basicAuthEnvironmentVariable|Name of environment variable where username and password can be defined (e.g. PETSTORE_CREDS='username:password')| |null|
|
||||
|apiKeyAuthEnvironmentVariable|Name of environment variable where API key can be defined (e.g. PETSTORE_APIKEY='kjhasdGASDa5asdASD')| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|processMarkdown|Convert all Markdown Markup into terminal formatting| |false|
|
||||
|scriptName|The name of the script that will be generated (e.g. petstore-cli)| |null|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|Set|java.util.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|HashMap|java.util.HashMap|
|
||||
|Array|java.util.List|
|
||||
|ArrayList|java.util.ArrayList|
|
||||
|URI|java.net.URI|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|BigDecimal|java.math.BigDecimal|
|
||||
|Date|java.util.Date|
|
||||
|DateTime|org.joda.time.*|
|
||||
|Array|java.util.List|
|
||||
|List|java.util.*|
|
||||
|UUID|java.util.UUID|
|
||||
|File|java.io.File|
|
||||
|HashMap|java.util.HashMap|
|
||||
|List|java.util.*|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|Map|java.util.Map|
|
||||
|Set|java.util.*|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|URI|java.net.URI|
|
||||
|UUID|java.util.UUID|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
@ -49,31 +49,31 @@ sidebar_label: bash
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>boolean</li>
|
||||
<li>string</li>
|
||||
<li>array</li>
|
||||
<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>array</li>
|
||||
<li>binary</li>
|
||||
<li>integer</li>
|
||||
<li>boolean</li>
|
||||
<li>float</li>
|
||||
<li>integer</li>
|
||||
<li>map</li>
|
||||
<li>string</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>fi</li>
|
||||
<li>select</li>
|
||||
<li>in</li>
|
||||
<li>for</li>
|
||||
<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>case</li>
|
||||
<li>do</li>
|
||||
<li>elif</li>
|
||||
<li>then</li>
|
||||
<li>while</li>
|
||||
<li>done</li>
|
||||
<li>elif</li>
|
||||
<li>else</li>
|
||||
<li>function</li>
|
||||
<li>until</li>
|
||||
<li>time</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>esac</li>
|
||||
<li>fi</li>
|
||||
<li>for</li>
|
||||
<li>function</li>
|
||||
<li>if</li>
|
||||
<li>in</li>
|
||||
<li>select</li>
|
||||
<li>then</li>
|
||||
<li>time</li>
|
||||
<li>until</li>
|
||||
<li>while</li>
|
||||
</ul>
|
||||
|
||||
@ -5,12 +5,12 @@ sidebar_label: c
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
@ -26,63 +26,63 @@ sidebar_label: c
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>binary_t*</li>
|
||||
<li>double</li>
|
||||
<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>Object</li>
|
||||
<li>binary_t*</li>
|
||||
<li>char</li>
|
||||
<li>short</li>
|
||||
<li>Object</li>
|
||||
<li>double</li>
|
||||
<li>float</li>
|
||||
<li>list</li>
|
||||
<li>int</li>
|
||||
<li>long</li>
|
||||
<li>list</li>
|
||||
<li>list_t*</li>
|
||||
<li>long</li>
|
||||
<li>short</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>struct</li>
|
||||
<li>auto</li>
|
||||
<li>const</li>
|
||||
<li>_static_assert</li>
|
||||
<li>_atomic</li>
|
||||
<li>_complex</li>
|
||||
<li>for</li>
|
||||
<li>extern</li>
|
||||
<li>do</li>
|
||||
<li>float</li>
|
||||
<li>restrict</li>
|
||||
<li>while</li>
|
||||
<li>long</li>
|
||||
<li>remove</li>
|
||||
<li>switch</li>
|
||||
<li>_generic</li>
|
||||
<li>default</li>
|
||||
<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>_alignas</li>
|
||||
<li>_alignof</li>
|
||||
<li>goto</li>
|
||||
<li>continue</li>
|
||||
<li>else</li>
|
||||
<li>_noreturn</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>_atomic</li>
|
||||
<li>_bool</li>
|
||||
<li>static</li>
|
||||
<li>void</li>
|
||||
<li>break</li>
|
||||
<li>sizeof</li>
|
||||
<li>double</li>
|
||||
<li>signed</li>
|
||||
<li>volatile</li>
|
||||
<li>union</li>
|
||||
<li>_thread_local</li>
|
||||
<li>typedef</li>
|
||||
<li>enum</li>
|
||||
<li>int</li>
|
||||
<li>inline</li>
|
||||
<li>_alignas</li>
|
||||
<li>_complex</li>
|
||||
<li>_generic</li>
|
||||
<li>_imaginary</li>
|
||||
<li>_noreturn</li>
|
||||
<li>_static_assert</li>
|
||||
<li>_thread_local</li>
|
||||
<li>auto</li>
|
||||
<li>break</li>
|
||||
<li>case</li>
|
||||
<li>char</li>
|
||||
<li>short</li>
|
||||
<li>unsigned</li>
|
||||
<li>return</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>default</li>
|
||||
<li>do</li>
|
||||
<li>double</li>
|
||||
<li>else</li>
|
||||
<li>enum</li>
|
||||
<li>extern</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>goto</li>
|
||||
<li>if</li>
|
||||
<li>inline</li>
|
||||
<li>int</li>
|
||||
<li>long</li>
|
||||
<li>register</li>
|
||||
<li>remove</li>
|
||||
<li>restrict</li>
|
||||
<li>return</li>
|
||||
<li>short</li>
|
||||
<li>signed</li>
|
||||
<li>sizeof</li>
|
||||
<li>static</li>
|
||||
<li>struct</li>
|
||||
<li>switch</li>
|
||||
<li>typedef</li>
|
||||
<li>union</li>
|
||||
<li>unsigned</li>
|
||||
<li>void</li>
|
||||
<li>volatile</li>
|
||||
<li>while</li>
|
||||
</ul>
|
||||
|
||||
@ -5,39 +5,39 @@ sidebar_label: clojure
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|baseNamespace|the base/top namespace (Default: generated from projectName)| |null|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|projectName|name of the project (Default: generated from info.title or "openapi-clj-client")| |null|
|
||||
|projectDescription|description of the project (Default: using info.description or "Client library of <projectName>")| |null|
|
||||
|projectVersion|version of the project (Default: using info.version or "1.0.0")| |null|
|
||||
|projectUrl|URL of the project (Default: using info.contact.url or not included in project.clj)| |null|
|
||||
|projectLicenseName|name of the license the project uses (Default: using info.license.name or not included in project.clj)| |null|
|
||||
|projectLicenseUrl|URL of the license the project uses (Default: using info.license.url or not included in project.clj)| |null|
|
||||
|baseNamespace|the base/top namespace (Default: generated from projectName)| |null|
|
||||
|projectName|name of the project (Default: generated from info.title or "openapi-clj-client")| |null|
|
||||
|projectUrl|URL of the project (Default: using info.contact.url or not included in project.clj)| |null|
|
||||
|projectVersion|version of the project (Default: using info.version or "1.0.0")| |null|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|Set|java.util.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|HashMap|java.util.HashMap|
|
||||
|Array|java.util.List|
|
||||
|ArrayList|java.util.ArrayList|
|
||||
|URI|java.net.URI|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|BigDecimal|java.math.BigDecimal|
|
||||
|Date|java.util.Date|
|
||||
|DateTime|org.joda.time.*|
|
||||
|Array|java.util.List|
|
||||
|List|java.util.*|
|
||||
|UUID|java.util.UUID|
|
||||
|File|java.io.File|
|
||||
|HashMap|java.util.HashMap|
|
||||
|List|java.util.*|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|Map|java.util.Map|
|
||||
|Set|java.util.*|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|URI|java.net.URI|
|
||||
|UUID|java.util.UUID|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
|
||||
@ -13,10 +13,10 @@ sidebar_label: cpp-pistache-server
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|std::vector|#include <vector>|
|
||||
|Object|#include "Object.h"|
|
||||
|std::map|#include <map>|
|
||||
|std::string|#include <string>|
|
||||
|Object|#include "Object.h"|
|
||||
|std::vector|#include <vector>|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
@ -28,13 +28,13 @@ sidebar_label: cpp-pistache-server
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>bool</li>
|
||||
<li>double</li>
|
||||
<li>char</li>
|
||||
<li>double</li>
|
||||
<li>float</li>
|
||||
<li>int64_t</li>
|
||||
<li>int</li>
|
||||
<li>long</li>
|
||||
<li>int32_t</li>
|
||||
<li>int64_t</li>
|
||||
<li>long</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
@ -5,14 +5,14 @@ sidebar_label: cpp-qt5-client
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|cppNamespace|C++ namespace (convention: name::space::for::api).| |OpenAPI|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|modelNamePrefix|Prefix that will be prepended to all model names.| |OAI|
|
||||
|optionalProjectFile|Generate client.pri.| |true|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
@ -29,104 +29,104 @@ sidebar_label: cpp-qt5-client
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>QDateTime</li>
|
||||
<li>QString</li>
|
||||
<li>qint64</li>
|
||||
<li>qint32</li>
|
||||
<li>bool</li>
|
||||
<li>QByteArray</li>
|
||||
<li>double</li>
|
||||
<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>QByteArray</li>
|
||||
<li>QDate</li>
|
||||
<li>QDateTime</li>
|
||||
<li>QString</li>
|
||||
<li>bool</li>
|
||||
<li>double</li>
|
||||
<li>float</li>
|
||||
<li>qint32</li>
|
||||
<li>qint64</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>struct</li>
|
||||
<li>auto</li>
|
||||
<li>xor_eq</li>
|
||||
<li>const_cast</li>
|
||||
<li>decltype</li>
|
||||
<li>alignas</li>
|
||||
<li>extern</li>
|
||||
<li>do</li>
|
||||
<li>float</li>
|
||||
<li>while</li>
|
||||
<li>constexpr</li>
|
||||
<li>operator</li>
|
||||
<li>bitand</li>
|
||||
<li>protected</li>
|
||||
<li>continue</li>
|
||||
<li>else</li>
|
||||
<li>friend</li>
|
||||
<li>mutable</li>
|
||||
<li>compl</li>
|
||||
<li>typeid</li>
|
||||
<li>catch</li>
|
||||
<li>export</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>dynamic_cast</li>
|
||||
<li>not_eq</li>
|
||||
<li>new</li>
|
||||
<li>using</li>
|
||||
<li>static</li>
|
||||
<li>void</li>
|
||||
<li>sizeof</li>
|
||||
<li>bitor</li>
|
||||
<li>double</li>
|
||||
<li>this</li>
|
||||
<li>signed</li>
|
||||
<li>noexcept</li>
|
||||
<li>typedef</li>
|
||||
<li>enum</li>
|
||||
<li>char16_t</li>
|
||||
<li>explicit</li>
|
||||
<li>static_cast</li>
|
||||
<li>true</li>
|
||||
<li>try</li>
|
||||
<li>reinterpret_cast</li>
|
||||
<li>nullptr</li>
|
||||
<li>requires</li>
|
||||
<li>template</li>
|
||||
<li>private</li>
|
||||
<li>virtual</li>
|
||||
<li>bool</li>
|
||||
<li>const</li>
|
||||
<li>concept</li>
|
||||
<li>static_assert</li>
|
||||
<li>for</li>
|
||||
<li>delete</li>
|
||||
<li>long</li>
|
||||
<li>switch</li>
|
||||
<li>default</li>
|
||||
<li>not</li>
|
||||
<li>goto</li>
|
||||
<li>public</li>
|
||||
<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>alignas</li>
|
||||
<li>alignof</li>
|
||||
<li>and</li>
|
||||
<li>and_eq</li>
|
||||
<li>linux</li>
|
||||
<li>or_eq</li>
|
||||
<li>xor</li>
|
||||
<li>class</li>
|
||||
<li>wchar_t</li>
|
||||
<li>alignof</li>
|
||||
<li>or</li>
|
||||
<li>break</li>
|
||||
<li>false</li>
|
||||
<li>thread_local</li>
|
||||
<li>char32_t</li>
|
||||
<li>volatile</li>
|
||||
<li>union</li>
|
||||
<li>int</li>
|
||||
<li>inline</li>
|
||||
<li>throw</li>
|
||||
<li>char</li>
|
||||
<li>namespace</li>
|
||||
<li>short</li>
|
||||
<li>unsigned</li>
|
||||
<li>asm</li>
|
||||
<li>return</li>
|
||||
<li>typename</li>
|
||||
<li>auto</li>
|
||||
<li>bitand</li>
|
||||
<li>bitor</li>
|
||||
<li>bool</li>
|
||||
<li>break</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>char</li>
|
||||
<li>char16_t</li>
|
||||
<li>char32_t</li>
|
||||
<li>class</li>
|
||||
<li>compl</li>
|
||||
<li>concept</li>
|
||||
<li>const</li>
|
||||
<li>const_cast</li>
|
||||
<li>constexpr</li>
|
||||
<li>continue</li>
|
||||
<li>decltype</li>
|
||||
<li>default</li>
|
||||
<li>delete</li>
|
||||
<li>do</li>
|
||||
<li>double</li>
|
||||
<li>dynamic_cast</li>
|
||||
<li>else</li>
|
||||
<li>enum</li>
|
||||
<li>explicit</li>
|
||||
<li>export</li>
|
||||
<li>extern</li>
|
||||
<li>false</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>friend</li>
|
||||
<li>goto</li>
|
||||
<li>if</li>
|
||||
<li>inline</li>
|
||||
<li>int</li>
|
||||
<li>linux</li>
|
||||
<li>long</li>
|
||||
<li>mutable</li>
|
||||
<li>namespace</li>
|
||||
<li>new</li>
|
||||
<li>noexcept</li>
|
||||
<li>not</li>
|
||||
<li>not_eq</li>
|
||||
<li>nullptr</li>
|
||||
<li>operator</li>
|
||||
<li>or</li>
|
||||
<li>or_eq</li>
|
||||
<li>private</li>
|
||||
<li>protected</li>
|
||||
<li>public</li>
|
||||
<li>register</li>
|
||||
<li>reinterpret_cast</li>
|
||||
<li>requires</li>
|
||||
<li>return</li>
|
||||
<li>short</li>
|
||||
<li>signed</li>
|
||||
<li>sizeof</li>
|
||||
<li>static</li>
|
||||
<li>static_assert</li>
|
||||
<li>static_cast</li>
|
||||
<li>struct</li>
|
||||
<li>switch</li>
|
||||
<li>template</li>
|
||||
<li>this</li>
|
||||
<li>thread_local</li>
|
||||
<li>throw</li>
|
||||
<li>true</li>
|
||||
<li>try</li>
|
||||
<li>typedef</li>
|
||||
<li>typeid</li>
|
||||
<li>typename</li>
|
||||
<li>union</li>
|
||||
<li>unsigned</li>
|
||||
<li>using</li>
|
||||
<li>virtual</li>
|
||||
<li>void</li>
|
||||
<li>volatile</li>
|
||||
<li>wchar_t</li>
|
||||
<li>while</li>
|
||||
<li>xor</li>
|
||||
<li>xor_eq</li>
|
||||
</ul>
|
||||
|
||||
@ -5,13 +5,13 @@ sidebar_label: cpp-qt5-qhttpengine-server
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|cppNamespace|C++ namespace (convention: name::space::for::api).| |OpenAPI|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|modelNamePrefix|Prefix that will be prepended to all model names.| |OAI|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
@ -28,104 +28,104 @@ sidebar_label: cpp-qt5-qhttpengine-server
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>QDateTime</li>
|
||||
<li>QString</li>
|
||||
<li>qint64</li>
|
||||
<li>qint32</li>
|
||||
<li>bool</li>
|
||||
<li>QByteArray</li>
|
||||
<li>double</li>
|
||||
<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>QByteArray</li>
|
||||
<li>QDate</li>
|
||||
<li>QDateTime</li>
|
||||
<li>QString</li>
|
||||
<li>bool</li>
|
||||
<li>double</li>
|
||||
<li>float</li>
|
||||
<li>qint32</li>
|
||||
<li>qint64</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>struct</li>
|
||||
<li>auto</li>
|
||||
<li>xor_eq</li>
|
||||
<li>const_cast</li>
|
||||
<li>decltype</li>
|
||||
<li>alignas</li>
|
||||
<li>extern</li>
|
||||
<li>do</li>
|
||||
<li>float</li>
|
||||
<li>while</li>
|
||||
<li>constexpr</li>
|
||||
<li>operator</li>
|
||||
<li>bitand</li>
|
||||
<li>protected</li>
|
||||
<li>continue</li>
|
||||
<li>else</li>
|
||||
<li>friend</li>
|
||||
<li>mutable</li>
|
||||
<li>compl</li>
|
||||
<li>typeid</li>
|
||||
<li>catch</li>
|
||||
<li>export</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>dynamic_cast</li>
|
||||
<li>not_eq</li>
|
||||
<li>new</li>
|
||||
<li>using</li>
|
||||
<li>static</li>
|
||||
<li>void</li>
|
||||
<li>sizeof</li>
|
||||
<li>bitor</li>
|
||||
<li>double</li>
|
||||
<li>this</li>
|
||||
<li>signed</li>
|
||||
<li>noexcept</li>
|
||||
<li>typedef</li>
|
||||
<li>enum</li>
|
||||
<li>char16_t</li>
|
||||
<li>explicit</li>
|
||||
<li>static_cast</li>
|
||||
<li>true</li>
|
||||
<li>try</li>
|
||||
<li>reinterpret_cast</li>
|
||||
<li>nullptr</li>
|
||||
<li>requires</li>
|
||||
<li>template</li>
|
||||
<li>private</li>
|
||||
<li>virtual</li>
|
||||
<li>bool</li>
|
||||
<li>const</li>
|
||||
<li>concept</li>
|
||||
<li>static_assert</li>
|
||||
<li>for</li>
|
||||
<li>delete</li>
|
||||
<li>long</li>
|
||||
<li>switch</li>
|
||||
<li>default</li>
|
||||
<li>not</li>
|
||||
<li>goto</li>
|
||||
<li>public</li>
|
||||
<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>alignas</li>
|
||||
<li>alignof</li>
|
||||
<li>and</li>
|
||||
<li>and_eq</li>
|
||||
<li>linux</li>
|
||||
<li>or_eq</li>
|
||||
<li>xor</li>
|
||||
<li>class</li>
|
||||
<li>wchar_t</li>
|
||||
<li>alignof</li>
|
||||
<li>or</li>
|
||||
<li>break</li>
|
||||
<li>false</li>
|
||||
<li>thread_local</li>
|
||||
<li>char32_t</li>
|
||||
<li>volatile</li>
|
||||
<li>union</li>
|
||||
<li>int</li>
|
||||
<li>inline</li>
|
||||
<li>throw</li>
|
||||
<li>char</li>
|
||||
<li>namespace</li>
|
||||
<li>short</li>
|
||||
<li>unsigned</li>
|
||||
<li>asm</li>
|
||||
<li>return</li>
|
||||
<li>typename</li>
|
||||
<li>auto</li>
|
||||
<li>bitand</li>
|
||||
<li>bitor</li>
|
||||
<li>bool</li>
|
||||
<li>break</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>char</li>
|
||||
<li>char16_t</li>
|
||||
<li>char32_t</li>
|
||||
<li>class</li>
|
||||
<li>compl</li>
|
||||
<li>concept</li>
|
||||
<li>const</li>
|
||||
<li>const_cast</li>
|
||||
<li>constexpr</li>
|
||||
<li>continue</li>
|
||||
<li>decltype</li>
|
||||
<li>default</li>
|
||||
<li>delete</li>
|
||||
<li>do</li>
|
||||
<li>double</li>
|
||||
<li>dynamic_cast</li>
|
||||
<li>else</li>
|
||||
<li>enum</li>
|
||||
<li>explicit</li>
|
||||
<li>export</li>
|
||||
<li>extern</li>
|
||||
<li>false</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>friend</li>
|
||||
<li>goto</li>
|
||||
<li>if</li>
|
||||
<li>inline</li>
|
||||
<li>int</li>
|
||||
<li>linux</li>
|
||||
<li>long</li>
|
||||
<li>mutable</li>
|
||||
<li>namespace</li>
|
||||
<li>new</li>
|
||||
<li>noexcept</li>
|
||||
<li>not</li>
|
||||
<li>not_eq</li>
|
||||
<li>nullptr</li>
|
||||
<li>operator</li>
|
||||
<li>or</li>
|
||||
<li>or_eq</li>
|
||||
<li>private</li>
|
||||
<li>protected</li>
|
||||
<li>public</li>
|
||||
<li>register</li>
|
||||
<li>reinterpret_cast</li>
|
||||
<li>requires</li>
|
||||
<li>return</li>
|
||||
<li>short</li>
|
||||
<li>signed</li>
|
||||
<li>sizeof</li>
|
||||
<li>static</li>
|
||||
<li>static_assert</li>
|
||||
<li>static_cast</li>
|
||||
<li>struct</li>
|
||||
<li>switch</li>
|
||||
<li>template</li>
|
||||
<li>this</li>
|
||||
<li>thread_local</li>
|
||||
<li>throw</li>
|
||||
<li>true</li>
|
||||
<li>try</li>
|
||||
<li>typedef</li>
|
||||
<li>typeid</li>
|
||||
<li>typename</li>
|
||||
<li>union</li>
|
||||
<li>unsigned</li>
|
||||
<li>using</li>
|
||||
<li>virtual</li>
|
||||
<li>void</li>
|
||||
<li>volatile</li>
|
||||
<li>wchar_t</li>
|
||||
<li>while</li>
|
||||
<li>xor</li>
|
||||
<li>xor_eq</li>
|
||||
</ul>
|
||||
|
||||
@ -5,21 +5,21 @@ sidebar_label: cpp-restbed-server
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|modelPackage|C++ namespace for models (convention: name.space.model).| |org.openapitools.server.model|
|
||||
|apiPackage|C++ namespace for apis (convention: name.space.api).| |org.openapitools.server.api|
|
||||
|packageVersion|C++ package version.| |1.0.0|
|
||||
|declspec|C++ preprocessor to place before the class name for handling dllexport/dllimport.| ||
|
||||
|defaultInclude|The default include statement that should be placed in all headers for including things like the declspec (convention: #include "Commons.h" | ||
|
||||
|modelPackage|C++ namespace for models (convention: name.space.model).| |org.openapitools.server.model|
|
||||
|packageVersion|C++ package version.| |1.0.0|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|std::vector|#include <vector>|
|
||||
|std::map|#include <map>|
|
||||
|std::string|#include <string>|
|
||||
|Object|#include "Object.h"|
|
||||
|restbed::Bytes|#include <corvusoft/restbed/byte.hpp>|
|
||||
|std::map|#include <map>|
|
||||
|std::string|#include <string>|
|
||||
|std::vector|#include <vector>|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
@ -31,102 +31,102 @@ sidebar_label: cpp-restbed-server
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>bool</li>
|
||||
<li>double</li>
|
||||
<li>char</li>
|
||||
<li>double</li>
|
||||
<li>float</li>
|
||||
<li>int64_t</li>
|
||||
<li>int</li>
|
||||
<li>long</li>
|
||||
<li>int32_t</li>
|
||||
<li>int64_t</li>
|
||||
<li>long</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>struct</li>
|
||||
<li>auto</li>
|
||||
<li>xor_eq</li>
|
||||
<li>const_cast</li>
|
||||
<li>decltype</li>
|
||||
<li>alignas</li>
|
||||
<li>extern</li>
|
||||
<li>do</li>
|
||||
<li>float</li>
|
||||
<li>while</li>
|
||||
<li>constexpr</li>
|
||||
<li>operator</li>
|
||||
<li>bitand</li>
|
||||
<li>protected</li>
|
||||
<li>continue</li>
|
||||
<li>else</li>
|
||||
<li>friend</li>
|
||||
<li>mutable</li>
|
||||
<li>compl</li>
|
||||
<li>typeid</li>
|
||||
<li>catch</li>
|
||||
<li>export</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>dynamic_cast</li>
|
||||
<li>not_eq</li>
|
||||
<li>new</li>
|
||||
<li>using</li>
|
||||
<li>static</li>
|
||||
<li>void</li>
|
||||
<li>sizeof</li>
|
||||
<li>bitor</li>
|
||||
<li>double</li>
|
||||
<li>this</li>
|
||||
<li>signed</li>
|
||||
<li>noexcept</li>
|
||||
<li>typedef</li>
|
||||
<li>enum</li>
|
||||
<li>char16_t</li>
|
||||
<li>explicit</li>
|
||||
<li>static_cast</li>
|
||||
<li>true</li>
|
||||
<li>try</li>
|
||||
<li>reinterpret_cast</li>
|
||||
<li>nullptr</li>
|
||||
<li>requires</li>
|
||||
<li>template</li>
|
||||
<li>private</li>
|
||||
<li>virtual</li>
|
||||
<li>bool</li>
|
||||
<li>const</li>
|
||||
<li>concept</li>
|
||||
<li>static_assert</li>
|
||||
<li>for</li>
|
||||
<li>delete</li>
|
||||
<li>long</li>
|
||||
<li>switch</li>
|
||||
<li>default</li>
|
||||
<li>not</li>
|
||||
<li>goto</li>
|
||||
<li>public</li>
|
||||
<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>alignas</li>
|
||||
<li>alignof</li>
|
||||
<li>and</li>
|
||||
<li>and_eq</li>
|
||||
<li>linux</li>
|
||||
<li>or_eq</li>
|
||||
<li>xor</li>
|
||||
<li>class</li>
|
||||
<li>wchar_t</li>
|
||||
<li>alignof</li>
|
||||
<li>or</li>
|
||||
<li>break</li>
|
||||
<li>false</li>
|
||||
<li>thread_local</li>
|
||||
<li>char32_t</li>
|
||||
<li>volatile</li>
|
||||
<li>union</li>
|
||||
<li>int</li>
|
||||
<li>inline</li>
|
||||
<li>throw</li>
|
||||
<li>char</li>
|
||||
<li>namespace</li>
|
||||
<li>short</li>
|
||||
<li>unsigned</li>
|
||||
<li>asm</li>
|
||||
<li>return</li>
|
||||
<li>typename</li>
|
||||
<li>auto</li>
|
||||
<li>bitand</li>
|
||||
<li>bitor</li>
|
||||
<li>bool</li>
|
||||
<li>break</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>char</li>
|
||||
<li>char16_t</li>
|
||||
<li>char32_t</li>
|
||||
<li>class</li>
|
||||
<li>compl</li>
|
||||
<li>concept</li>
|
||||
<li>const</li>
|
||||
<li>const_cast</li>
|
||||
<li>constexpr</li>
|
||||
<li>continue</li>
|
||||
<li>decltype</li>
|
||||
<li>default</li>
|
||||
<li>delete</li>
|
||||
<li>do</li>
|
||||
<li>double</li>
|
||||
<li>dynamic_cast</li>
|
||||
<li>else</li>
|
||||
<li>enum</li>
|
||||
<li>explicit</li>
|
||||
<li>export</li>
|
||||
<li>extern</li>
|
||||
<li>false</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>friend</li>
|
||||
<li>goto</li>
|
||||
<li>if</li>
|
||||
<li>inline</li>
|
||||
<li>int</li>
|
||||
<li>linux</li>
|
||||
<li>long</li>
|
||||
<li>mutable</li>
|
||||
<li>namespace</li>
|
||||
<li>new</li>
|
||||
<li>noexcept</li>
|
||||
<li>not</li>
|
||||
<li>not_eq</li>
|
||||
<li>nullptr</li>
|
||||
<li>operator</li>
|
||||
<li>or</li>
|
||||
<li>or_eq</li>
|
||||
<li>private</li>
|
||||
<li>protected</li>
|
||||
<li>public</li>
|
||||
<li>register</li>
|
||||
<li>reinterpret_cast</li>
|
||||
<li>requires</li>
|
||||
<li>return</li>
|
||||
<li>short</li>
|
||||
<li>signed</li>
|
||||
<li>sizeof</li>
|
||||
<li>static</li>
|
||||
<li>static_assert</li>
|
||||
<li>static_cast</li>
|
||||
<li>struct</li>
|
||||
<li>switch</li>
|
||||
<li>template</li>
|
||||
<li>this</li>
|
||||
<li>thread_local</li>
|
||||
<li>throw</li>
|
||||
<li>true</li>
|
||||
<li>try</li>
|
||||
<li>typedef</li>
|
||||
<li>typeid</li>
|
||||
<li>typename</li>
|
||||
<li>union</li>
|
||||
<li>unsigned</li>
|
||||
<li>using</li>
|
||||
<li>virtual</li>
|
||||
<li>void</li>
|
||||
<li>volatile</li>
|
||||
<li>wchar_t</li>
|
||||
<li>while</li>
|
||||
<li>xor</li>
|
||||
<li>xor_eq</li>
|
||||
</ul>
|
||||
|
||||
@ -5,24 +5,24 @@ sidebar_label: cpp-restsdk
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|modelPackage|C++ namespace for models (convention: name.space.model).| |org.openapitools.client.model|
|
||||
|apiPackage|C++ namespace for apis (convention: name.space.api).| |org.openapitools.client.api|
|
||||
|packageVersion|C++ package version.| |1.0.0|
|
||||
|declspec|C++ preprocessor to place before the class name for handling dllexport/dllimport.| ||
|
||||
|defaultInclude|The default include statement that should be placed in all headers for including things like the declspec (convention: #include "Commons.h" | ||
|
||||
|generateGMocksForApis|Generate Google Mock classes for APIs.| |null|
|
||||
|modelPackage|C++ namespace for models (convention: name.space.model).| |org.openapitools.client.model|
|
||||
|packageVersion|C++ package version.| |1.0.0|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|std::vector|#include <vector>|
|
||||
|utility::string_t|#include <cpprest/details/basic_types.h>|
|
||||
|HttpContent|#include "HttpContent.h"|
|
||||
|Object|#include "Object.h"|
|
||||
|std::map|#include <map>|
|
||||
|std::string|#include <string>|
|
||||
|std::vector|#include <vector>|
|
||||
|utility::datetime|#include <cpprest/details/basic_types.h>|
|
||||
|Object|#include "Object.h"|
|
||||
|HttpContent|#include "HttpContent.h"|
|
||||
|utility::string_t|#include <cpprest/details/basic_types.h>|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
@ -34,102 +34,102 @@ sidebar_label: cpp-restsdk
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>bool</li>
|
||||
<li>double</li>
|
||||
<li>char</li>
|
||||
<li>double</li>
|
||||
<li>float</li>
|
||||
<li>int64_t</li>
|
||||
<li>int</li>
|
||||
<li>long</li>
|
||||
<li>int32_t</li>
|
||||
<li>int64_t</li>
|
||||
<li>long</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>struct</li>
|
||||
<li>auto</li>
|
||||
<li>xor_eq</li>
|
||||
<li>const_cast</li>
|
||||
<li>decltype</li>
|
||||
<li>alignas</li>
|
||||
<li>extern</li>
|
||||
<li>do</li>
|
||||
<li>float</li>
|
||||
<li>while</li>
|
||||
<li>constexpr</li>
|
||||
<li>operator</li>
|
||||
<li>bitand</li>
|
||||
<li>protected</li>
|
||||
<li>continue</li>
|
||||
<li>else</li>
|
||||
<li>friend</li>
|
||||
<li>mutable</li>
|
||||
<li>compl</li>
|
||||
<li>typeid</li>
|
||||
<li>catch</li>
|
||||
<li>export</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>dynamic_cast</li>
|
||||
<li>not_eq</li>
|
||||
<li>new</li>
|
||||
<li>using</li>
|
||||
<li>static</li>
|
||||
<li>void</li>
|
||||
<li>sizeof</li>
|
||||
<li>bitor</li>
|
||||
<li>double</li>
|
||||
<li>this</li>
|
||||
<li>signed</li>
|
||||
<li>noexcept</li>
|
||||
<li>typedef</li>
|
||||
<li>enum</li>
|
||||
<li>char16_t</li>
|
||||
<li>explicit</li>
|
||||
<li>static_cast</li>
|
||||
<li>true</li>
|
||||
<li>try</li>
|
||||
<li>reinterpret_cast</li>
|
||||
<li>nullptr</li>
|
||||
<li>requires</li>
|
||||
<li>template</li>
|
||||
<li>private</li>
|
||||
<li>virtual</li>
|
||||
<li>bool</li>
|
||||
<li>const</li>
|
||||
<li>concept</li>
|
||||
<li>static_assert</li>
|
||||
<li>for</li>
|
||||
<li>delete</li>
|
||||
<li>long</li>
|
||||
<li>switch</li>
|
||||
<li>default</li>
|
||||
<li>not</li>
|
||||
<li>goto</li>
|
||||
<li>public</li>
|
||||
<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>alignas</li>
|
||||
<li>alignof</li>
|
||||
<li>and</li>
|
||||
<li>and_eq</li>
|
||||
<li>linux</li>
|
||||
<li>or_eq</li>
|
||||
<li>xor</li>
|
||||
<li>class</li>
|
||||
<li>wchar_t</li>
|
||||
<li>alignof</li>
|
||||
<li>or</li>
|
||||
<li>break</li>
|
||||
<li>false</li>
|
||||
<li>thread_local</li>
|
||||
<li>char32_t</li>
|
||||
<li>volatile</li>
|
||||
<li>union</li>
|
||||
<li>int</li>
|
||||
<li>inline</li>
|
||||
<li>throw</li>
|
||||
<li>char</li>
|
||||
<li>namespace</li>
|
||||
<li>short</li>
|
||||
<li>unsigned</li>
|
||||
<li>asm</li>
|
||||
<li>return</li>
|
||||
<li>typename</li>
|
||||
<li>auto</li>
|
||||
<li>bitand</li>
|
||||
<li>bitor</li>
|
||||
<li>bool</li>
|
||||
<li>break</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>char</li>
|
||||
<li>char16_t</li>
|
||||
<li>char32_t</li>
|
||||
<li>class</li>
|
||||
<li>compl</li>
|
||||
<li>concept</li>
|
||||
<li>const</li>
|
||||
<li>const_cast</li>
|
||||
<li>constexpr</li>
|
||||
<li>continue</li>
|
||||
<li>decltype</li>
|
||||
<li>default</li>
|
||||
<li>delete</li>
|
||||
<li>do</li>
|
||||
<li>double</li>
|
||||
<li>dynamic_cast</li>
|
||||
<li>else</li>
|
||||
<li>enum</li>
|
||||
<li>explicit</li>
|
||||
<li>export</li>
|
||||
<li>extern</li>
|
||||
<li>false</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>friend</li>
|
||||
<li>goto</li>
|
||||
<li>if</li>
|
||||
<li>inline</li>
|
||||
<li>int</li>
|
||||
<li>linux</li>
|
||||
<li>long</li>
|
||||
<li>mutable</li>
|
||||
<li>namespace</li>
|
||||
<li>new</li>
|
||||
<li>noexcept</li>
|
||||
<li>not</li>
|
||||
<li>not_eq</li>
|
||||
<li>nullptr</li>
|
||||
<li>operator</li>
|
||||
<li>or</li>
|
||||
<li>or_eq</li>
|
||||
<li>private</li>
|
||||
<li>protected</li>
|
||||
<li>public</li>
|
||||
<li>register</li>
|
||||
<li>reinterpret_cast</li>
|
||||
<li>requires</li>
|
||||
<li>return</li>
|
||||
<li>short</li>
|
||||
<li>signed</li>
|
||||
<li>sizeof</li>
|
||||
<li>static</li>
|
||||
<li>static_assert</li>
|
||||
<li>static_cast</li>
|
||||
<li>struct</li>
|
||||
<li>switch</li>
|
||||
<li>template</li>
|
||||
<li>this</li>
|
||||
<li>thread_local</li>
|
||||
<li>throw</li>
|
||||
<li>true</li>
|
||||
<li>try</li>
|
||||
<li>typedef</li>
|
||||
<li>typeid</li>
|
||||
<li>typename</li>
|
||||
<li>union</li>
|
||||
<li>unsigned</li>
|
||||
<li>using</li>
|
||||
<li>virtual</li>
|
||||
<li>void</li>
|
||||
<li>volatile</li>
|
||||
<li>wchar_t</li>
|
||||
<li>while</li>
|
||||
<li>xor</li>
|
||||
<li>xor_eq</li>
|
||||
</ul>
|
||||
|
||||
@ -5,11 +5,11 @@ sidebar_label: cpp-tizen
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
@ -26,105 +26,105 @@ sidebar_label: cpp-tizen
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>bool</li>
|
||||
<li>std::string</li>
|
||||
<li>double</li>
|
||||
<li>long long</li>
|
||||
<li>float</li>
|
||||
<li>int</li>
|
||||
<li>long long</li>
|
||||
<li>std::string</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>struct</li>
|
||||
<li>synchronized</li>
|
||||
<li>auto</li>
|
||||
<li>xor_eq</li>
|
||||
<li>const_cast</li>
|
||||
<li>decltype</li>
|
||||
<li>alignas</li>
|
||||
<li>extern</li>
|
||||
<li>do</li>
|
||||
<li>float</li>
|
||||
<li>while</li>
|
||||
<li>constexpr</li>
|
||||
<li>operator</li>
|
||||
<li>bitand</li>
|
||||
<li>protected</li>
|
||||
<li>continue</li>
|
||||
<li>else</li>
|
||||
<li>friend</li>
|
||||
<li>mutable</li>
|
||||
<li>compl</li>
|
||||
<li>typeid</li>
|
||||
<li>catch</li>
|
||||
<li>export</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>dynamic_cast</li>
|
||||
<li>not_eq</li>
|
||||
<li>new</li>
|
||||
<li>using</li>
|
||||
<li>atomic_commit</li>
|
||||
<li>static</li>
|
||||
<li>void</li>
|
||||
<li>sizeof</li>
|
||||
<li>bitor</li>
|
||||
<li>double</li>
|
||||
<li>module</li>
|
||||
<li>this</li>
|
||||
<li>signed</li>
|
||||
<li>atomic_cancel</li>
|
||||
<li>noexcept</li>
|
||||
<li>typedef</li>
|
||||
<li>enum</li>
|
||||
<li>char16_t</li>
|
||||
<li>explicit</li>
|
||||
<li>static_cast</li>
|
||||
<li>true</li>
|
||||
<li>try</li>
|
||||
<li>reinterpret_cast</li>
|
||||
<li>nullptr</li>
|
||||
<li>requires</li>
|
||||
<li>template</li>
|
||||
<li>private</li>
|
||||
<li>virtual</li>
|
||||
<li>bool</li>
|
||||
<li>const</li>
|
||||
<li>import</li>
|
||||
<li>concept</li>
|
||||
<li>static_assert</li>
|
||||
<li>for</li>
|
||||
<li>atomic_noexcept</li>
|
||||
<li>delete</li>
|
||||
<li>long</li>
|
||||
<li>switch</li>
|
||||
<li>default</li>
|
||||
<li>not</li>
|
||||
<li>goto</li>
|
||||
<li>public</li>
|
||||
<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>alignas</li>
|
||||
<li>alignof</li>
|
||||
<li>and</li>
|
||||
<li>and_eq</li>
|
||||
<li>or_eq</li>
|
||||
<li>xor</li>
|
||||
<li>class</li>
|
||||
<li>wchar_t</li>
|
||||
<li>alignof</li>
|
||||
<li>or</li>
|
||||
<li>break</li>
|
||||
<li>false</li>
|
||||
<li>thread_local</li>
|
||||
<li>char32_t</li>
|
||||
<li>volatile</li>
|
||||
<li>union</li>
|
||||
<li>int</li>
|
||||
<li>inline</li>
|
||||
<li>throw</li>
|
||||
<li>char</li>
|
||||
<li>namespace</li>
|
||||
<li>short</li>
|
||||
<li>unsigned</li>
|
||||
<li>asm</li>
|
||||
<li>return</li>
|
||||
<li>typename</li>
|
||||
<li>atomic_cancel</li>
|
||||
<li>atomic_commit</li>
|
||||
<li>atomic_noexcept</li>
|
||||
<li>auto</li>
|
||||
<li>bitand</li>
|
||||
<li>bitor</li>
|
||||
<li>bool</li>
|
||||
<li>break</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>char</li>
|
||||
<li>char16_t</li>
|
||||
<li>char32_t</li>
|
||||
<li>class</li>
|
||||
<li>compl</li>
|
||||
<li>concept</li>
|
||||
<li>const</li>
|
||||
<li>const_cast</li>
|
||||
<li>constexpr</li>
|
||||
<li>continue</li>
|
||||
<li>decltype</li>
|
||||
<li>default</li>
|
||||
<li>delete</li>
|
||||
<li>do</li>
|
||||
<li>double</li>
|
||||
<li>dynamic_cast</li>
|
||||
<li>else</li>
|
||||
<li>enum</li>
|
||||
<li>explicit</li>
|
||||
<li>export</li>
|
||||
<li>extern</li>
|
||||
<li>false</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>friend</li>
|
||||
<li>goto</li>
|
||||
<li>if</li>
|
||||
<li>import</li>
|
||||
<li>inline</li>
|
||||
<li>int</li>
|
||||
<li>long</li>
|
||||
<li>module</li>
|
||||
<li>mutable</li>
|
||||
<li>namespace</li>
|
||||
<li>new</li>
|
||||
<li>noexcept</li>
|
||||
<li>not</li>
|
||||
<li>not_eq</li>
|
||||
<li>nullptr</li>
|
||||
<li>operator</li>
|
||||
<li>or</li>
|
||||
<li>or_eq</li>
|
||||
<li>private</li>
|
||||
<li>protected</li>
|
||||
<li>public</li>
|
||||
<li>register</li>
|
||||
<li>reinterpret_cast</li>
|
||||
<li>requires</li>
|
||||
<li>return</li>
|
||||
<li>short</li>
|
||||
<li>signed</li>
|
||||
<li>sizeof</li>
|
||||
<li>static</li>
|
||||
<li>static_assert</li>
|
||||
<li>static_cast</li>
|
||||
<li>struct</li>
|
||||
<li>switch</li>
|
||||
<li>synchronized</li>
|
||||
<li>template</li>
|
||||
<li>this</li>
|
||||
<li>thread_local</li>
|
||||
<li>throw</li>
|
||||
<li>true</li>
|
||||
<li>try</li>
|
||||
<li>typedef</li>
|
||||
<li>typeid</li>
|
||||
<li>typename</li>
|
||||
<li>union</li>
|
||||
<li>unsigned</li>
|
||||
<li>using</li>
|
||||
<li>virtual</li>
|
||||
<li>void</li>
|
||||
<li>volatile</li>
|
||||
<li>wchar_t</li>
|
||||
<li>while</li>
|
||||
<li>xor</li>
|
||||
<li>xor_eq</li>
|
||||
</ul>
|
||||
|
||||
@ -5,9 +5,9 @@ sidebar_label: csharp-dotnet2
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|clientPackage|C# client package name (convention: Camel.Case).| |Org.OpenAPITools.Client|
|
||||
|packageName|C# package name (convention: Camel.Case).| |Org.OpenAPITools|
|
||||
|packageVersion|C# package version.| |1.0.0|
|
||||
|clientPackage|C# client package name (convention: Camel.Case).| |Org.OpenAPITools.Client|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
@ -26,133 +26,133 @@ sidebar_label: csharp-dotnet2
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>int?</li>
|
||||
<li>Dictionary</li>
|
||||
<li>string</li>
|
||||
<li>bool</li>
|
||||
<li>DateTimeOffset?</li>
|
||||
<li>String</li>
|
||||
<li>Guid</li>
|
||||
<li>System.IO.Stream</li>
|
||||
<li>bool?</li>
|
||||
<li>float</li>
|
||||
<li>long</li>
|
||||
<li>DateTime</li>
|
||||
<li>Int32</li>
|
||||
<li>float?</li>
|
||||
<li>DateTime?</li>
|
||||
<li>List</li>
|
||||
<li>Boolean</li>
|
||||
<li>long?</li>
|
||||
<li>double</li>
|
||||
<li>Guid?</li>
|
||||
<li>DateTimeOffset</li>
|
||||
<li>Double</li>
|
||||
<li>int</li>
|
||||
<li>byte[]</li>
|
||||
<li>Float</li>
|
||||
<li>Int64</li>
|
||||
<li>double?</li>
|
||||
<li>ICollection</li>
|
||||
<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>Boolean</li>
|
||||
<li>Collection</li>
|
||||
<li>DateTime</li>
|
||||
<li>DateTime?</li>
|
||||
<li>DateTimeOffset</li>
|
||||
<li>DateTimeOffset?</li>
|
||||
<li>Dictionary</li>
|
||||
<li>Double</li>
|
||||
<li>Float</li>
|
||||
<li>Guid</li>
|
||||
<li>Guid?</li>
|
||||
<li>ICollection</li>
|
||||
<li>Int32</li>
|
||||
<li>Int64</li>
|
||||
<li>List</li>
|
||||
<li>Object</li>
|
||||
<li>decimal?</li>
|
||||
<li>String</li>
|
||||
<li>System.IO.Stream</li>
|
||||
<li>bool</li>
|
||||
<li>bool?</li>
|
||||
<li>byte[]</li>
|
||||
<li>decimal</li>
|
||||
<li>decimal?</li>
|
||||
<li>double</li>
|
||||
<li>double?</li>
|
||||
<li>float</li>
|
||||
<li>float?</li>
|
||||
<li>int</li>
|
||||
<li>int?</li>
|
||||
<li>long</li>
|
||||
<li>long?</li>
|
||||
<li>string</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>struct</li>
|
||||
<li>extern</li>
|
||||
<li>do</li>
|
||||
<li>ushort</li>
|
||||
<li>float</li>
|
||||
<li>while</li>
|
||||
<li>operator</li>
|
||||
<li>localVarQueryParams</li>
|
||||
<li>ref</li>
|
||||
<li>protected</li>
|
||||
<li>readonly</li>
|
||||
<li>continue</li>
|
||||
<li>else</li>
|
||||
<li>checked</li>
|
||||
<li>lock</li>
|
||||
<li>localVarPathParams</li>
|
||||
<li>catch</li>
|
||||
<li>Client</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>localVarHttpHeaderAccepts</li>
|
||||
<li>new</li>
|
||||
<li>using</li>
|
||||
<li>static</li>
|
||||
<li>void</li>
|
||||
<li>localVarPostBody</li>
|
||||
<li>in</li>
|
||||
<li>sizeof</li>
|
||||
<li>localVarResponse</li>
|
||||
<li>byte</li>
|
||||
<li>double</li>
|
||||
<li>sealed</li>
|
||||
<li>finally</li>
|
||||
<li>this</li>
|
||||
<li>unchecked</li>
|
||||
<li>is</li>
|
||||
<li>params</li>
|
||||
<li>enum</li>
|
||||
<li>explicit</li>
|
||||
<li>as</li>
|
||||
<li>null</li>
|
||||
<li>localVarPath</li>
|
||||
<li>true</li>
|
||||
<li>fixed</li>
|
||||
<li>try</li>
|
||||
<li>decimal</li>
|
||||
<li>object</li>
|
||||
<li>implicit</li>
|
||||
<li>internal</li>
|
||||
<li>private</li>
|
||||
<li>virtual</li>
|
||||
<li>bool</li>
|
||||
<li>const</li>
|
||||
<li>string</li>
|
||||
<li>for</li>
|
||||
<li>localVarHttpHeaderAccept</li>
|
||||
<li>interface</li>
|
||||
<li>unsafe</li>
|
||||
<li>long</li>
|
||||
<li>out</li>
|
||||
<li>switch</li>
|
||||
<li>delegate</li>
|
||||
<li>foreach</li>
|
||||
<li>default</li>
|
||||
<li>ulong</li>
|
||||
<li>goto</li>
|
||||
<li>localVarHttpContentTypes</li>
|
||||
<li>localVarHttpContentType</li>
|
||||
<li>public</li>
|
||||
<li>localVarStatusCode</li>
|
||||
<li>stackalloc</li>
|
||||
<li>parameter</li>
|
||||
<li>client</li>
|
||||
<li>override</li>
|
||||
<li>event</li>
|
||||
<li>class</li>
|
||||
<li>typeof</li>
|
||||
<li>localVarFormParams</li>
|
||||
<li>break</li>
|
||||
<li>false</li>
|
||||
<li>volatile</li>
|
||||
<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>Client</li>
|
||||
<li>abstract</li>
|
||||
<li>uint</li>
|
||||
<li>int</li>
|
||||
<li>localVarHeaderParams</li>
|
||||
<li>throw</li>
|
||||
<li>char</li>
|
||||
<li>namespace</li>
|
||||
<li>sbyte</li>
|
||||
<li>short</li>
|
||||
<li>localVarFileParams</li>
|
||||
<li>return</li>
|
||||
<li>as</li>
|
||||
<li>base</li>
|
||||
<li>bool</li>
|
||||
<li>break</li>
|
||||
<li>byte</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>char</li>
|
||||
<li>checked</li>
|
||||
<li>class</li>
|
||||
<li>client</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>decimal</li>
|
||||
<li>default</li>
|
||||
<li>delegate</li>
|
||||
<li>do</li>
|
||||
<li>double</li>
|
||||
<li>else</li>
|
||||
<li>enum</li>
|
||||
<li>event</li>
|
||||
<li>explicit</li>
|
||||
<li>extern</li>
|
||||
<li>false</li>
|
||||
<li>finally</li>
|
||||
<li>fixed</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>foreach</li>
|
||||
<li>goto</li>
|
||||
<li>if</li>
|
||||
<li>implicit</li>
|
||||
<li>in</li>
|
||||
<li>int</li>
|
||||
<li>interface</li>
|
||||
<li>internal</li>
|
||||
<li>is</li>
|
||||
<li>localVarFileParams</li>
|
||||
<li>localVarFormParams</li>
|
||||
<li>localVarHeaderParams</li>
|
||||
<li>localVarHttpContentType</li>
|
||||
<li>localVarHttpContentTypes</li>
|
||||
<li>localVarHttpHeaderAccept</li>
|
||||
<li>localVarHttpHeaderAccepts</li>
|
||||
<li>localVarPath</li>
|
||||
<li>localVarPathParams</li>
|
||||
<li>localVarPostBody</li>
|
||||
<li>localVarQueryParams</li>
|
||||
<li>localVarResponse</li>
|
||||
<li>localVarStatusCode</li>
|
||||
<li>lock</li>
|
||||
<li>long</li>
|
||||
<li>namespace</li>
|
||||
<li>new</li>
|
||||
<li>null</li>
|
||||
<li>object</li>
|
||||
<li>operator</li>
|
||||
<li>out</li>
|
||||
<li>override</li>
|
||||
<li>parameter</li>
|
||||
<li>params</li>
|
||||
<li>private</li>
|
||||
<li>protected</li>
|
||||
<li>public</li>
|
||||
<li>readonly</li>
|
||||
<li>ref</li>
|
||||
<li>return</li>
|
||||
<li>sbyte</li>
|
||||
<li>sealed</li>
|
||||
<li>short</li>
|
||||
<li>sizeof</li>
|
||||
<li>stackalloc</li>
|
||||
<li>static</li>
|
||||
<li>string</li>
|
||||
<li>struct</li>
|
||||
<li>switch</li>
|
||||
<li>this</li>
|
||||
<li>throw</li>
|
||||
<li>true</li>
|
||||
<li>try</li>
|
||||
<li>typeof</li>
|
||||
<li>uint</li>
|
||||
<li>ulong</li>
|
||||
<li>unchecked</li>
|
||||
<li>unsafe</li>
|
||||
<li>ushort</li>
|
||||
<li>using</li>
|
||||
<li>virtual</li>
|
||||
<li>void</li>
|
||||
<li>volatile</li>
|
||||
<li>while</li>
|
||||
</ul>
|
||||
|
||||
@ -5,20 +5,20 @@ sidebar_label: csharp-nancyfx
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|asyncServer|Set to true to enable the generation of async routes/endpoints.| |false|
|
||||
|immutable|Enabled by default. If disabled generates model classes with setters| |true|
|
||||
|interfacePrefix|Prefix interfaces with a community standard or widely accepted prefix.| ||
|
||||
|optionalProjectFile|Generate {PackageName}.csproj.| |true|
|
||||
|packageContext|Optionally overrides the PackageContext which determines the namespace (namespace=packageName.packageContext). If not set, packageContext will default to basePath.| |null|
|
||||
|packageGuid|The GUID that will be associated with the C# project| |null|
|
||||
|packageName|C# package name (convention: Title.Case).| |Org.OpenAPITools|
|
||||
|packageVersion|C# package version.| |1.0.0|
|
||||
|sourceFolder|source folder for generated code| |src|
|
||||
|interfacePrefix|Prefix interfaces with a community standard or widely accepted prefix.| ||
|
||||
|packageGuid|The GUID that will be associated with the C# project| |null|
|
||||
|packageContext|Optionally overrides the PackageContext which determines the namespace (namespace=packageName.packageContext). If not set, packageContext will default to basePath.| |null|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|optionalProjectFile|Generate {PackageName}.csproj.| |true|
|
||||
|useDateTimeOffset|Use DateTimeOffset to model date-time properties| |false|
|
||||
|useCollection|Deserialize array types to Collection<T> instead of List<T>.| |false|
|
||||
|returnICollection|Return ICollection<T> instead of the concrete type.| |false|
|
||||
|immutable|Enabled by default. If disabled generates model classes with setters| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sourceFolder|source folder for generated code| |src|
|
||||
|useCollection|Deserialize array types to Collection<T> instead of List<T>.| |false|
|
||||
|useDateTimeOffset|Use DateTimeOffset to model date-time properties| |false|
|
||||
|writeModulePath|Enabled by default. If disabled, module paths will not mirror api base path| |true|
|
||||
|asyncServer|Set to true to enable the generation of async routes/endpoints.| |false|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
@ -37,48 +37,48 @@ sidebar_label: csharp-nancyfx
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>int?</li>
|
||||
<li>Dictionary</li>
|
||||
<li>string</li>
|
||||
<li>bool</li>
|
||||
<li>LocalDate?</li>
|
||||
<li>DateTimeOffset?</li>
|
||||
<li>ZonedDateTime?</li>
|
||||
<li>String</li>
|
||||
<li>Guid</li>
|
||||
<li>System.IO.Stream</li>
|
||||
<li>bool?</li>
|
||||
<li>float</li>
|
||||
<li>long</li>
|
||||
<li>DateTime</li>
|
||||
<li>Int32</li>
|
||||
<li>float?</li>
|
||||
<li>DateTime?</li>
|
||||
<li>List</li>
|
||||
<li>Boolean</li>
|
||||
<li>LocalTime?</li>
|
||||
<li>long?</li>
|
||||
<li>double</li>
|
||||
<li>Guid?</li>
|
||||
<li>DateTimeOffset</li>
|
||||
<li>Double</li>
|
||||
<li>int</li>
|
||||
<li>byte[]</li>
|
||||
<li>Float</li>
|
||||
<li>Int64</li>
|
||||
<li>double?</li>
|
||||
<li>ICollection</li>
|
||||
<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>Boolean</li>
|
||||
<li>Collection</li>
|
||||
<li>DateTime</li>
|
||||
<li>DateTime?</li>
|
||||
<li>DateTimeOffset</li>
|
||||
<li>DateTimeOffset?</li>
|
||||
<li>Dictionary</li>
|
||||
<li>Double</li>
|
||||
<li>Float</li>
|
||||
<li>Guid</li>
|
||||
<li>Guid?</li>
|
||||
<li>ICollection</li>
|
||||
<li>Int32</li>
|
||||
<li>Int64</li>
|
||||
<li>List</li>
|
||||
<li>LocalDate?</li>
|
||||
<li>LocalTime?</li>
|
||||
<li>Object</li>
|
||||
<li>decimal?</li>
|
||||
<li>String</li>
|
||||
<li>System.IO.Stream</li>
|
||||
<li>ZonedDateTime?</li>
|
||||
<li>bool</li>
|
||||
<li>bool?</li>
|
||||
<li>byte[]</li>
|
||||
<li>decimal</li>
|
||||
<li>decimal?</li>
|
||||
<li>double</li>
|
||||
<li>double?</li>
|
||||
<li>float</li>
|
||||
<li>float?</li>
|
||||
<li>int</li>
|
||||
<li>int?</li>
|
||||
<li>long</li>
|
||||
<li>long?</li>
|
||||
<li>string</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>async</li>
|
||||
<li>var</li>
|
||||
<li>yield</li>
|
||||
<li>await</li>
|
||||
<li>dynamic</li>
|
||||
<li>var</li>
|
||||
<li>yield</li>
|
||||
</ul>
|
||||
|
||||
@ -5,27 +5,27 @@ sidebar_label: csharp-netcore
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|packageName|C# package name (convention: Title.Case).| |Org.OpenAPITools|
|
||||
|packageVersion|C# package version.| |1.0.0|
|
||||
|sourceFolder|source folder for generated code| |src|
|
||||
|packageGuid|The GUID that will be associated with the C# project| |null|
|
||||
|interfacePrefix|Prefix interfaces with a community standard or widely accepted prefix.| |I|
|
||||
|targetFramework|The target .NET framework version.|<dl><dt>**netstandard1.3**</dt><dd>.NET Standard 1.3 compatible</dd><dt>**netstandard1.4**</dt><dd>.NET Standard 1.4 compatible</dd><dt>**netstandard1.5**</dt><dd>.NET Standard 1.5 compatible</dd><dt>**netstandard1.6**</dt><dd>.NET Standard 1.6 compatible</dd><dt>**netstandard2.0**</dt><dd>.NET Standard 2.0 compatible</dd><dt>**netcoreapp2.0**</dt><dd>.NET Core 2.0 compatible</dd><dl>|netstandard2.0|
|
||||
|modelPropertyNaming|Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |PascalCase|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|caseInsensitiveResponseHeaders|Make API response's headers case-insensitive| |false|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|useDateTimeOffset|Use DateTimeOffset to model date-time properties| |false|
|
||||
|useCollection|Deserialize array types to Collection<T> instead of List<T>.| |false|
|
||||
|returnICollection|Return ICollection<T> instead of the concrete type.| |false|
|
||||
|optionalMethodArgument|C# Optional method argument, e.g. void square(int x=10) (.net 4.0+ only).| |true|
|
||||
|interfacePrefix|Prefix interfaces with a community standard or widely accepted prefix.| |I|
|
||||
|modelPropertyNaming|Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |PascalCase|
|
||||
|netCoreProjectFile|Use the new format (.NET Core) for .NET project files (.csproj).| |false|
|
||||
|nonPublicApi|Generates code with reduced access modifiers; allows embedding elsewhere without exposing non-public API calls to consumers.| |false|
|
||||
|optionalAssemblyInfo|Generate AssemblyInfo.cs.| |true|
|
||||
|optionalEmitDefaultValues|Set DataMember's EmitDefaultValue.| |false|
|
||||
|optionalMethodArgument|C# Optional method argument, e.g. void square(int x=10) (.net 4.0+ only).| |true|
|
||||
|optionalProjectFile|Generate {PackageName}.csproj.| |true|
|
||||
|nonPublicApi|Generates code with reduced access modifiers; allows embedding elsewhere without exposing non-public API calls to consumers.| |false|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|netCoreProjectFile|Use the new format (.NET Core) for .NET project files (.csproj).| |false|
|
||||
|packageGuid|The GUID that will be associated with the C# project| |null|
|
||||
|packageName|C# package name (convention: Title.Case).| |Org.OpenAPITools|
|
||||
|packageVersion|C# package version.| |1.0.0|
|
||||
|returnICollection|Return ICollection<T> instead of the concrete type.| |false|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sourceFolder|source folder for generated code| |src|
|
||||
|targetFramework|The target .NET framework version.|<dl><dt>**netstandard1.3**</dt><dd>.NET Standard 1.3 compatible</dd><dt>**netstandard1.4**</dt><dd>.NET Standard 1.4 compatible</dd><dt>**netstandard1.5**</dt><dd>.NET Standard 1.5 compatible</dd><dt>**netstandard1.6**</dt><dd>.NET Standard 1.6 compatible</dd><dt>**netstandard2.0**</dt><dd>.NET Standard 2.0 compatible</dd><dt>**netcoreapp2.0**</dt><dd>.NET Core 2.0 compatible</dd><dl>|netstandard2.0|
|
||||
|useCollection|Deserialize array types to Collection<T> instead of List<T>.| |false|
|
||||
|useDateTimeOffset|Use DateTimeOffset to model date-time properties| |false|
|
||||
|validatable|Generates self-validatable models.| |true|
|
||||
|caseInsensitiveResponseHeaders|Make API response's headers case-insensitive| |false|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
@ -44,133 +44,133 @@ sidebar_label: csharp-netcore
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>int?</li>
|
||||
<li>Dictionary</li>
|
||||
<li>string</li>
|
||||
<li>bool</li>
|
||||
<li>DateTimeOffset?</li>
|
||||
<li>String</li>
|
||||
<li>Guid</li>
|
||||
<li>System.IO.Stream</li>
|
||||
<li>bool?</li>
|
||||
<li>float</li>
|
||||
<li>long</li>
|
||||
<li>DateTime</li>
|
||||
<li>Int32</li>
|
||||
<li>float?</li>
|
||||
<li>DateTime?</li>
|
||||
<li>List</li>
|
||||
<li>Boolean</li>
|
||||
<li>long?</li>
|
||||
<li>double</li>
|
||||
<li>Guid?</li>
|
||||
<li>DateTimeOffset</li>
|
||||
<li>Double</li>
|
||||
<li>int</li>
|
||||
<li>byte[]</li>
|
||||
<li>Float</li>
|
||||
<li>Int64</li>
|
||||
<li>double?</li>
|
||||
<li>ICollection</li>
|
||||
<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>Boolean</li>
|
||||
<li>Collection</li>
|
||||
<li>DateTime</li>
|
||||
<li>DateTime?</li>
|
||||
<li>DateTimeOffset</li>
|
||||
<li>DateTimeOffset?</li>
|
||||
<li>Dictionary</li>
|
||||
<li>Double</li>
|
||||
<li>Float</li>
|
||||
<li>Guid</li>
|
||||
<li>Guid?</li>
|
||||
<li>ICollection</li>
|
||||
<li>Int32</li>
|
||||
<li>Int64</li>
|
||||
<li>List</li>
|
||||
<li>Object</li>
|
||||
<li>decimal?</li>
|
||||
<li>String</li>
|
||||
<li>System.IO.Stream</li>
|
||||
<li>bool</li>
|
||||
<li>bool?</li>
|
||||
<li>byte[]</li>
|
||||
<li>decimal</li>
|
||||
<li>decimal?</li>
|
||||
<li>double</li>
|
||||
<li>double?</li>
|
||||
<li>float</li>
|
||||
<li>float?</li>
|
||||
<li>int</li>
|
||||
<li>int?</li>
|
||||
<li>long</li>
|
||||
<li>long?</li>
|
||||
<li>string</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>struct</li>
|
||||
<li>extern</li>
|
||||
<li>do</li>
|
||||
<li>ushort</li>
|
||||
<li>float</li>
|
||||
<li>while</li>
|
||||
<li>operator</li>
|
||||
<li>localVarQueryParams</li>
|
||||
<li>ref</li>
|
||||
<li>protected</li>
|
||||
<li>readonly</li>
|
||||
<li>continue</li>
|
||||
<li>else</li>
|
||||
<li>checked</li>
|
||||
<li>lock</li>
|
||||
<li>localVarPathParams</li>
|
||||
<li>catch</li>
|
||||
<li>Client</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>localVarHttpHeaderAccepts</li>
|
||||
<li>new</li>
|
||||
<li>using</li>
|
||||
<li>static</li>
|
||||
<li>void</li>
|
||||
<li>localVarPostBody</li>
|
||||
<li>in</li>
|
||||
<li>sizeof</li>
|
||||
<li>localVarResponse</li>
|
||||
<li>byte</li>
|
||||
<li>double</li>
|
||||
<li>sealed</li>
|
||||
<li>finally</li>
|
||||
<li>this</li>
|
||||
<li>unchecked</li>
|
||||
<li>is</li>
|
||||
<li>params</li>
|
||||
<li>enum</li>
|
||||
<li>explicit</li>
|
||||
<li>as</li>
|
||||
<li>null</li>
|
||||
<li>localVarPath</li>
|
||||
<li>true</li>
|
||||
<li>fixed</li>
|
||||
<li>try</li>
|
||||
<li>decimal</li>
|
||||
<li>object</li>
|
||||
<li>implicit</li>
|
||||
<li>internal</li>
|
||||
<li>private</li>
|
||||
<li>virtual</li>
|
||||
<li>bool</li>
|
||||
<li>const</li>
|
||||
<li>string</li>
|
||||
<li>for</li>
|
||||
<li>localVarHttpHeaderAccept</li>
|
||||
<li>interface</li>
|
||||
<li>unsafe</li>
|
||||
<li>long</li>
|
||||
<li>out</li>
|
||||
<li>switch</li>
|
||||
<li>delegate</li>
|
||||
<li>foreach</li>
|
||||
<li>default</li>
|
||||
<li>ulong</li>
|
||||
<li>goto</li>
|
||||
<li>localVarHttpContentTypes</li>
|
||||
<li>localVarHttpContentType</li>
|
||||
<li>public</li>
|
||||
<li>localVarStatusCode</li>
|
||||
<li>stackalloc</li>
|
||||
<li>parameter</li>
|
||||
<li>client</li>
|
||||
<li>override</li>
|
||||
<li>event</li>
|
||||
<li>class</li>
|
||||
<li>typeof</li>
|
||||
<li>localVarFormParams</li>
|
||||
<li>break</li>
|
||||
<li>false</li>
|
||||
<li>volatile</li>
|
||||
<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>Client</li>
|
||||
<li>abstract</li>
|
||||
<li>uint</li>
|
||||
<li>int</li>
|
||||
<li>localVarHeaderParams</li>
|
||||
<li>throw</li>
|
||||
<li>char</li>
|
||||
<li>namespace</li>
|
||||
<li>sbyte</li>
|
||||
<li>short</li>
|
||||
<li>localVarFileParams</li>
|
||||
<li>return</li>
|
||||
<li>as</li>
|
||||
<li>base</li>
|
||||
<li>bool</li>
|
||||
<li>break</li>
|
||||
<li>byte</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>char</li>
|
||||
<li>checked</li>
|
||||
<li>class</li>
|
||||
<li>client</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>decimal</li>
|
||||
<li>default</li>
|
||||
<li>delegate</li>
|
||||
<li>do</li>
|
||||
<li>double</li>
|
||||
<li>else</li>
|
||||
<li>enum</li>
|
||||
<li>event</li>
|
||||
<li>explicit</li>
|
||||
<li>extern</li>
|
||||
<li>false</li>
|
||||
<li>finally</li>
|
||||
<li>fixed</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>foreach</li>
|
||||
<li>goto</li>
|
||||
<li>if</li>
|
||||
<li>implicit</li>
|
||||
<li>in</li>
|
||||
<li>int</li>
|
||||
<li>interface</li>
|
||||
<li>internal</li>
|
||||
<li>is</li>
|
||||
<li>localVarFileParams</li>
|
||||
<li>localVarFormParams</li>
|
||||
<li>localVarHeaderParams</li>
|
||||
<li>localVarHttpContentType</li>
|
||||
<li>localVarHttpContentTypes</li>
|
||||
<li>localVarHttpHeaderAccept</li>
|
||||
<li>localVarHttpHeaderAccepts</li>
|
||||
<li>localVarPath</li>
|
||||
<li>localVarPathParams</li>
|
||||
<li>localVarPostBody</li>
|
||||
<li>localVarQueryParams</li>
|
||||
<li>localVarResponse</li>
|
||||
<li>localVarStatusCode</li>
|
||||
<li>lock</li>
|
||||
<li>long</li>
|
||||
<li>namespace</li>
|
||||
<li>new</li>
|
||||
<li>null</li>
|
||||
<li>object</li>
|
||||
<li>operator</li>
|
||||
<li>out</li>
|
||||
<li>override</li>
|
||||
<li>parameter</li>
|
||||
<li>params</li>
|
||||
<li>private</li>
|
||||
<li>protected</li>
|
||||
<li>public</li>
|
||||
<li>readonly</li>
|
||||
<li>ref</li>
|
||||
<li>return</li>
|
||||
<li>sbyte</li>
|
||||
<li>sealed</li>
|
||||
<li>short</li>
|
||||
<li>sizeof</li>
|
||||
<li>stackalloc</li>
|
||||
<li>static</li>
|
||||
<li>string</li>
|
||||
<li>struct</li>
|
||||
<li>switch</li>
|
||||
<li>this</li>
|
||||
<li>throw</li>
|
||||
<li>true</li>
|
||||
<li>try</li>
|
||||
<li>typeof</li>
|
||||
<li>uint</li>
|
||||
<li>ulong</li>
|
||||
<li>unchecked</li>
|
||||
<li>unsafe</li>
|
||||
<li>ushort</li>
|
||||
<li>using</li>
|
||||
<li>virtual</li>
|
||||
<li>void</li>
|
||||
<li>volatile</li>
|
||||
<li>while</li>
|
||||
</ul>
|
||||
|
||||
@ -1,29 +0,0 @@
|
||||
|
||||
---
|
||||
id: generator-opts-client-csharp-refactor
|
||||
title: Config Options for csharp-refactor
|
||||
sidebar_label: csharp-refactor
|
||||
---
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|packageName|C# package name (convention: Title.Case).| |Org.OpenAPITools|
|
||||
|packageVersion|C# package version.| |1.0.0|
|
||||
|sourceFolder|source folder for generated code| |src|
|
||||
|packageGuid|The GUID that will be associated with the C# project| |null|
|
||||
|interfacePrefix|Prefix interfaces with a community standard or widely accepted prefix.| |I|
|
||||
|targetFramework|The target .NET framework version.|<dl><dt>**netstandard1.3**</dt><dd>.NET Standard 1.3 compatible</dd><dt>**netstandard1.4**</dt><dd>.NET Standard 1.4 compatible</dd><dt>**netstandard1.5**</dt><dd>.NET Standard 1.5 compatible</dd><dt>**netstandard1.6**</dt><dd>.NET Standard 1.6 compatible</dd><dt>**netstandard2.0**</dt><dd>.NET Standard 2.0 compatible</dd><dt>**netcoreapp2.0**</dt><dd>.NET Core 2.0 compatible</dd><dl>|v4.6.1|
|
||||
|modelPropertyNaming|Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |PascalCase|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|useDateTimeOffset|Use DateTimeOffset to model date-time properties| |false|
|
||||
|useCollection|Deserialize array types to Collection<T> instead of List<T>.| |false|
|
||||
|returnICollection|Return ICollection<T> instead of the concrete type.| |false|
|
||||
|optionalMethodArgument|C# Optional method argument, e.g. void square(int x=10) (.net 4.0+ only).| |true|
|
||||
|optionalAssemblyInfo|Generate AssemblyInfo.cs.| |true|
|
||||
|optionalProjectFile|Generate {PackageName}.csproj.| |true|
|
||||
|optionalEmitDefaultValues|Set DataMember's EmitDefaultValue.| |false|
|
||||
|nonPublicApi|Generates code with reduced access modifiers; allows embedding elsewhere without exposing non-public API calls to consumers.| |false|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|netCoreProjectFile|Use the new format (.NET Core) for .NET project files (.csproj).| |false|
|
||||
|validatable|Generates self-validatable models.| |true|
|
||||
@ -5,29 +5,29 @@ sidebar_label: csharp
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|packageName|C# package name (convention: Title.Case).| |Org.OpenAPITools|
|
||||
|packageVersion|C# package version.| |1.0.0|
|
||||
|sourceFolder|source folder for generated code| |src|
|
||||
|packageGuid|The GUID that will be associated with the C# project| |null|
|
||||
|interfacePrefix|Prefix interfaces with a community standard or widely accepted prefix.| |I|
|
||||
|targetFramework|The target .NET framework version.|<dl><dt>**v3.5**</dt><dd>.NET Framework 3.5 compatible</dd><dt>**v4.0**</dt><dd>.NET Framework 4.0 compatible</dd><dt>**v4.5**</dt><dd>.NET Framework 4.5+ compatible</dd><dt>**v5.0**</dt><dd>.NET Standard 1.3 compatible (DEPRECATED. Please use `csharp-netcore` generator instead)</dd><dt>**uwp**</dt><dd>Universal Windows Platform (DEPRECATED. Please use `csharp-netcore` generator instead)</dd><dl>|v4.5|
|
||||
|modelPropertyNaming|Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |PascalCase|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|caseInsensitiveResponseHeaders|Make API response's headers case-insensitive| |false|
|
||||
|generatePropertyChanged|Specifies a AssemblyDescription for the .NET Framework global assembly attributes stored in the AssemblyInfo file.| |false|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|useDateTimeOffset|Use DateTimeOffset to model date-time properties| |false|
|
||||
|useCollection|Deserialize array types to Collection<T> instead of List<T>.| |false|
|
||||
|returnICollection|Return ICollection<T> instead of the concrete type.| |false|
|
||||
|optionalMethodArgument|C# Optional method argument, e.g. void square(int x=10) (.net 4.0+ only).| |true|
|
||||
|interfacePrefix|Prefix interfaces with a community standard or widely accepted prefix.| |I|
|
||||
|modelPropertyNaming|Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |PascalCase|
|
||||
|netCoreProjectFile|Use the new format (.NET Core) for .NET project files (.csproj).| |false|
|
||||
|nonPublicApi|Generates code with reduced access modifiers; allows embedding elsewhere without exposing non-public API calls to consumers.| |false|
|
||||
|optionalAssemblyInfo|Generate AssemblyInfo.cs.| |true|
|
||||
|optionalEmitDefaultValues|Set DataMember's EmitDefaultValue.| |false|
|
||||
|optionalMethodArgument|C# Optional method argument, e.g. void square(int x=10) (.net 4.0+ only).| |true|
|
||||
|optionalProjectFile|Generate {PackageName}.csproj.| |true|
|
||||
|generatePropertyChanged|Specifies a AssemblyDescription for the .NET Framework global assembly attributes stored in the AssemblyInfo file.| |false|
|
||||
|nonPublicApi|Generates code with reduced access modifiers; allows embedding elsewhere without exposing non-public API calls to consumers.| |false|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|netCoreProjectFile|Use the new format (.NET Core) for .NET project files (.csproj).| |false|
|
||||
|validatable|Generates self-validatable models.| |true|
|
||||
|packageGuid|The GUID that will be associated with the C# project| |null|
|
||||
|packageName|C# package name (convention: Title.Case).| |Org.OpenAPITools|
|
||||
|packageVersion|C# package version.| |1.0.0|
|
||||
|returnICollection|Return ICollection<T> instead of the concrete type.| |false|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sourceFolder|source folder for generated code| |src|
|
||||
|targetFramework|The target .NET framework version.|<dl><dt>**v3.5**</dt><dd>.NET Framework 3.5 compatible</dd><dt>**v4.0**</dt><dd>.NET Framework 4.0 compatible</dd><dt>**v4.5**</dt><dd>.NET Framework 4.5+ compatible</dd><dt>**v5.0**</dt><dd>.NET Standard 1.3 compatible (DEPRECATED. Please use `csharp-netcore` generator instead)</dd><dt>**uwp**</dt><dd>Universal Windows Platform (DEPRECATED. Please use `csharp-netcore` generator instead)</dd><dl>|v4.5|
|
||||
|useCollection|Deserialize array types to Collection<T> instead of List<T>.| |false|
|
||||
|useCompareNetObjects|Use KellermanSoftware.CompareNetObjects for deep recursive object comparison. WARNING: this option incurs potential performance impact.| |false|
|
||||
|caseInsensitiveResponseHeaders|Make API response's headers case-insensitive| |false|
|
||||
|useDateTimeOffset|Use DateTimeOffset to model date-time properties| |false|
|
||||
|validatable|Generates self-validatable models.| |true|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
@ -46,133 +46,133 @@ sidebar_label: csharp
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>int?</li>
|
||||
<li>Dictionary</li>
|
||||
<li>string</li>
|
||||
<li>bool</li>
|
||||
<li>DateTimeOffset?</li>
|
||||
<li>String</li>
|
||||
<li>Guid</li>
|
||||
<li>System.IO.Stream</li>
|
||||
<li>bool?</li>
|
||||
<li>float</li>
|
||||
<li>long</li>
|
||||
<li>DateTime</li>
|
||||
<li>Int32</li>
|
||||
<li>float?</li>
|
||||
<li>DateTime?</li>
|
||||
<li>List</li>
|
||||
<li>Boolean</li>
|
||||
<li>long?</li>
|
||||
<li>double</li>
|
||||
<li>Guid?</li>
|
||||
<li>DateTimeOffset</li>
|
||||
<li>Double</li>
|
||||
<li>int</li>
|
||||
<li>byte[]</li>
|
||||
<li>Float</li>
|
||||
<li>Int64</li>
|
||||
<li>double?</li>
|
||||
<li>ICollection</li>
|
||||
<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>Boolean</li>
|
||||
<li>Collection</li>
|
||||
<li>DateTime</li>
|
||||
<li>DateTime?</li>
|
||||
<li>DateTimeOffset</li>
|
||||
<li>DateTimeOffset?</li>
|
||||
<li>Dictionary</li>
|
||||
<li>Double</li>
|
||||
<li>Float</li>
|
||||
<li>Guid</li>
|
||||
<li>Guid?</li>
|
||||
<li>ICollection</li>
|
||||
<li>Int32</li>
|
||||
<li>Int64</li>
|
||||
<li>List</li>
|
||||
<li>Object</li>
|
||||
<li>decimal?</li>
|
||||
<li>String</li>
|
||||
<li>System.IO.Stream</li>
|
||||
<li>bool</li>
|
||||
<li>bool?</li>
|
||||
<li>byte[]</li>
|
||||
<li>decimal</li>
|
||||
<li>decimal?</li>
|
||||
<li>double</li>
|
||||
<li>double?</li>
|
||||
<li>float</li>
|
||||
<li>float?</li>
|
||||
<li>int</li>
|
||||
<li>int?</li>
|
||||
<li>long</li>
|
||||
<li>long?</li>
|
||||
<li>string</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>struct</li>
|
||||
<li>extern</li>
|
||||
<li>do</li>
|
||||
<li>ushort</li>
|
||||
<li>float</li>
|
||||
<li>while</li>
|
||||
<li>operator</li>
|
||||
<li>localVarQueryParams</li>
|
||||
<li>ref</li>
|
||||
<li>protected</li>
|
||||
<li>readonly</li>
|
||||
<li>continue</li>
|
||||
<li>else</li>
|
||||
<li>checked</li>
|
||||
<li>lock</li>
|
||||
<li>localVarPathParams</li>
|
||||
<li>catch</li>
|
||||
<li>Client</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>localVarHttpHeaderAccepts</li>
|
||||
<li>new</li>
|
||||
<li>using</li>
|
||||
<li>static</li>
|
||||
<li>void</li>
|
||||
<li>localVarPostBody</li>
|
||||
<li>in</li>
|
||||
<li>sizeof</li>
|
||||
<li>localVarResponse</li>
|
||||
<li>byte</li>
|
||||
<li>double</li>
|
||||
<li>sealed</li>
|
||||
<li>finally</li>
|
||||
<li>this</li>
|
||||
<li>unchecked</li>
|
||||
<li>is</li>
|
||||
<li>params</li>
|
||||
<li>enum</li>
|
||||
<li>explicit</li>
|
||||
<li>as</li>
|
||||
<li>null</li>
|
||||
<li>localVarPath</li>
|
||||
<li>true</li>
|
||||
<li>fixed</li>
|
||||
<li>try</li>
|
||||
<li>decimal</li>
|
||||
<li>object</li>
|
||||
<li>implicit</li>
|
||||
<li>internal</li>
|
||||
<li>private</li>
|
||||
<li>virtual</li>
|
||||
<li>bool</li>
|
||||
<li>const</li>
|
||||
<li>string</li>
|
||||
<li>for</li>
|
||||
<li>localVarHttpHeaderAccept</li>
|
||||
<li>interface</li>
|
||||
<li>unsafe</li>
|
||||
<li>long</li>
|
||||
<li>out</li>
|
||||
<li>switch</li>
|
||||
<li>delegate</li>
|
||||
<li>foreach</li>
|
||||
<li>default</li>
|
||||
<li>ulong</li>
|
||||
<li>goto</li>
|
||||
<li>localVarHttpContentTypes</li>
|
||||
<li>localVarHttpContentType</li>
|
||||
<li>public</li>
|
||||
<li>localVarStatusCode</li>
|
||||
<li>stackalloc</li>
|
||||
<li>parameter</li>
|
||||
<li>client</li>
|
||||
<li>override</li>
|
||||
<li>event</li>
|
||||
<li>class</li>
|
||||
<li>typeof</li>
|
||||
<li>localVarFormParams</li>
|
||||
<li>break</li>
|
||||
<li>false</li>
|
||||
<li>volatile</li>
|
||||
<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>Client</li>
|
||||
<li>abstract</li>
|
||||
<li>uint</li>
|
||||
<li>int</li>
|
||||
<li>localVarHeaderParams</li>
|
||||
<li>throw</li>
|
||||
<li>char</li>
|
||||
<li>namespace</li>
|
||||
<li>sbyte</li>
|
||||
<li>short</li>
|
||||
<li>localVarFileParams</li>
|
||||
<li>return</li>
|
||||
<li>as</li>
|
||||
<li>base</li>
|
||||
<li>bool</li>
|
||||
<li>break</li>
|
||||
<li>byte</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>char</li>
|
||||
<li>checked</li>
|
||||
<li>class</li>
|
||||
<li>client</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>decimal</li>
|
||||
<li>default</li>
|
||||
<li>delegate</li>
|
||||
<li>do</li>
|
||||
<li>double</li>
|
||||
<li>else</li>
|
||||
<li>enum</li>
|
||||
<li>event</li>
|
||||
<li>explicit</li>
|
||||
<li>extern</li>
|
||||
<li>false</li>
|
||||
<li>finally</li>
|
||||
<li>fixed</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>foreach</li>
|
||||
<li>goto</li>
|
||||
<li>if</li>
|
||||
<li>implicit</li>
|
||||
<li>in</li>
|
||||
<li>int</li>
|
||||
<li>interface</li>
|
||||
<li>internal</li>
|
||||
<li>is</li>
|
||||
<li>localVarFileParams</li>
|
||||
<li>localVarFormParams</li>
|
||||
<li>localVarHeaderParams</li>
|
||||
<li>localVarHttpContentType</li>
|
||||
<li>localVarHttpContentTypes</li>
|
||||
<li>localVarHttpHeaderAccept</li>
|
||||
<li>localVarHttpHeaderAccepts</li>
|
||||
<li>localVarPath</li>
|
||||
<li>localVarPathParams</li>
|
||||
<li>localVarPostBody</li>
|
||||
<li>localVarQueryParams</li>
|
||||
<li>localVarResponse</li>
|
||||
<li>localVarStatusCode</li>
|
||||
<li>lock</li>
|
||||
<li>long</li>
|
||||
<li>namespace</li>
|
||||
<li>new</li>
|
||||
<li>null</li>
|
||||
<li>object</li>
|
||||
<li>operator</li>
|
||||
<li>out</li>
|
||||
<li>override</li>
|
||||
<li>parameter</li>
|
||||
<li>params</li>
|
||||
<li>private</li>
|
||||
<li>protected</li>
|
||||
<li>public</li>
|
||||
<li>readonly</li>
|
||||
<li>ref</li>
|
||||
<li>return</li>
|
||||
<li>sbyte</li>
|
||||
<li>sealed</li>
|
||||
<li>short</li>
|
||||
<li>sizeof</li>
|
||||
<li>stackalloc</li>
|
||||
<li>static</li>
|
||||
<li>string</li>
|
||||
<li>struct</li>
|
||||
<li>switch</li>
|
||||
<li>this</li>
|
||||
<li>throw</li>
|
||||
<li>true</li>
|
||||
<li>try</li>
|
||||
<li>typeof</li>
|
||||
<li>uint</li>
|
||||
<li>ulong</li>
|
||||
<li>unchecked</li>
|
||||
<li>unsafe</li>
|
||||
<li>ushort</li>
|
||||
<li>using</li>
|
||||
<li>virtual</li>
|
||||
<li>void</li>
|
||||
<li>volatile</li>
|
||||
<li>while</li>
|
||||
</ul>
|
||||
|
||||
@ -5,21 +5,21 @@ sidebar_label: cwiki
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|appName|short name of the application| |null|
|
||||
|appDescription|description of the application| |null|
|
||||
|infoUrl|a URL where users can get more information about the application| |null|
|
||||
|infoEmail|an email address to contact for inquiries about the application| |null|
|
||||
|licenseInfo|a short description of the license| |null|
|
||||
|licenseUrl|a URL pointing to the full license| |null|
|
||||
|invokerPackage|root package for generated code| |null|
|
||||
|groupId|groupId in generated pom.xml| |null|
|
||||
|appName|short name of the application| |null|
|
||||
|artifactId|artifactId in generated pom.xml. This also becomes part of the generated library's filename| |null|
|
||||
|artifactVersion|artifact version in generated pom.xml. This also becomes part of the generated library's filename| |null|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|groupId|groupId in generated pom.xml| |null|
|
||||
|infoEmail|an email address to contact for inquiries about the application| |null|
|
||||
|infoUrl|a URL where users can get more information about the application| |null|
|
||||
|invokerPackage|root package for generated code| |null|
|
||||
|licenseInfo|a short description of the license| |null|
|
||||
|licenseUrl|a URL pointing to the full license| |null|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
|
||||
@ -5,32 +5,32 @@ sidebar_label: dart-dio
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|browserClient|Is the client browser based (for Dart 1.x only)| |null|
|
||||
|pubName|Name in generated pubspec| |null|
|
||||
|pubVersion|Version in generated pubspec| |null|
|
||||
|pubDescription|Description in generated pubspec| |null|
|
||||
|dateLibrary|Option. Date library to use|<dl><dt>**core**</dt><dd>Dart core library (DateTime)</dd><dt>**timemachine**</dt><dd>Time Machine is date and time library for Flutter, Web, and Server with support for timezones, calendars, cultures, formatting and parsing.</dd><dl>|core|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|nullableFields|Is the null fields should be in the JSON payload| |null|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|pubAuthor|Author name in generated pubspec| |null|
|
||||
|pubAuthorEmail|Email address of the author in generated pubspec| |null|
|
||||
|pubDescription|Description in generated pubspec| |null|
|
||||
|pubHomepage|Homepage in generated pubspec| |null|
|
||||
|useEnumExtension|Allow the 'x-enum-values' extension for enums| |null|
|
||||
|pubName|Name in generated pubspec| |null|
|
||||
|pubVersion|Version in generated pubspec| |null|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sourceFolder|Source folder for generated code| |null|
|
||||
|supportDart2|Support Dart 2.x (Dart 1.x support has been deprecated)| |true|
|
||||
|nullableFields|Is the null fields should be in the JSON payload| |null|
|
||||
|dateLibrary|Option. Date library to use|<dl><dt>**core**</dt><dd>Dart core library (DateTime)</dd><dt>**timemachine**</dt><dd>Time Machine is date and time library for Flutter, Web, and Server with support for timezones, calendars, cultures, formatting and parsing.</dd><dl>|core|
|
||||
|useEnumExtension|Allow the 'x-enum-values' extension for enums| |null|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|BuiltList|package:built_collection/built_collection.dart|
|
||||
|BuiltMap|package:built_collection/built_collection.dart|
|
||||
|JsonObject|package:built_value/json_object.dart|
|
||||
|Uint8List|dart:typed_data|
|
||||
|BuiltList|package:built_collection/built_collection.dart|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
@ -43,82 +43,82 @@ sidebar_label: dart-dio
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>bool</li>
|
||||
<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>String</li>
|
||||
<li>bool</li>
|
||||
<li>double</li>
|
||||
<li>num</li>
|
||||
<li>String</li>
|
||||
<li>int</li>
|
||||
<li>num</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>do</li>
|
||||
<li>source</li>
|
||||
<li>while</li>
|
||||
<li>operator</li>
|
||||
<li>required</li>
|
||||
<li>patch</li>
|
||||
<li>late</li>
|
||||
<li>continue</li>
|
||||
<li>else</li>
|
||||
<li>function</li>
|
||||
<li>dynamic</li>
|
||||
<li>catch</li>
|
||||
<li>export</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>new</li>
|
||||
<li>static</li>
|
||||
<li>void</li>
|
||||
<li>in</li>
|
||||
<li>var</li>
|
||||
<li>finally</li>
|
||||
<li>this</li>
|
||||
<li>is</li>
|
||||
<li>sync</li>
|
||||
<li>typedef</li>
|
||||
<li>enum</li>
|
||||
<li>covariant</li>
|
||||
<li>mixin</li>
|
||||
<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>abstract</li>
|
||||
<li>as</li>
|
||||
<li>external</li>
|
||||
<li>assert</li>
|
||||
<li>async</li>
|
||||
<li>await</li>
|
||||
<li>break</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>class</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>covariant</li>
|
||||
<li>default</li>
|
||||
<li>deferred</li>
|
||||
<li>do</li>
|
||||
<li>dynamic</li>
|
||||
<li>else</li>
|
||||
<li>enum</li>
|
||||
<li>export</li>
|
||||
<li>extends</li>
|
||||
<li>null</li>
|
||||
<li>extension</li>
|
||||
<li>external</li>
|
||||
<li>factory</li>
|
||||
<li>false</li>
|
||||
<li>final</li>
|
||||
<li>finally</li>
|
||||
<li>for</li>
|
||||
<li>function</li>
|
||||
<li>get</li>
|
||||
<li>hide</li>
|
||||
<li>if</li>
|
||||
<li>implements</li>
|
||||
<li>import</li>
|
||||
<li>in</li>
|
||||
<li>inout</li>
|
||||
<li>interface</li>
|
||||
<li>is</li>
|
||||
<li>late</li>
|
||||
<li>library</li>
|
||||
<li>mixin</li>
|
||||
<li>native</li>
|
||||
<li>new</li>
|
||||
<li>null</li>
|
||||
<li>of</li>
|
||||
<li>on</li>
|
||||
<li>operator</li>
|
||||
<li>out</li>
|
||||
<li>part</li>
|
||||
<li>patch</li>
|
||||
<li>required</li>
|
||||
<li>rethrow</li>
|
||||
<li>return</li>
|
||||
<li>set</li>
|
||||
<li>show</li>
|
||||
<li>source</li>
|
||||
<li>static</li>
|
||||
<li>super</li>
|
||||
<li>switch</li>
|
||||
<li>sync</li>
|
||||
<li>this</li>
|
||||
<li>throw</li>
|
||||
<li>true</li>
|
||||
<li>try</li>
|
||||
<li>implements</li>
|
||||
<li>deferred</li>
|
||||
<li>extension</li>
|
||||
<li>const</li>
|
||||
<li>import</li>
|
||||
<li>part</li>
|
||||
<li>for</li>
|
||||
<li>show</li>
|
||||
<li>interface</li>
|
||||
<li>out</li>
|
||||
<li>switch</li>
|
||||
<li>default</li>
|
||||
<li>library</li>
|
||||
<li>native</li>
|
||||
<li>assert</li>
|
||||
<li>get</li>
|
||||
<li>of</li>
|
||||
<li>yield</li>
|
||||
<li>await</li>
|
||||
<li>class</li>
|
||||
<li>on</li>
|
||||
<li>rethrow</li>
|
||||
<li>factory</li>
|
||||
<li>set</li>
|
||||
<li>break</li>
|
||||
<li>false</li>
|
||||
<li>abstract</li>
|
||||
<li>super</li>
|
||||
<li>async</li>
|
||||
<li>typedef</li>
|
||||
<li>var</li>
|
||||
<li>void</li>
|
||||
<li>while</li>
|
||||
<li>with</li>
|
||||
<li>hide</li>
|
||||
<li>inout</li>
|
||||
<li>throw</li>
|
||||
<li>return</li>
|
||||
<li>yield</li>
|
||||
</ul>
|
||||
|
||||
@ -5,23 +5,23 @@ sidebar_label: dart-jaguar
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|browserClient|Is the client browser based (for Dart 1.x only)| |null|
|
||||
|pubName|Name in generated pubspec| |null|
|
||||
|pubVersion|Version in generated pubspec| |null|
|
||||
|pubDescription|Description in generated pubspec| |null|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|nullableFields|Is the null fields should be in the JSON payload| |null|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|pubAuthor|Author name in generated pubspec| |null|
|
||||
|pubAuthorEmail|Email address of the author in generated pubspec| |null|
|
||||
|pubDescription|Description in generated pubspec| |null|
|
||||
|pubHomepage|Homepage in generated pubspec| |null|
|
||||
|useEnumExtension|Allow the 'x-enum-values' extension for enums| |null|
|
||||
|pubName|Name in generated pubspec| |null|
|
||||
|pubVersion|Version in generated pubspec| |null|
|
||||
|serialization|Choose serialization format JSON or PROTO is supported| |null|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sourceFolder|Source folder for generated code| |null|
|
||||
|supportDart2|Support Dart 2.x (Dart 1.x support has been deprecated)| |true|
|
||||
|nullableFields|Is the null fields should be in the JSON payload| |null|
|
||||
|serialization|Choose serialization format JSON or PROTO is supported| |null|
|
||||
|useEnumExtension|Allow the 'x-enum-values' extension for enums| |null|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
@ -39,82 +39,82 @@ sidebar_label: dart-jaguar
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>bool</li>
|
||||
<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>String</li>
|
||||
<li>bool</li>
|
||||
<li>double</li>
|
||||
<li>num</li>
|
||||
<li>String</li>
|
||||
<li>int</li>
|
||||
<li>num</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>do</li>
|
||||
<li>source</li>
|
||||
<li>while</li>
|
||||
<li>operator</li>
|
||||
<li>required</li>
|
||||
<li>patch</li>
|
||||
<li>late</li>
|
||||
<li>continue</li>
|
||||
<li>else</li>
|
||||
<li>function</li>
|
||||
<li>dynamic</li>
|
||||
<li>catch</li>
|
||||
<li>export</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>new</li>
|
||||
<li>static</li>
|
||||
<li>void</li>
|
||||
<li>in</li>
|
||||
<li>var</li>
|
||||
<li>finally</li>
|
||||
<li>this</li>
|
||||
<li>is</li>
|
||||
<li>sync</li>
|
||||
<li>typedef</li>
|
||||
<li>enum</li>
|
||||
<li>covariant</li>
|
||||
<li>mixin</li>
|
||||
<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>abstract</li>
|
||||
<li>as</li>
|
||||
<li>external</li>
|
||||
<li>assert</li>
|
||||
<li>async</li>
|
||||
<li>await</li>
|
||||
<li>break</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>class</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>covariant</li>
|
||||
<li>default</li>
|
||||
<li>deferred</li>
|
||||
<li>do</li>
|
||||
<li>dynamic</li>
|
||||
<li>else</li>
|
||||
<li>enum</li>
|
||||
<li>export</li>
|
||||
<li>extends</li>
|
||||
<li>null</li>
|
||||
<li>extension</li>
|
||||
<li>external</li>
|
||||
<li>factory</li>
|
||||
<li>false</li>
|
||||
<li>final</li>
|
||||
<li>finally</li>
|
||||
<li>for</li>
|
||||
<li>function</li>
|
||||
<li>get</li>
|
||||
<li>hide</li>
|
||||
<li>if</li>
|
||||
<li>implements</li>
|
||||
<li>import</li>
|
||||
<li>in</li>
|
||||
<li>inout</li>
|
||||
<li>interface</li>
|
||||
<li>is</li>
|
||||
<li>late</li>
|
||||
<li>library</li>
|
||||
<li>mixin</li>
|
||||
<li>native</li>
|
||||
<li>new</li>
|
||||
<li>null</li>
|
||||
<li>of</li>
|
||||
<li>on</li>
|
||||
<li>operator</li>
|
||||
<li>out</li>
|
||||
<li>part</li>
|
||||
<li>patch</li>
|
||||
<li>required</li>
|
||||
<li>rethrow</li>
|
||||
<li>return</li>
|
||||
<li>set</li>
|
||||
<li>show</li>
|
||||
<li>source</li>
|
||||
<li>static</li>
|
||||
<li>super</li>
|
||||
<li>switch</li>
|
||||
<li>sync</li>
|
||||
<li>this</li>
|
||||
<li>throw</li>
|
||||
<li>true</li>
|
||||
<li>try</li>
|
||||
<li>implements</li>
|
||||
<li>deferred</li>
|
||||
<li>extension</li>
|
||||
<li>const</li>
|
||||
<li>import</li>
|
||||
<li>part</li>
|
||||
<li>for</li>
|
||||
<li>show</li>
|
||||
<li>interface</li>
|
||||
<li>out</li>
|
||||
<li>switch</li>
|
||||
<li>default</li>
|
||||
<li>library</li>
|
||||
<li>native</li>
|
||||
<li>assert</li>
|
||||
<li>get</li>
|
||||
<li>of</li>
|
||||
<li>yield</li>
|
||||
<li>await</li>
|
||||
<li>class</li>
|
||||
<li>on</li>
|
||||
<li>rethrow</li>
|
||||
<li>factory</li>
|
||||
<li>set</li>
|
||||
<li>break</li>
|
||||
<li>false</li>
|
||||
<li>abstract</li>
|
||||
<li>super</li>
|
||||
<li>async</li>
|
||||
<li>typedef</li>
|
||||
<li>var</li>
|
||||
<li>void</li>
|
||||
<li>while</li>
|
||||
<li>with</li>
|
||||
<li>hide</li>
|
||||
<li>inout</li>
|
||||
<li>throw</li>
|
||||
<li>return</li>
|
||||
<li>yield</li>
|
||||
</ul>
|
||||
|
||||
@ -5,21 +5,21 @@ sidebar_label: dart
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|browserClient|Is the client browser based (for Dart 1.x only)| |null|
|
||||
|pubName|Name in generated pubspec| |null|
|
||||
|pubVersion|Version in generated pubspec| |null|
|
||||
|pubDescription|Description in generated pubspec| |null|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|pubAuthor|Author name in generated pubspec| |null|
|
||||
|pubAuthorEmail|Email address of the author in generated pubspec| |null|
|
||||
|pubDescription|Description in generated pubspec| |null|
|
||||
|pubHomepage|Homepage in generated pubspec| |null|
|
||||
|useEnumExtension|Allow the 'x-enum-values' extension for enums| |null|
|
||||
|pubName|Name in generated pubspec| |null|
|
||||
|pubVersion|Version in generated pubspec| |null|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sourceFolder|Source folder for generated code| |null|
|
||||
|supportDart2|Support Dart 2.x (Dart 1.x support has been deprecated)| |true|
|
||||
|useEnumExtension|Allow the 'x-enum-values' extension for enums| |null|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
@ -37,82 +37,82 @@ sidebar_label: dart
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>bool</li>
|
||||
<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>String</li>
|
||||
<li>bool</li>
|
||||
<li>double</li>
|
||||
<li>num</li>
|
||||
<li>String</li>
|
||||
<li>int</li>
|
||||
<li>num</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>do</li>
|
||||
<li>source</li>
|
||||
<li>while</li>
|
||||
<li>operator</li>
|
||||
<li>required</li>
|
||||
<li>patch</li>
|
||||
<li>late</li>
|
||||
<li>continue</li>
|
||||
<li>else</li>
|
||||
<li>function</li>
|
||||
<li>dynamic</li>
|
||||
<li>catch</li>
|
||||
<li>export</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>new</li>
|
||||
<li>static</li>
|
||||
<li>void</li>
|
||||
<li>in</li>
|
||||
<li>var</li>
|
||||
<li>finally</li>
|
||||
<li>this</li>
|
||||
<li>is</li>
|
||||
<li>sync</li>
|
||||
<li>typedef</li>
|
||||
<li>enum</li>
|
||||
<li>covariant</li>
|
||||
<li>mixin</li>
|
||||
<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>abstract</li>
|
||||
<li>as</li>
|
||||
<li>external</li>
|
||||
<li>assert</li>
|
||||
<li>async</li>
|
||||
<li>await</li>
|
||||
<li>break</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>class</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>covariant</li>
|
||||
<li>default</li>
|
||||
<li>deferred</li>
|
||||
<li>do</li>
|
||||
<li>dynamic</li>
|
||||
<li>else</li>
|
||||
<li>enum</li>
|
||||
<li>export</li>
|
||||
<li>extends</li>
|
||||
<li>null</li>
|
||||
<li>extension</li>
|
||||
<li>external</li>
|
||||
<li>factory</li>
|
||||
<li>false</li>
|
||||
<li>final</li>
|
||||
<li>finally</li>
|
||||
<li>for</li>
|
||||
<li>function</li>
|
||||
<li>get</li>
|
||||
<li>hide</li>
|
||||
<li>if</li>
|
||||
<li>implements</li>
|
||||
<li>import</li>
|
||||
<li>in</li>
|
||||
<li>inout</li>
|
||||
<li>interface</li>
|
||||
<li>is</li>
|
||||
<li>late</li>
|
||||
<li>library</li>
|
||||
<li>mixin</li>
|
||||
<li>native</li>
|
||||
<li>new</li>
|
||||
<li>null</li>
|
||||
<li>of</li>
|
||||
<li>on</li>
|
||||
<li>operator</li>
|
||||
<li>out</li>
|
||||
<li>part</li>
|
||||
<li>patch</li>
|
||||
<li>required</li>
|
||||
<li>rethrow</li>
|
||||
<li>return</li>
|
||||
<li>set</li>
|
||||
<li>show</li>
|
||||
<li>source</li>
|
||||
<li>static</li>
|
||||
<li>super</li>
|
||||
<li>switch</li>
|
||||
<li>sync</li>
|
||||
<li>this</li>
|
||||
<li>throw</li>
|
||||
<li>true</li>
|
||||
<li>try</li>
|
||||
<li>implements</li>
|
||||
<li>deferred</li>
|
||||
<li>extension</li>
|
||||
<li>const</li>
|
||||
<li>import</li>
|
||||
<li>part</li>
|
||||
<li>for</li>
|
||||
<li>show</li>
|
||||
<li>interface</li>
|
||||
<li>out</li>
|
||||
<li>switch</li>
|
||||
<li>default</li>
|
||||
<li>library</li>
|
||||
<li>native</li>
|
||||
<li>assert</li>
|
||||
<li>get</li>
|
||||
<li>of</li>
|
||||
<li>yield</li>
|
||||
<li>await</li>
|
||||
<li>class</li>
|
||||
<li>on</li>
|
||||
<li>rethrow</li>
|
||||
<li>factory</li>
|
||||
<li>set</li>
|
||||
<li>break</li>
|
||||
<li>false</li>
|
||||
<li>abstract</li>
|
||||
<li>super</li>
|
||||
<li>async</li>
|
||||
<li>typedef</li>
|
||||
<li>var</li>
|
||||
<li>void</li>
|
||||
<li>while</li>
|
||||
<li>with</li>
|
||||
<li>hide</li>
|
||||
<li>inout</li>
|
||||
<li>throw</li>
|
||||
<li>return</li>
|
||||
<li>yield</li>
|
||||
</ul>
|
||||
|
||||
@ -5,15 +5,15 @@ sidebar_label: dynamic-html
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|invokerPackage|root package for generated code| |null|
|
||||
|groupId|groupId in generated pom.xml| |null|
|
||||
|artifactId|artifactId in generated pom.xml. This also becomes part of the generated library's filename| |null|
|
||||
|artifactVersion|artifact version in generated pom.xml. This also becomes part of the generated library's filename| |null|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|groupId|groupId in generated pom.xml| |null|
|
||||
|invokerPackage|root package for generated code| |null|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
|
||||
@ -5,30 +5,30 @@ sidebar_label: eiffel
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true|
|
||||
|packageName|Eiffel Cluster name (convention: lowercase).| |openapi|
|
||||
|packageVersion|Eiffel package version.| |1.0.0|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|Set|java.util.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|HashMap|java.util.HashMap|
|
||||
|Array|java.util.List|
|
||||
|ArrayList|java.util.ArrayList|
|
||||
|URI|java.net.URI|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|BigDecimal|java.math.BigDecimal|
|
||||
|Date|java.util.Date|
|
||||
|DateTime|org.joda.time.*|
|
||||
|Array|java.util.List|
|
||||
|List|java.util.*|
|
||||
|UUID|java.util.UUID|
|
||||
|File|java.io.File|
|
||||
|HashMap|java.util.HashMap|
|
||||
|List|java.util.*|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|Map|java.util.Map|
|
||||
|Set|java.util.*|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|URI|java.net.URI|
|
||||
|UUID|java.util.UUID|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
@ -42,79 +42,79 @@ sidebar_label: eiffel
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>INTEGER_16</li>
|
||||
<li>NATURAL_16</li>
|
||||
<li>INTEGER_8</li>
|
||||
<li>REAL_32</li>
|
||||
<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>BOOLEAN</li>
|
||||
<li>INTEGER_16</li>
|
||||
<li>INTEGER_32</li>
|
||||
<li>INTEGER_64</li>
|
||||
<li>REAL_64</li>
|
||||
<li>NATURAL_8</li>
|
||||
<li>BOOLEAN</li>
|
||||
<li>NATURAL_64</li>
|
||||
<li>INTEGER_8</li>
|
||||
<li>NATURAL_16</li>
|
||||
<li>NATURAL_32</li>
|
||||
<li>NATURAL_64</li>
|
||||
<li>NATURAL_8</li>
|
||||
<li>REAL_32</li>
|
||||
<li>REAL_64</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>agent</li>
|
||||
<li>select</li>
|
||||
<li>separate</li>
|
||||
<li>convert</li>
|
||||
<li>do</li>
|
||||
<li>when</li>
|
||||
<li>else</li>
|
||||
<li>loop</li>
|
||||
<li>elseif</li>
|
||||
<li>only</li>
|
||||
<li>precursor</li>
|
||||
<li>variant</li>
|
||||
<li>create</li>
|
||||
<li>from</li>
|
||||
<li>export</li>
|
||||
<li>if</li>
|
||||
<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>across</li>
|
||||
<li>agent</li>
|
||||
<li>alias</li>
|
||||
<li>all</li>
|
||||
<li>ensure</li>
|
||||
<li>void</li>
|
||||
<li>like</li>
|
||||
<li>old</li>
|
||||
<li>frozen</li>
|
||||
<li>require</li>
|
||||
<li>check</li>
|
||||
<li>then</li>
|
||||
<li>undefine</li>
|
||||
<li>invariant</li>
|
||||
<li>and</li>
|
||||
<li>as</li>
|
||||
<li>external</li>
|
||||
<li>once</li>
|
||||
<li>inspect</li>
|
||||
<li>true</li>
|
||||
<li>assign</li>
|
||||
<li>attribute</li>
|
||||
<li>check</li>
|
||||
<li>class</li>
|
||||
<li>convert</li>
|
||||
<li>create</li>
|
||||
<li>current</li>
|
||||
<li>debug</li>
|
||||
<li>deferred</li>
|
||||
<li>do</li>
|
||||
<li>else</li>
|
||||
<li>elseif</li>
|
||||
<li>end</li>
|
||||
<li>ensure</li>
|
||||
<li>expanded</li>
|
||||
<li>export</li>
|
||||
<li>external</li>
|
||||
<li>false</li>
|
||||
<li>feature</li>
|
||||
<li>from</li>
|
||||
<li>frozen</li>
|
||||
<li>if</li>
|
||||
<li>implies</li>
|
||||
<li>inherit</li>
|
||||
<li>inspect</li>
|
||||
<li>invariant</li>
|
||||
<li>like</li>
|
||||
<li>local</li>
|
||||
<li>loop</li>
|
||||
<li>not</li>
|
||||
<li>note</li>
|
||||
<li>obsolete</li>
|
||||
<li>local</li>
|
||||
<li>result</li>
|
||||
<li>across</li>
|
||||
<li>redefine</li>
|
||||
<li>tuple</li>
|
||||
<li>current</li>
|
||||
<li>expanded</li>
|
||||
<li>not</li>
|
||||
<li>feature</li>
|
||||
<li>and</li>
|
||||
<li>alias</li>
|
||||
<li>end</li>
|
||||
<li>xor</li>
|
||||
<li>attribute</li>
|
||||
<li>class</li>
|
||||
<li>rescue</li>
|
||||
<li>retry</li>
|
||||
<li>debug</li>
|
||||
<li>old</li>
|
||||
<li>once</li>
|
||||
<li>only</li>
|
||||
<li>or</li>
|
||||
<li>false</li>
|
||||
<li>precursor</li>
|
||||
<li>redefine</li>
|
||||
<li>rename</li>
|
||||
<li>inherit</li>
|
||||
<li>require</li>
|
||||
<li>rescue</li>
|
||||
<li>result</li>
|
||||
<li>retry</li>
|
||||
<li>select</li>
|
||||
<li>separate</li>
|
||||
<li>then</li>
|
||||
<li>true</li>
|
||||
<li>tuple</li>
|
||||
<li>undefine</li>
|
||||
<li>until</li>
|
||||
<li>implies</li>
|
||||
<li>assign</li>
|
||||
<li>variant</li>
|
||||
<li>void</li>
|
||||
<li>when</li>
|
||||
<li>xor</li>
|
||||
</ul>
|
||||
|
||||
@ -5,35 +5,35 @@ sidebar_label: elixir
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|invokerPackage|The main namespace to use for all classes. e.g. Yay.Pets| |null|
|
||||
|licenseHeader|The license header to prepend to the top of all source files.| |null|
|
||||
|packageName|Elixir package name (convention: lowercase).| |null|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|Set|java.util.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|HashMap|java.util.HashMap|
|
||||
|Array|java.util.List|
|
||||
|ArrayList|java.util.ArrayList|
|
||||
|URI|java.net.URI|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|BigDecimal|java.math.BigDecimal|
|
||||
|Date|java.util.Date|
|
||||
|DateTime|org.joda.time.*|
|
||||
|Array|java.util.List|
|
||||
|List|java.util.*|
|
||||
|UUID|java.util.UUID|
|
||||
|File|java.io.File|
|
||||
|HashMap|java.util.HashMap|
|
||||
|List|java.util.*|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|Map|java.util.Map|
|
||||
|Set|java.util.*|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|URI|java.net.URI|
|
||||
|UUID|java.util.UUID|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
@ -44,26 +44,26 @@ sidebar_label: elixir
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>Integer</li>
|
||||
<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>Atom</li>
|
||||
<li>Boolean</li>
|
||||
<li>DateTime</li>
|
||||
<li>Float</li>
|
||||
<li>Integer</li>
|
||||
<li>List</li>
|
||||
<li>Map</li>
|
||||
<li>PID</li>
|
||||
<li>String</li>
|
||||
<li>Boolean</li>
|
||||
<li>Map</li>
|
||||
<li>Atom</li>
|
||||
<li>Tuple</li>
|
||||
<li>DateTime</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>nil</li>
|
||||
<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>__CALLER__</li>
|
||||
<li>__DIR__</li>
|
||||
<li>__ENV__</li>
|
||||
<li>__CALLER__</li>
|
||||
<li>__FILE__</li>
|
||||
<li>true</li>
|
||||
<li>false</li>
|
||||
<li>__MODULE__</li>
|
||||
<li>false</li>
|
||||
<li>nil</li>
|
||||
<li>true</li>
|
||||
</ul>
|
||||
|
||||
@ -5,10 +5,10 @@ sidebar_label: elm
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|elmVersion|Elm version: 0.18, 0.19|<dl><dt>**0.19**</dt><dd>Elm 0.19</dd><dt>**0.18**</dt><dd>Elm 0.18</dd><dl>|0.19|
|
||||
|elmPrefixCustomTypeVariants|Prefix custom type variants| |false|
|
||||
|elmEnableCustomBasePaths|Enable setting the base path for each request| |false|
|
||||
|elmEnableHttpRequestTrackers|Enable adding a tracker to each http request| |false|
|
||||
|elmPrefixCustomTypeVariants|Prefix custom type variants| |false|
|
||||
|elmVersion|Elm version: 0.18, 0.19|<dl><dt>**0.19**</dt><dd>Elm 0.19</dd><dt>**0.18**</dt><dd>Elm 0.18</dd><dl>|0.19|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
@ -26,28 +26,28 @@ sidebar_label: elm
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>Float</li>
|
||||
<li>Bool</li>
|
||||
<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>Bool</li>
|
||||
<li>Dict</li>
|
||||
<li>Float</li>
|
||||
<li>Int</li>
|
||||
<li>List</li>
|
||||
<li>String</li>
|
||||
<li>Int</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>import</li>
|
||||
<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>as</li>
|
||||
<li>case</li>
|
||||
<li>else</li>
|
||||
<li>exposing</li>
|
||||
<li>if</li>
|
||||
<li>import</li>
|
||||
<li>in</li>
|
||||
<li>let</li>
|
||||
<li>module</li>
|
||||
<li>of</li>
|
||||
<li>port</li>
|
||||
<li>then</li>
|
||||
<li>type</li>
|
||||
<li>exposing</li>
|
||||
<li>as</li>
|
||||
<li>port</li>
|
||||
<li>else</li>
|
||||
<li>of</li>
|
||||
<li>let</li>
|
||||
<li>where</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
</ul>
|
||||
|
||||
@ -6,28 +6,28 @@ sidebar_label: erlang-client
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|packageName|Erlang application name (convention: lowercase).| |openapi|
|
||||
|packageName|Erlang application version| |1.0.0|
|
||||
|packageVersion|Erlang application version| |1.0.0|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|Set|java.util.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|HashMap|java.util.HashMap|
|
||||
|Array|java.util.List|
|
||||
|ArrayList|java.util.ArrayList|
|
||||
|URI|java.net.URI|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|BigDecimal|java.math.BigDecimal|
|
||||
|Date|java.util.Date|
|
||||
|DateTime|org.joda.time.*|
|
||||
|Array|java.util.List|
|
||||
|List|java.util.*|
|
||||
|UUID|java.util.UUID|
|
||||
|File|java.io.File|
|
||||
|HashMap|java.util.HashMap|
|
||||
|List|java.util.*|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|Map|java.util.Map|
|
||||
|Set|java.util.*|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|URI|java.net.URI|
|
||||
|UUID|java.util.UUID|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
@ -42,31 +42,31 @@ sidebar_label: erlang-client
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>bsr</li>
|
||||
<li>orelse</li>
|
||||
<li>bor</li>
|
||||
<li>cond</li>
|
||||
<li>when</li>
|
||||
<li>div</li>
|
||||
<li>not</li>
|
||||
<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>after</li>
|
||||
<li>and</li>
|
||||
<li>bxor</li>
|
||||
<li>of</li>
|
||||
<li>end</li>
|
||||
<li>let</li>
|
||||
<li>xor</li>
|
||||
<li>after</li>
|
||||
<li>band</li>
|
||||
<li>catch</li>
|
||||
<li>rem</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>bnot</li>
|
||||
<li>receive</li>
|
||||
<li>or</li>
|
||||
<li>bsl</li>
|
||||
<li>try</li>
|
||||
<li>begin</li>
|
||||
<li>andalso</li>
|
||||
<li>band</li>
|
||||
<li>begin</li>
|
||||
<li>bnot</li>
|
||||
<li>bor</li>
|
||||
<li>bsl</li>
|
||||
<li>bsr</li>
|
||||
<li>bxor</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>cond</li>
|
||||
<li>div</li>
|
||||
<li>end</li>
|
||||
<li>fun</li>
|
||||
<li>if</li>
|
||||
<li>let</li>
|
||||
<li>not</li>
|
||||
<li>of</li>
|
||||
<li>or</li>
|
||||
<li>orelse</li>
|
||||
<li>receive</li>
|
||||
<li>rem</li>
|
||||
<li>try</li>
|
||||
<li>when</li>
|
||||
<li>xor</li>
|
||||
</ul>
|
||||
|
||||
@ -6,28 +6,28 @@ sidebar_label: erlang-proper
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|packageName|Erlang application name (convention: lowercase).| |openapi|
|
||||
|packageName|Erlang application version| |1.0.0|
|
||||
|packageVersion|Erlang application version| |1.0.0|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|Set|java.util.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|HashMap|java.util.HashMap|
|
||||
|Array|java.util.List|
|
||||
|ArrayList|java.util.ArrayList|
|
||||
|URI|java.net.URI|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|BigDecimal|java.math.BigDecimal|
|
||||
|Date|java.util.Date|
|
||||
|DateTime|org.joda.time.*|
|
||||
|Array|java.util.List|
|
||||
|List|java.util.*|
|
||||
|UUID|java.util.UUID|
|
||||
|File|java.io.File|
|
||||
|HashMap|java.util.HashMap|
|
||||
|List|java.util.*|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|Map|java.util.Map|
|
||||
|Set|java.util.*|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|URI|java.net.URI|
|
||||
|UUID|java.util.UUID|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
@ -42,31 +42,31 @@ sidebar_label: erlang-proper
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>bsr</li>
|
||||
<li>orelse</li>
|
||||
<li>bor</li>
|
||||
<li>cond</li>
|
||||
<li>when</li>
|
||||
<li>div</li>
|
||||
<li>not</li>
|
||||
<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>after</li>
|
||||
<li>and</li>
|
||||
<li>bxor</li>
|
||||
<li>of</li>
|
||||
<li>end</li>
|
||||
<li>let</li>
|
||||
<li>xor</li>
|
||||
<li>after</li>
|
||||
<li>band</li>
|
||||
<li>catch</li>
|
||||
<li>rem</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>bnot</li>
|
||||
<li>receive</li>
|
||||
<li>or</li>
|
||||
<li>bsl</li>
|
||||
<li>try</li>
|
||||
<li>begin</li>
|
||||
<li>andalso</li>
|
||||
<li>band</li>
|
||||
<li>begin</li>
|
||||
<li>bnot</li>
|
||||
<li>bor</li>
|
||||
<li>bsl</li>
|
||||
<li>bsr</li>
|
||||
<li>bxor</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>cond</li>
|
||||
<li>div</li>
|
||||
<li>end</li>
|
||||
<li>fun</li>
|
||||
<li>if</li>
|
||||
<li>let</li>
|
||||
<li>not</li>
|
||||
<li>of</li>
|
||||
<li>or</li>
|
||||
<li>orelse</li>
|
||||
<li>receive</li>
|
||||
<li>rem</li>
|
||||
<li>try</li>
|
||||
<li>when</li>
|
||||
<li>xor</li>
|
||||
</ul>
|
||||
|
||||
@ -5,29 +5,29 @@ sidebar_label: erlang-server
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|packageName|Erlang package name (convention: lowercase).| |openapi|
|
||||
|openAPISpecName|Openapi Spec Name.| |openapi|
|
||||
|packageName|Erlang package name (convention: lowercase).| |openapi|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|Set|java.util.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|HashMap|java.util.HashMap|
|
||||
|Array|java.util.List|
|
||||
|ArrayList|java.util.ArrayList|
|
||||
|URI|java.net.URI|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|BigDecimal|java.math.BigDecimal|
|
||||
|Date|java.util.Date|
|
||||
|DateTime|org.joda.time.*|
|
||||
|Array|java.util.List|
|
||||
|List|java.util.*|
|
||||
|UUID|java.util.UUID|
|
||||
|File|java.io.File|
|
||||
|HashMap|java.util.HashMap|
|
||||
|List|java.util.*|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|Map|java.util.Map|
|
||||
|Set|java.util.*|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|URI|java.net.URI|
|
||||
|UUID|java.util.UUID|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
@ -42,31 +42,31 @@ sidebar_label: erlang-server
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>bsr</li>
|
||||
<li>orelse</li>
|
||||
<li>bor</li>
|
||||
<li>cond</li>
|
||||
<li>when</li>
|
||||
<li>div</li>
|
||||
<li>not</li>
|
||||
<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>after</li>
|
||||
<li>and</li>
|
||||
<li>bxor</li>
|
||||
<li>of</li>
|
||||
<li>end</li>
|
||||
<li>let</li>
|
||||
<li>xor</li>
|
||||
<li>after</li>
|
||||
<li>band</li>
|
||||
<li>catch</li>
|
||||
<li>rem</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>bnot</li>
|
||||
<li>receive</li>
|
||||
<li>or</li>
|
||||
<li>bsl</li>
|
||||
<li>try</li>
|
||||
<li>begin</li>
|
||||
<li>andalso</li>
|
||||
<li>band</li>
|
||||
<li>begin</li>
|
||||
<li>bnot</li>
|
||||
<li>bor</li>
|
||||
<li>bsl</li>
|
||||
<li>bsr</li>
|
||||
<li>bxor</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>cond</li>
|
||||
<li>div</li>
|
||||
<li>end</li>
|
||||
<li>fun</li>
|
||||
<li>if</li>
|
||||
<li>let</li>
|
||||
<li>not</li>
|
||||
<li>of</li>
|
||||
<li>or</li>
|
||||
<li>orelse</li>
|
||||
<li>receive</li>
|
||||
<li>rem</li>
|
||||
<li>try</li>
|
||||
<li>when</li>
|
||||
<li>xor</li>
|
||||
</ul>
|
||||
|
||||
@ -5,9 +5,9 @@ sidebar_label: flash
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|invokerPackage|root package for generated code| |null|
|
||||
|packageName|flash package name (convention: package.name)| |org.openapitools|
|
||||
|packageVersion|flash package version| |1.0.0|
|
||||
|invokerPackage|root package for generated code| |null|
|
||||
|sourceFolder|source folder for generated code. e.g. flash| |null|
|
||||
|
||||
## IMPORT MAPPING
|
||||
@ -26,44 +26,44 @@ sidebar_label: flash
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>Array</li>
|
||||
<li>Boolean</li>
|
||||
<li>Date</li>
|
||||
<li>Dictionary</li>
|
||||
<li>Number</li>
|
||||
<li>String</li>
|
||||
<li>Boolean</li>
|
||||
<li>Date</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>for</li>
|
||||
<li>lt</li>
|
||||
<li>onclipevent</li>
|
||||
<li>do</li>
|
||||
<li>while</li>
|
||||
<li>delete</li>
|
||||
<li>not</li>
|
||||
<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>add</li>
|
||||
<li>and</li>
|
||||
<li>continue</li>
|
||||
<li>else</li>
|
||||
<li>function</li>
|
||||
<li>if</li>
|
||||
<li>ge</li>
|
||||
<li>typeof</li>
|
||||
<li>on</li>
|
||||
<li>add</li>
|
||||
<li>new</li>
|
||||
<li>void</li>
|
||||
<li>or</li>
|
||||
<li>ifframeloaded</li>
|
||||
<li>break</li>
|
||||
<li>continue</li>
|
||||
<li>delete</li>
|
||||
<li>do</li>
|
||||
<li>else</li>
|
||||
<li>eq</li>
|
||||
<li>for</li>
|
||||
<li>function</li>
|
||||
<li>ge</li>
|
||||
<li>gt</li>
|
||||
<li>if</li>
|
||||
<li>ifframeloaded</li>
|
||||
<li>in</li>
|
||||
<li>var</li>
|
||||
<li>le</li>
|
||||
<li>lt</li>
|
||||
<li>ne</li>
|
||||
<li>new</li>
|
||||
<li>not</li>
|
||||
<li>on</li>
|
||||
<li>onclipevent</li>
|
||||
<li>or</li>
|
||||
<li>return</li>
|
||||
<li>telltarget</li>
|
||||
<li>this</li>
|
||||
<li>eq</li>
|
||||
<li>gt</li>
|
||||
<li>typeof</li>
|
||||
<li>var</li>
|
||||
<li>void</li>
|
||||
<li>while</li>
|
||||
<li>with</li>
|
||||
<li>ne</li>
|
||||
<li>le</li>
|
||||
<li>return</li>
|
||||
</ul>
|
||||
|
||||
@ -5,19 +5,19 @@ sidebar_label: fsharp-functions
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|licenseUrl|The URL of the license| |http://localhost|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|licenseName|The name of the license| |NoLicense|
|
||||
|packageCopyright|Specifies an AssemblyCopyright for the .NET Framework global assembly attributes stored in the AssemblyInfo file.| |No Copyright|
|
||||
|licenseUrl|The URL of the license| |http://localhost|
|
||||
|packageAuthors|Specifies Authors property in the .NET Core project file.| |OpenAPI|
|
||||
|packageTitle|Specifies an AssemblyTitle for the .NET Framework global assembly attributes stored in the AssemblyInfo file.| |OpenAPI Library|
|
||||
|packageName|F# module name (convention: Title.Case).| |OpenAPI|
|
||||
|packageVersion|F# package version.| |1.0.0|
|
||||
|packageCopyright|Specifies an AssemblyCopyright for the .NET Framework global assembly attributes stored in the AssemblyInfo file.| |No Copyright|
|
||||
|packageGuid|The GUID that will be associated with the C# project| |null|
|
||||
|packageName|F# module name (convention: Title.Case).| |OpenAPI|
|
||||
|packageTitle|Specifies an AssemblyTitle for the .NET Framework global assembly attributes stored in the AssemblyInfo file.| |OpenAPI Library|
|
||||
|packageVersion|F# package version.| |1.0.0|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sourceFolder|source folder for generated code| |OpenAPI/src|
|
||||
|
||||
## IMPORT MAPPING
|
||||
@ -38,150 +38,150 @@ sidebar_label: fsharp-functions
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>Dictionary</li>
|
||||
<li>string</li>
|
||||
<li>bool</li>
|
||||
<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>Collection</li>
|
||||
<li>DataTimeOffset</li>
|
||||
<li>DateTime</li>
|
||||
<li>Dictionary</li>
|
||||
<li>Double</li>
|
||||
<li>ICollection</li>
|
||||
<li>Int32</li>
|
||||
<li>Int64</li>
|
||||
<li>List</li>
|
||||
<li>String</li>
|
||||
<li>System.IO.Stream</li>
|
||||
<li>float</li>
|
||||
<li>DateTime</li>
|
||||
<li>int64</li>
|
||||
<li>Int32</li>
|
||||
<li>DataTimeOffset</li>
|
||||
<li>bool</li>
|
||||
<li>byte[]</li>
|
||||
<li>char</li>
|
||||
<li>decimal</li>
|
||||
<li>dict</li>
|
||||
<li>List</li>
|
||||
<li>unativeint</li>
|
||||
<li>uint32</li>
|
||||
<li>uint16</li>
|
||||
<li>seq</li>
|
||||
<li>nativeint</li>
|
||||
<li>double</li>
|
||||
<li>float</li>
|
||||
<li>float32</li>
|
||||
<li>list</li>
|
||||
<li>Double</li>
|
||||
<li>int</li>
|
||||
<li>int16</li>
|
||||
<li>byte[]</li>
|
||||
<li>single</li>
|
||||
<li>Int64</li>
|
||||
<li>int64</li>
|
||||
<li>list</li>
|
||||
<li>nativeint</li>
|
||||
<li>obj</li>
|
||||
<li>char</li>
|
||||
<li>ICollection</li>
|
||||
<li>Collection</li>
|
||||
<li>seq</li>
|
||||
<li>single</li>
|
||||
<li>string</li>
|
||||
<li>uint16</li>
|
||||
<li>uint32</li>
|
||||
<li>uint64</li>
|
||||
<li>decimal</li>
|
||||
<li>unativeint</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>exception</li>
|
||||
<li>struct</li>
|
||||
<li>select</li>
|
||||
<li>type</li>
|
||||
<li>when</li>
|
||||
<li>localVarQueryParams</li>
|
||||
<li>else</li>
|
||||
<li>mutable</li>
|
||||
<li>lock</li>
|
||||
<li>let</li>
|
||||
<li>localVarPathParams</li>
|
||||
<li>catch</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>val</li>
|
||||
<li>localVarHttpHeaderAccepts</li>
|
||||
<li>localVarPostBody</li>
|
||||
<li>in</li>
|
||||
<li>byte</li>
|
||||
<li>double</li>
|
||||
<li>module</li>
|
||||
<li>is</li>
|
||||
<li>elif</li>
|
||||
<li>then</li>
|
||||
<li>params</li>
|
||||
<li>enum</li>
|
||||
<li>explicit</li>
|
||||
<li>as</li>
|
||||
<li>begin</li>
|
||||
<li>internal</li>
|
||||
<li>yield!</li>
|
||||
<li>lazy</li>
|
||||
<li>localVarHttpHeaderAccept</li>
|
||||
<li>use!</li>
|
||||
<li>delegate</li>
|
||||
<li>default</li>
|
||||
<li>localVarHttpContentTypes</li>
|
||||
<li>localVarHttpContentType</li>
|
||||
<li>let!</li>
|
||||
<li>assert</li>
|
||||
<li>yield</li>
|
||||
<li>member</li>
|
||||
<li>override</li>
|
||||
<li>event</li>
|
||||
<li>break</li>
|
||||
<li>downto</li>
|
||||
<li>abstract</li>
|
||||
<li>match!</li>
|
||||
<li>char</li>
|
||||
<li>localVarFileParams</li>
|
||||
<li>to</li>
|
||||
<li>fun</li>
|
||||
<li>open</li>
|
||||
<li>return</li>
|
||||
<li>use</li>
|
||||
<li>return!</li>
|
||||
<li>extern</li>
|
||||
<li>do</li>
|
||||
<li>float</li>
|
||||
<li>while</li>
|
||||
<li>rec</li>
|
||||
<li>continue</li>
|
||||
<li>function</li>
|
||||
<li>raise</li>
|
||||
<li>checked</li>
|
||||
<li>dynamic</li>
|
||||
<li>new</li>
|
||||
<li>static</li>
|
||||
<li>void</li>
|
||||
<li>upcast</li>
|
||||
<li>localVarResponse</li>
|
||||
<li>sealed</li>
|
||||
<li>finally</li>
|
||||
<li>done</li>
|
||||
<li>null</li>
|
||||
<li>localVarPath</li>
|
||||
<li>true</li>
|
||||
<li>fixed</li>
|
||||
<li>try</li>
|
||||
<li>decimal</li>
|
||||
<li>option</li>
|
||||
<li>private</li>
|
||||
<li>bool</li>
|
||||
<li>const</li>
|
||||
<li>string</li>
|
||||
<li>for</li>
|
||||
<li>interface</li>
|
||||
<li>foreach</li>
|
||||
<li>not</li>
|
||||
<li>public</li>
|
||||
<li>localVarStatusCode</li>
|
||||
<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>abstract</li>
|
||||
<li>and</li>
|
||||
<li>of</li>
|
||||
<li>await</li>
|
||||
<li>end</li>
|
||||
<li>class</li>
|
||||
<li>localVarFormParams</li>
|
||||
<li>or</li>
|
||||
<li>false</li>
|
||||
<li>match</li>
|
||||
<li>volatile</li>
|
||||
<li>int</li>
|
||||
<li>as</li>
|
||||
<li>assert</li>
|
||||
<li>async</li>
|
||||
<li>with</li>
|
||||
<li>localVarHeaderParams</li>
|
||||
<li>inline</li>
|
||||
<li>downcast</li>
|
||||
<li>inherit</li>
|
||||
<li>namespace</li>
|
||||
<li>await</li>
|
||||
<li>base</li>
|
||||
<li>begin</li>
|
||||
<li>bool</li>
|
||||
<li>break</li>
|
||||
<li>byte</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>char</li>
|
||||
<li>checked</li>
|
||||
<li>class</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>decimal</li>
|
||||
<li>default</li>
|
||||
<li>delegate</li>
|
||||
<li>do</li>
|
||||
<li>done</li>
|
||||
<li>double</li>
|
||||
<li>downcast</li>
|
||||
<li>downto</li>
|
||||
<li>dynamic</li>
|
||||
<li>elif</li>
|
||||
<li>else</li>
|
||||
<li>end</li>
|
||||
<li>enum</li>
|
||||
<li>event</li>
|
||||
<li>exception</li>
|
||||
<li>explicit</li>
|
||||
<li>extern</li>
|
||||
<li>false</li>
|
||||
<li>finally</li>
|
||||
<li>fixed</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>foreach</li>
|
||||
<li>fun</li>
|
||||
<li>function</li>
|
||||
<li>if</li>
|
||||
<li>in</li>
|
||||
<li>inherit</li>
|
||||
<li>inline</li>
|
||||
<li>int</li>
|
||||
<li>interface</li>
|
||||
<li>internal</li>
|
||||
<li>is</li>
|
||||
<li>lazy</li>
|
||||
<li>let</li>
|
||||
<li>let!</li>
|
||||
<li>localVarFileParams</li>
|
||||
<li>localVarFormParams</li>
|
||||
<li>localVarHeaderParams</li>
|
||||
<li>localVarHttpContentType</li>
|
||||
<li>localVarHttpContentTypes</li>
|
||||
<li>localVarHttpHeaderAccept</li>
|
||||
<li>localVarHttpHeaderAccepts</li>
|
||||
<li>localVarPath</li>
|
||||
<li>localVarPathParams</li>
|
||||
<li>localVarPostBody</li>
|
||||
<li>localVarQueryParams</li>
|
||||
<li>localVarResponse</li>
|
||||
<li>localVarStatusCode</li>
|
||||
<li>lock</li>
|
||||
<li>match</li>
|
||||
<li>match!</li>
|
||||
<li>member</li>
|
||||
<li>module</li>
|
||||
<li>mutable</li>
|
||||
<li>namespace</li>
|
||||
<li>new</li>
|
||||
<li>not</li>
|
||||
<li>null</li>
|
||||
<li>of</li>
|
||||
<li>open</li>
|
||||
<li>option</li>
|
||||
<li>or</li>
|
||||
<li>override</li>
|
||||
<li>params</li>
|
||||
<li>private</li>
|
||||
<li>public</li>
|
||||
<li>raise</li>
|
||||
<li>rec</li>
|
||||
<li>return</li>
|
||||
<li>return!</li>
|
||||
<li>sealed</li>
|
||||
<li>select</li>
|
||||
<li>static</li>
|
||||
<li>string</li>
|
||||
<li>struct</li>
|
||||
<li>then</li>
|
||||
<li>to</li>
|
||||
<li>true</li>
|
||||
<li>try</li>
|
||||
<li>type</li>
|
||||
<li>upcast</li>
|
||||
<li>use</li>
|
||||
<li>use!</li>
|
||||
<li>val</li>
|
||||
<li>void</li>
|
||||
<li>volatile</li>
|
||||
<li>when</li>
|
||||
<li>while</li>
|
||||
<li>with</li>
|
||||
<li>yield</li>
|
||||
<li>yield!</li>
|
||||
</ul>
|
||||
|
||||
@ -5,22 +5,22 @@ sidebar_label: fsharp-giraffe-server
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|licenseUrl|The URL of the license| |http://localhost|
|
||||
|licenseName|The name of the license| |NoLicense|
|
||||
|packageCopyright|Specifies an AssemblyCopyright for the .NET Framework global assembly attributes stored in the AssemblyInfo file.| |No Copyright|
|
||||
|packageAuthors|Specifies Authors property in the .NET Core project file.| |OpenAPI|
|
||||
|packageTitle|Specifies an AssemblyTitle for the .NET Framework global assembly attributes stored in the AssemblyInfo file.| |OpenAPI Library|
|
||||
|packageName|F# module name (convention: Title.Case).| |OpenAPI|
|
||||
|packageVersion|F# package version.| |1.0.0|
|
||||
|packageGuid|The GUID that will be associated with the C# project| |null|
|
||||
|sourceFolder|source folder for generated code| |OpenAPI/src|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|useDateTimeOffset|Use DateTimeOffset to model date-time properties| |false|
|
||||
|useCollection|Deserialize array types to Collection<T> instead of List<T>.| |false|
|
||||
|returnICollection|Return ICollection<T> instead of the concrete type.| |false|
|
||||
|useSwashbuckle|Uses the Swashbuckle.AspNetCore NuGet package for documentation.| |false|
|
||||
|generateBody|Generates method body.| |true|
|
||||
|buildTarget|Target the build for a program or library.| |program|
|
||||
|generateBody|Generates method body.| |true|
|
||||
|licenseName|The name of the license| |NoLicense|
|
||||
|licenseUrl|The URL of the license| |http://localhost|
|
||||
|packageAuthors|Specifies Authors property in the .NET Core project file.| |OpenAPI|
|
||||
|packageCopyright|Specifies an AssemblyCopyright for the .NET Framework global assembly attributes stored in the AssemblyInfo file.| |No Copyright|
|
||||
|packageGuid|The GUID that will be associated with the C# project| |null|
|
||||
|packageName|F# module name (convention: Title.Case).| |OpenAPI|
|
||||
|packageTitle|Specifies an AssemblyTitle for the .NET Framework global assembly attributes stored in the AssemblyInfo file.| |OpenAPI Library|
|
||||
|packageVersion|F# package version.| |1.0.0|
|
||||
|returnICollection|Return ICollection<T> instead of the concrete type.| |false|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sourceFolder|source folder for generated code| |OpenAPI/src|
|
||||
|useCollection|Deserialize array types to Collection<T> instead of List<T>.| |false|
|
||||
|useDateTimeOffset|Use DateTimeOffset to model date-time properties| |false|
|
||||
|useSwashbuckle|Uses the Swashbuckle.AspNetCore NuGet package for documentation.| |false|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
@ -40,150 +40,150 @@ sidebar_label: fsharp-giraffe-server
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>Dictionary</li>
|
||||
<li>string</li>
|
||||
<li>bool</li>
|
||||
<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>Collection</li>
|
||||
<li>DataTimeOffset</li>
|
||||
<li>DateTime</li>
|
||||
<li>Dictionary</li>
|
||||
<li>Double</li>
|
||||
<li>ICollection</li>
|
||||
<li>Int32</li>
|
||||
<li>Int64</li>
|
||||
<li>List</li>
|
||||
<li>String</li>
|
||||
<li>System.IO.Stream</li>
|
||||
<li>float</li>
|
||||
<li>DateTime</li>
|
||||
<li>int64</li>
|
||||
<li>Int32</li>
|
||||
<li>DataTimeOffset</li>
|
||||
<li>bool</li>
|
||||
<li>byte[]</li>
|
||||
<li>char</li>
|
||||
<li>decimal</li>
|
||||
<li>dict</li>
|
||||
<li>List</li>
|
||||
<li>unativeint</li>
|
||||
<li>uint32</li>
|
||||
<li>uint16</li>
|
||||
<li>seq</li>
|
||||
<li>nativeint</li>
|
||||
<li>double</li>
|
||||
<li>float</li>
|
||||
<li>float32</li>
|
||||
<li>list</li>
|
||||
<li>Double</li>
|
||||
<li>int</li>
|
||||
<li>int16</li>
|
||||
<li>byte[]</li>
|
||||
<li>single</li>
|
||||
<li>Int64</li>
|
||||
<li>int64</li>
|
||||
<li>list</li>
|
||||
<li>nativeint</li>
|
||||
<li>obj</li>
|
||||
<li>char</li>
|
||||
<li>ICollection</li>
|
||||
<li>Collection</li>
|
||||
<li>seq</li>
|
||||
<li>single</li>
|
||||
<li>string</li>
|
||||
<li>uint16</li>
|
||||
<li>uint32</li>
|
||||
<li>uint64</li>
|
||||
<li>decimal</li>
|
||||
<li>unativeint</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>exception</li>
|
||||
<li>struct</li>
|
||||
<li>select</li>
|
||||
<li>type</li>
|
||||
<li>when</li>
|
||||
<li>localVarQueryParams</li>
|
||||
<li>else</li>
|
||||
<li>mutable</li>
|
||||
<li>lock</li>
|
||||
<li>let</li>
|
||||
<li>localVarPathParams</li>
|
||||
<li>catch</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>val</li>
|
||||
<li>localVarHttpHeaderAccepts</li>
|
||||
<li>localVarPostBody</li>
|
||||
<li>in</li>
|
||||
<li>byte</li>
|
||||
<li>double</li>
|
||||
<li>module</li>
|
||||
<li>is</li>
|
||||
<li>elif</li>
|
||||
<li>then</li>
|
||||
<li>params</li>
|
||||
<li>enum</li>
|
||||
<li>explicit</li>
|
||||
<li>as</li>
|
||||
<li>begin</li>
|
||||
<li>internal</li>
|
||||
<li>yield!</li>
|
||||
<li>lazy</li>
|
||||
<li>localVarHttpHeaderAccept</li>
|
||||
<li>use!</li>
|
||||
<li>delegate</li>
|
||||
<li>default</li>
|
||||
<li>localVarHttpContentTypes</li>
|
||||
<li>localVarHttpContentType</li>
|
||||
<li>let!</li>
|
||||
<li>assert</li>
|
||||
<li>yield</li>
|
||||
<li>member</li>
|
||||
<li>override</li>
|
||||
<li>event</li>
|
||||
<li>break</li>
|
||||
<li>downto</li>
|
||||
<li>abstract</li>
|
||||
<li>match!</li>
|
||||
<li>char</li>
|
||||
<li>localVarFileParams</li>
|
||||
<li>to</li>
|
||||
<li>fun</li>
|
||||
<li>open</li>
|
||||
<li>return</li>
|
||||
<li>use</li>
|
||||
<li>return!</li>
|
||||
<li>extern</li>
|
||||
<li>do</li>
|
||||
<li>float</li>
|
||||
<li>while</li>
|
||||
<li>rec</li>
|
||||
<li>continue</li>
|
||||
<li>function</li>
|
||||
<li>raise</li>
|
||||
<li>checked</li>
|
||||
<li>dynamic</li>
|
||||
<li>new</li>
|
||||
<li>static</li>
|
||||
<li>void</li>
|
||||
<li>upcast</li>
|
||||
<li>localVarResponse</li>
|
||||
<li>sealed</li>
|
||||
<li>finally</li>
|
||||
<li>done</li>
|
||||
<li>null</li>
|
||||
<li>localVarPath</li>
|
||||
<li>true</li>
|
||||
<li>fixed</li>
|
||||
<li>try</li>
|
||||
<li>decimal</li>
|
||||
<li>option</li>
|
||||
<li>private</li>
|
||||
<li>bool</li>
|
||||
<li>const</li>
|
||||
<li>string</li>
|
||||
<li>for</li>
|
||||
<li>interface</li>
|
||||
<li>foreach</li>
|
||||
<li>not</li>
|
||||
<li>public</li>
|
||||
<li>localVarStatusCode</li>
|
||||
<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>abstract</li>
|
||||
<li>and</li>
|
||||
<li>of</li>
|
||||
<li>await</li>
|
||||
<li>end</li>
|
||||
<li>class</li>
|
||||
<li>localVarFormParams</li>
|
||||
<li>or</li>
|
||||
<li>false</li>
|
||||
<li>match</li>
|
||||
<li>volatile</li>
|
||||
<li>int</li>
|
||||
<li>as</li>
|
||||
<li>assert</li>
|
||||
<li>async</li>
|
||||
<li>with</li>
|
||||
<li>localVarHeaderParams</li>
|
||||
<li>inline</li>
|
||||
<li>downcast</li>
|
||||
<li>inherit</li>
|
||||
<li>namespace</li>
|
||||
<li>await</li>
|
||||
<li>base</li>
|
||||
<li>begin</li>
|
||||
<li>bool</li>
|
||||
<li>break</li>
|
||||
<li>byte</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>char</li>
|
||||
<li>checked</li>
|
||||
<li>class</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>decimal</li>
|
||||
<li>default</li>
|
||||
<li>delegate</li>
|
||||
<li>do</li>
|
||||
<li>done</li>
|
||||
<li>double</li>
|
||||
<li>downcast</li>
|
||||
<li>downto</li>
|
||||
<li>dynamic</li>
|
||||
<li>elif</li>
|
||||
<li>else</li>
|
||||
<li>end</li>
|
||||
<li>enum</li>
|
||||
<li>event</li>
|
||||
<li>exception</li>
|
||||
<li>explicit</li>
|
||||
<li>extern</li>
|
||||
<li>false</li>
|
||||
<li>finally</li>
|
||||
<li>fixed</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>foreach</li>
|
||||
<li>fun</li>
|
||||
<li>function</li>
|
||||
<li>if</li>
|
||||
<li>in</li>
|
||||
<li>inherit</li>
|
||||
<li>inline</li>
|
||||
<li>int</li>
|
||||
<li>interface</li>
|
||||
<li>internal</li>
|
||||
<li>is</li>
|
||||
<li>lazy</li>
|
||||
<li>let</li>
|
||||
<li>let!</li>
|
||||
<li>localVarFileParams</li>
|
||||
<li>localVarFormParams</li>
|
||||
<li>localVarHeaderParams</li>
|
||||
<li>localVarHttpContentType</li>
|
||||
<li>localVarHttpContentTypes</li>
|
||||
<li>localVarHttpHeaderAccept</li>
|
||||
<li>localVarHttpHeaderAccepts</li>
|
||||
<li>localVarPath</li>
|
||||
<li>localVarPathParams</li>
|
||||
<li>localVarPostBody</li>
|
||||
<li>localVarQueryParams</li>
|
||||
<li>localVarResponse</li>
|
||||
<li>localVarStatusCode</li>
|
||||
<li>lock</li>
|
||||
<li>match</li>
|
||||
<li>match!</li>
|
||||
<li>member</li>
|
||||
<li>module</li>
|
||||
<li>mutable</li>
|
||||
<li>namespace</li>
|
||||
<li>new</li>
|
||||
<li>not</li>
|
||||
<li>null</li>
|
||||
<li>of</li>
|
||||
<li>open</li>
|
||||
<li>option</li>
|
||||
<li>or</li>
|
||||
<li>override</li>
|
||||
<li>params</li>
|
||||
<li>private</li>
|
||||
<li>public</li>
|
||||
<li>raise</li>
|
||||
<li>rec</li>
|
||||
<li>return</li>
|
||||
<li>return!</li>
|
||||
<li>sealed</li>
|
||||
<li>select</li>
|
||||
<li>static</li>
|
||||
<li>string</li>
|
||||
<li>struct</li>
|
||||
<li>then</li>
|
||||
<li>to</li>
|
||||
<li>true</li>
|
||||
<li>try</li>
|
||||
<li>type</li>
|
||||
<li>upcast</li>
|
||||
<li>use</li>
|
||||
<li>use!</li>
|
||||
<li>val</li>
|
||||
<li>void</li>
|
||||
<li>volatile</li>
|
||||
<li>when</li>
|
||||
<li>while</li>
|
||||
<li>with</li>
|
||||
<li>yield</li>
|
||||
<li>yield!</li>
|
||||
</ul>
|
||||
|
||||
@ -1,25 +0,0 @@
|
||||
|
||||
---
|
||||
id: generator-opts-server-fsharp-giraffe
|
||||
title: Config Options for fsharp-giraffe
|
||||
sidebar_label: fsharp-giraffe
|
||||
---
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|licenseUrl|The URL of the license| |http://localhost|
|
||||
|licenseName|The name of the license| |NoLicense|
|
||||
|packageCopyright|Specifies an AssemblyCopyright for the .NET Framework global assembly attributes stored in the AssemblyInfo file.| |No Copyright|
|
||||
|packageAuthors|Specifies Authors property in the .NET Core project file.| |OpenAPI|
|
||||
|packageTitle|Specifies an AssemblyTitle for the .NET Framework global assembly attributes stored in the AssemblyInfo file.| |OpenAPI Library|
|
||||
|packageName|F# module name (convention: Title.Case).| |OpenAPI|
|
||||
|packageVersion|F# package version.| |1.0.0|
|
||||
|packageGuid|The GUID that will be associated with the C# project| |null|
|
||||
|sourceFolder|source folder for generated code| |OpenAPI/src|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|useDateTimeOffset|Use DateTimeOffset to model date-time properties| |false|
|
||||
|useCollection|Deserialize array types to Collection<T> instead of List<T>.| |false|
|
||||
|returnICollection|Return ICollection<T> instead of the concrete type.| |false|
|
||||
|useSwashbuckle|Uses the Swashbuckle.AspNetCore NuGet package for documentation.| |false|
|
||||
|generateBody|Generates method body.| |true|
|
||||
|buildTarget|Target the build for a program or library.| |program|
|
||||
@ -5,16 +5,16 @@ sidebar_label: go-experimental
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|packageName|Go package name (convention: lowercase).| |openapi|
|
||||
|packageVersion|Go package version.| |1.0.0|
|
||||
|enumClassPrefix|Prefix enum with class name| |false|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true|
|
||||
|isGoSubmodule|whether the generated Go module is a submodule| |false|
|
||||
|withGoCodegenComment|whether to include Go codegen comment to disable Go Lint and collapse by default GitHub in PRs and diffs| |false|
|
||||
|withXml|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)| |false|
|
||||
|enumClassPrefix|Prefix enum with class name| |false|
|
||||
|packageName|Go package name (convention: lowercase).| |openapi|
|
||||
|packageVersion|Go package version.| |1.0.0|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|structPrefix|whether to prefix struct with the class name. e.g. DeletePetOpts => PetApiDeletePetOpts| |false|
|
||||
|withAWSV4Signature|whether to include AWS v4 signature support| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|withGoCodegenComment|whether to include Go codegen comment to disable Go Lint and collapse by default GitHub in PRs and diffs| |false|
|
||||
|withXml|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)| |false|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
@ -30,68 +30,68 @@ sidebar_label: go-experimental
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>string</li>
|
||||
<li>bool</li>
|
||||
<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>bool</li>
|
||||
<li>byte</li>
|
||||
<li>complex128</li>
|
||||
<li>complex64</li>
|
||||
<li>float32</li>
|
||||
<li>float64</li>
|
||||
<li>uint</li>
|
||||
<li>int</li>
|
||||
<li>complex64</li>
|
||||
<li>rune</li>
|
||||
<li>int32</li>
|
||||
<li>int64</li>
|
||||
<li>complex128</li>
|
||||
<li>uint64</li>
|
||||
<li>rune</li>
|
||||
<li>string</li>
|
||||
<li>uint</li>
|
||||
<li>uint32</li>
|
||||
<li>uint64</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>struct</li>
|
||||
<li>defer</li>
|
||||
<li>select</li>
|
||||
<li>string</li>
|
||||
<li>bool</li>
|
||||
<li>const</li>
|
||||
<li>import</li>
|
||||
<li>for</li>
|
||||
<li>range</li>
|
||||
<li>float64</li>
|
||||
<li>interface</li>
|
||||
<li>type</li>
|
||||
<li>error</li>
|
||||
<li>complex64</li>
|
||||
<li>rune</li>
|
||||
<li>switch</li>
|
||||
<li>nil</li>
|
||||
<li>default</li>
|
||||
<li>goto</li>
|
||||
<li>int64</li>
|
||||
<li>else</li>
|
||||
<li>continue</li>
|
||||
<li>int8</li>
|
||||
<li>uint32</li>
|
||||
<li>uint16</li>
|
||||
<li>map</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>package</li>
|
||||
<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>bool</li>
|
||||
<li>break</li>
|
||||
<li>byte</li>
|
||||
<li>var</li>
|
||||
<li>go</li>
|
||||
<li>case</li>
|
||||
<li>chan</li>
|
||||
<li>complex128</li>
|
||||
<li>complex64</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>default</li>
|
||||
<li>defer</li>
|
||||
<li>else</li>
|
||||
<li>error</li>
|
||||
<li>fallthrough</li>
|
||||
<li>float32</li>
|
||||
<li>uint</li>
|
||||
<li>float64</li>
|
||||
<li>for</li>
|
||||
<li>func</li>
|
||||
<li>go</li>
|
||||
<li>goto</li>
|
||||
<li>if</li>
|
||||
<li>import</li>
|
||||
<li>int</li>
|
||||
<li>int16</li>
|
||||
<li>func</li>
|
||||
<li>int32</li>
|
||||
<li>complex128</li>
|
||||
<li>int64</li>
|
||||
<li>int8</li>
|
||||
<li>interface</li>
|
||||
<li>map</li>
|
||||
<li>nil</li>
|
||||
<li>package</li>
|
||||
<li>range</li>
|
||||
<li>return</li>
|
||||
<li>rune</li>
|
||||
<li>select</li>
|
||||
<li>string</li>
|
||||
<li>struct</li>
|
||||
<li>switch</li>
|
||||
<li>type</li>
|
||||
<li>uint</li>
|
||||
<li>uint16</li>
|
||||
<li>uint32</li>
|
||||
<li>uint64</li>
|
||||
<li>uint8</li>
|
||||
<li>chan</li>
|
||||
<li>fallthrough</li>
|
||||
<li>uintptr</li>
|
||||
<li>return</li>
|
||||
<li>var</li>
|
||||
</ul>
|
||||
|
||||
@ -5,9 +5,9 @@ sidebar_label: go-gin-server
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true|
|
||||
|packageName|Go package name (convention: lowercase).| |openapi|
|
||||
|packageVersion|Go package version.| |1.0.0|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
@ -23,68 +23,68 @@ sidebar_label: go-gin-server
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>string</li>
|
||||
<li>bool</li>
|
||||
<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>bool</li>
|
||||
<li>byte</li>
|
||||
<li>complex128</li>
|
||||
<li>complex64</li>
|
||||
<li>float32</li>
|
||||
<li>float64</li>
|
||||
<li>uint</li>
|
||||
<li>int</li>
|
||||
<li>complex64</li>
|
||||
<li>rune</li>
|
||||
<li>int32</li>
|
||||
<li>int64</li>
|
||||
<li>complex128</li>
|
||||
<li>uint64</li>
|
||||
<li>rune</li>
|
||||
<li>string</li>
|
||||
<li>uint</li>
|
||||
<li>uint32</li>
|
||||
<li>uint64</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>struct</li>
|
||||
<li>defer</li>
|
||||
<li>select</li>
|
||||
<li>string</li>
|
||||
<li>bool</li>
|
||||
<li>const</li>
|
||||
<li>import</li>
|
||||
<li>for</li>
|
||||
<li>range</li>
|
||||
<li>float64</li>
|
||||
<li>interface</li>
|
||||
<li>type</li>
|
||||
<li>error</li>
|
||||
<li>complex64</li>
|
||||
<li>rune</li>
|
||||
<li>switch</li>
|
||||
<li>nil</li>
|
||||
<li>default</li>
|
||||
<li>goto</li>
|
||||
<li>int64</li>
|
||||
<li>else</li>
|
||||
<li>continue</li>
|
||||
<li>int8</li>
|
||||
<li>uint32</li>
|
||||
<li>uint16</li>
|
||||
<li>map</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>package</li>
|
||||
<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>bool</li>
|
||||
<li>break</li>
|
||||
<li>byte</li>
|
||||
<li>var</li>
|
||||
<li>go</li>
|
||||
<li>case</li>
|
||||
<li>chan</li>
|
||||
<li>complex128</li>
|
||||
<li>complex64</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>default</li>
|
||||
<li>defer</li>
|
||||
<li>else</li>
|
||||
<li>error</li>
|
||||
<li>fallthrough</li>
|
||||
<li>float32</li>
|
||||
<li>uint</li>
|
||||
<li>float64</li>
|
||||
<li>for</li>
|
||||
<li>func</li>
|
||||
<li>go</li>
|
||||
<li>goto</li>
|
||||
<li>if</li>
|
||||
<li>import</li>
|
||||
<li>int</li>
|
||||
<li>int16</li>
|
||||
<li>func</li>
|
||||
<li>int32</li>
|
||||
<li>complex128</li>
|
||||
<li>int64</li>
|
||||
<li>int8</li>
|
||||
<li>interface</li>
|
||||
<li>map</li>
|
||||
<li>nil</li>
|
||||
<li>package</li>
|
||||
<li>range</li>
|
||||
<li>return</li>
|
||||
<li>rune</li>
|
||||
<li>select</li>
|
||||
<li>string</li>
|
||||
<li>struct</li>
|
||||
<li>switch</li>
|
||||
<li>type</li>
|
||||
<li>uint</li>
|
||||
<li>uint16</li>
|
||||
<li>uint32</li>
|
||||
<li>uint64</li>
|
||||
<li>uint8</li>
|
||||
<li>chan</li>
|
||||
<li>fallthrough</li>
|
||||
<li>uintptr</li>
|
||||
<li>return</li>
|
||||
<li>var</li>
|
||||
</ul>
|
||||
|
||||
@ -5,12 +5,12 @@ sidebar_label: go-server
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|featureCORS|Enable Cross-Origin Resource Sharing middleware| |false|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true|
|
||||
|packageName|Go package name (convention: lowercase).| |openapi|
|
||||
|packageVersion|Go package version.| |1.0.0|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true|
|
||||
|sourceFolder|source folder for generated code| |go|
|
||||
|serverPort|The network port the generated server binds to| |8080|
|
||||
|featureCORS|Enable Cross-Origin Resource Sharing middleware| |false|
|
||||
|sourceFolder|source folder for generated code| |go|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
@ -26,68 +26,68 @@ sidebar_label: go-server
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>string</li>
|
||||
<li>bool</li>
|
||||
<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>bool</li>
|
||||
<li>byte</li>
|
||||
<li>complex128</li>
|
||||
<li>complex64</li>
|
||||
<li>float32</li>
|
||||
<li>float64</li>
|
||||
<li>uint</li>
|
||||
<li>int</li>
|
||||
<li>complex64</li>
|
||||
<li>rune</li>
|
||||
<li>int32</li>
|
||||
<li>int64</li>
|
||||
<li>complex128</li>
|
||||
<li>uint64</li>
|
||||
<li>rune</li>
|
||||
<li>string</li>
|
||||
<li>uint</li>
|
||||
<li>uint32</li>
|
||||
<li>uint64</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>struct</li>
|
||||
<li>defer</li>
|
||||
<li>select</li>
|
||||
<li>string</li>
|
||||
<li>bool</li>
|
||||
<li>const</li>
|
||||
<li>import</li>
|
||||
<li>for</li>
|
||||
<li>range</li>
|
||||
<li>float64</li>
|
||||
<li>interface</li>
|
||||
<li>type</li>
|
||||
<li>error</li>
|
||||
<li>complex64</li>
|
||||
<li>rune</li>
|
||||
<li>switch</li>
|
||||
<li>nil</li>
|
||||
<li>default</li>
|
||||
<li>goto</li>
|
||||
<li>int64</li>
|
||||
<li>else</li>
|
||||
<li>continue</li>
|
||||
<li>int8</li>
|
||||
<li>uint32</li>
|
||||
<li>uint16</li>
|
||||
<li>map</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>package</li>
|
||||
<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>bool</li>
|
||||
<li>break</li>
|
||||
<li>byte</li>
|
||||
<li>var</li>
|
||||
<li>go</li>
|
||||
<li>case</li>
|
||||
<li>chan</li>
|
||||
<li>complex128</li>
|
||||
<li>complex64</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>default</li>
|
||||
<li>defer</li>
|
||||
<li>else</li>
|
||||
<li>error</li>
|
||||
<li>fallthrough</li>
|
||||
<li>float32</li>
|
||||
<li>uint</li>
|
||||
<li>float64</li>
|
||||
<li>for</li>
|
||||
<li>func</li>
|
||||
<li>go</li>
|
||||
<li>goto</li>
|
||||
<li>if</li>
|
||||
<li>import</li>
|
||||
<li>int</li>
|
||||
<li>int16</li>
|
||||
<li>func</li>
|
||||
<li>int32</li>
|
||||
<li>complex128</li>
|
||||
<li>int64</li>
|
||||
<li>int8</li>
|
||||
<li>interface</li>
|
||||
<li>map</li>
|
||||
<li>nil</li>
|
||||
<li>package</li>
|
||||
<li>range</li>
|
||||
<li>return</li>
|
||||
<li>rune</li>
|
||||
<li>select</li>
|
||||
<li>string</li>
|
||||
<li>struct</li>
|
||||
<li>switch</li>
|
||||
<li>type</li>
|
||||
<li>uint</li>
|
||||
<li>uint16</li>
|
||||
<li>uint32</li>
|
||||
<li>uint64</li>
|
||||
<li>uint8</li>
|
||||
<li>chan</li>
|
||||
<li>fallthrough</li>
|
||||
<li>uintptr</li>
|
||||
<li>return</li>
|
||||
<li>var</li>
|
||||
</ul>
|
||||
|
||||
@ -5,16 +5,16 @@ sidebar_label: go
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|packageName|Go package name (convention: lowercase).| |openapi|
|
||||
|packageVersion|Go package version.| |1.0.0|
|
||||
|enumClassPrefix|Prefix enum with class name| |false|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true|
|
||||
|isGoSubmodule|whether the generated Go module is a submodule| |false|
|
||||
|withGoCodegenComment|whether to include Go codegen comment to disable Go Lint and collapse by default GitHub in PRs and diffs| |false|
|
||||
|withXml|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)| |false|
|
||||
|enumClassPrefix|Prefix enum with class name| |false|
|
||||
|packageName|Go package name (convention: lowercase).| |openapi|
|
||||
|packageVersion|Go package version.| |1.0.0|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|structPrefix|whether to prefix struct with the class name. e.g. DeletePetOpts => PetApiDeletePetOpts| |false|
|
||||
|withAWSV4Signature|whether to include AWS v4 signature support| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|withGoCodegenComment|whether to include Go codegen comment to disable Go Lint and collapse by default GitHub in PRs and diffs| |false|
|
||||
|withXml|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)| |false|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
@ -30,68 +30,68 @@ sidebar_label: go
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>string</li>
|
||||
<li>bool</li>
|
||||
<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>bool</li>
|
||||
<li>byte</li>
|
||||
<li>complex128</li>
|
||||
<li>complex64</li>
|
||||
<li>float32</li>
|
||||
<li>float64</li>
|
||||
<li>uint</li>
|
||||
<li>int</li>
|
||||
<li>complex64</li>
|
||||
<li>rune</li>
|
||||
<li>int32</li>
|
||||
<li>int64</li>
|
||||
<li>complex128</li>
|
||||
<li>uint64</li>
|
||||
<li>rune</li>
|
||||
<li>string</li>
|
||||
<li>uint</li>
|
||||
<li>uint32</li>
|
||||
<li>uint64</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>struct</li>
|
||||
<li>defer</li>
|
||||
<li>select</li>
|
||||
<li>string</li>
|
||||
<li>bool</li>
|
||||
<li>const</li>
|
||||
<li>import</li>
|
||||
<li>for</li>
|
||||
<li>range</li>
|
||||
<li>float64</li>
|
||||
<li>interface</li>
|
||||
<li>type</li>
|
||||
<li>error</li>
|
||||
<li>complex64</li>
|
||||
<li>rune</li>
|
||||
<li>switch</li>
|
||||
<li>nil</li>
|
||||
<li>default</li>
|
||||
<li>goto</li>
|
||||
<li>int64</li>
|
||||
<li>else</li>
|
||||
<li>continue</li>
|
||||
<li>int8</li>
|
||||
<li>uint32</li>
|
||||
<li>uint16</li>
|
||||
<li>map</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>package</li>
|
||||
<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>bool</li>
|
||||
<li>break</li>
|
||||
<li>byte</li>
|
||||
<li>var</li>
|
||||
<li>go</li>
|
||||
<li>case</li>
|
||||
<li>chan</li>
|
||||
<li>complex128</li>
|
||||
<li>complex64</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>default</li>
|
||||
<li>defer</li>
|
||||
<li>else</li>
|
||||
<li>error</li>
|
||||
<li>fallthrough</li>
|
||||
<li>float32</li>
|
||||
<li>uint</li>
|
||||
<li>float64</li>
|
||||
<li>for</li>
|
||||
<li>func</li>
|
||||
<li>go</li>
|
||||
<li>goto</li>
|
||||
<li>if</li>
|
||||
<li>import</li>
|
||||
<li>int</li>
|
||||
<li>int16</li>
|
||||
<li>func</li>
|
||||
<li>int32</li>
|
||||
<li>complex128</li>
|
||||
<li>int64</li>
|
||||
<li>int8</li>
|
||||
<li>interface</li>
|
||||
<li>map</li>
|
||||
<li>nil</li>
|
||||
<li>package</li>
|
||||
<li>range</li>
|
||||
<li>return</li>
|
||||
<li>rune</li>
|
||||
<li>select</li>
|
||||
<li>string</li>
|
||||
<li>struct</li>
|
||||
<li>switch</li>
|
||||
<li>type</li>
|
||||
<li>uint</li>
|
||||
<li>uint16</li>
|
||||
<li>uint32</li>
|
||||
<li>uint64</li>
|
||||
<li>uint8</li>
|
||||
<li>chan</li>
|
||||
<li>fallthrough</li>
|
||||
<li>uintptr</li>
|
||||
<li>return</li>
|
||||
<li>var</li>
|
||||
</ul>
|
||||
|
||||
@ -5,30 +5,30 @@ sidebar_label: graphql-nodejs-express-server
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true|
|
||||
|packageName|GraphQL Node.js Express server package name (convention: lowercase).| |openapi3graphql-server|
|
||||
|packageVersion|GraphQL Node.js Express server package version.| |1.0.0|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|Set|java.util.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|HashMap|java.util.HashMap|
|
||||
|Array|java.util.List|
|
||||
|ArrayList|java.util.ArrayList|
|
||||
|URI|java.net.URI|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|BigDecimal|java.math.BigDecimal|
|
||||
|Date|java.util.Date|
|
||||
|DateTime|org.joda.time.*|
|
||||
|Array|java.util.List|
|
||||
|List|java.util.*|
|
||||
|UUID|java.util.UUID|
|
||||
|File|java.io.File|
|
||||
|HashMap|java.util.HashMap|
|
||||
|List|java.util.*|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|Map|java.util.Map|
|
||||
|Set|java.util.*|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|URI|java.net.URI|
|
||||
|UUID|java.util.UUID|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
@ -39,25 +39,25 @@ sidebar_label: graphql-nodejs-express-server
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>Float</li>
|
||||
<li>null</li>
|
||||
<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>Boolean</li>
|
||||
<li>Float</li>
|
||||
<li>ID</li>
|
||||
<li>String</li>
|
||||
<li>Boolean</li>
|
||||
<li>Int</li>
|
||||
<li>String</li>
|
||||
<li>null</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>implements</li>
|
||||
<li>boolean</li>
|
||||
<li>null</li>
|
||||
<li>string</li>
|
||||
<li>query</li>
|
||||
<li>id</li>
|
||||
<li>union</li>
|
||||
<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>boolean</li>
|
||||
<li>float</li>
|
||||
<li>type</li>
|
||||
<li>interface</li>
|
||||
<li>id</li>
|
||||
<li>implements</li>
|
||||
<li>int</li>
|
||||
<li>interface</li>
|
||||
<li>null</li>
|
||||
<li>query</li>
|
||||
<li>string</li>
|
||||
<li>type</li>
|
||||
<li>union</li>
|
||||
</ul>
|
||||
|
||||
@ -5,30 +5,30 @@ sidebar_label: graphql-schema
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true|
|
||||
|packageName|GraphQL package name (convention: lowercase).| |openapi2graphql|
|
||||
|packageVersion|GraphQL package version.| |1.0.0|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|Set|java.util.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|HashMap|java.util.HashMap|
|
||||
|Array|java.util.List|
|
||||
|ArrayList|java.util.ArrayList|
|
||||
|URI|java.net.URI|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|BigDecimal|java.math.BigDecimal|
|
||||
|Date|java.util.Date|
|
||||
|DateTime|org.joda.time.*|
|
||||
|Array|java.util.List|
|
||||
|List|java.util.*|
|
||||
|UUID|java.util.UUID|
|
||||
|File|java.io.File|
|
||||
|HashMap|java.util.HashMap|
|
||||
|List|java.util.*|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|Map|java.util.Map|
|
||||
|Set|java.util.*|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|URI|java.net.URI|
|
||||
|UUID|java.util.UUID|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
@ -39,25 +39,25 @@ sidebar_label: graphql-schema
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>Float</li>
|
||||
<li>null</li>
|
||||
<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>Boolean</li>
|
||||
<li>Float</li>
|
||||
<li>ID</li>
|
||||
<li>String</li>
|
||||
<li>Boolean</li>
|
||||
<li>Int</li>
|
||||
<li>String</li>
|
||||
<li>null</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>implements</li>
|
||||
<li>boolean</li>
|
||||
<li>null</li>
|
||||
<li>string</li>
|
||||
<li>query</li>
|
||||
<li>id</li>
|
||||
<li>union</li>
|
||||
<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>boolean</li>
|
||||
<li>float</li>
|
||||
<li>type</li>
|
||||
<li>interface</li>
|
||||
<li>id</li>
|
||||
<li>implements</li>
|
||||
<li>int</li>
|
||||
<li>interface</li>
|
||||
<li>null</li>
|
||||
<li>query</li>
|
||||
<li>string</li>
|
||||
<li>type</li>
|
||||
<li>union</li>
|
||||
</ul>
|
||||
|
||||
@ -1,12 +0,0 @@
|
||||
|
||||
---
|
||||
id: generator-opts-server-graphql-server
|
||||
title: Config Options for graphql-server
|
||||
sidebar_label: graphql-server
|
||||
---
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|packageName|GraphQL express server package name (convention: lowercase).| |openapi3graphql-server|
|
||||
|packageVersion|GraphQL express server package version.| |1.0.0|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true|
|
||||
@ -5,62 +5,62 @@ sidebar_label: groovy
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|modelPackage|package for generated models| |org.openapitools.model|
|
||||
|apiPackage|package for generated api classes| |org.openapitools.api|
|
||||
|invokerPackage|root package for generated code| |org.openapitools.api|
|
||||
|groupId|groupId in generated pom.xml| |org.openapitools|
|
||||
|artifactId|artifactId in generated pom.xml. This also becomes part of the generated library's filename| |openapi-groovy|
|
||||
|artifactVersion|artifact version in generated pom.xml. This also becomes part of the generated library's filename| |1.0.0|
|
||||
|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false|
|
||||
|booleanGetterPrefix|Set booleanGetterPrefix| |get|
|
||||
|dateLibrary|Option. Date library to use|<dl><dt>**joda**</dt><dd>Joda (for legacy app only)</dd><dt>**legacy**</dt><dd>Legacy java.util.Date (if you really have a good reason not to use threetenbp</dd><dt>**java8-localdatetime**</dt><dd>Java 8 using LocalDateTime (for legacy app only)</dd><dt>**java8**</dt><dd>Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true</dd><dt>**threetenbp**</dt><dd>Backport of JSR310 (preferred for jdk < 1.8)</dd><dl>|legacy|
|
||||
|developerEmail|developer email in generated pom.xml| |team@openapitools.org|
|
||||
|developerName|developer name in generated pom.xml| |OpenAPI-Generator Contributors|
|
||||
|developerOrganization|developer organization in generated pom.xml| |OpenAPITools.org|
|
||||
|developerOrganizationUrl|developer organization URL in generated pom.xml| |http://openapitools.org|
|
||||
|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false|
|
||||
|groupId|groupId in generated pom.xml| |org.openapitools|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |false|
|
||||
|invokerPackage|root package for generated code| |org.openapitools.api|
|
||||
|java8|Option. Use Java8 classes instead of third party equivalents|<dl><dt>**true**</dt><dd>Use Java 8 classes such as Base64</dd><dt>**false**</dt><dd>Various third party libraries as needed</dd><dl>|false|
|
||||
|licenseName|The name of the license| |Unlicense|
|
||||
|licenseUrl|The URL of the license| |http://unlicense.org|
|
||||
|modelPackage|package for generated models| |org.openapitools.model|
|
||||
|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|scmConnection|SCM connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git|
|
||||
|scmDeveloperConnection|SCM developer connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git|
|
||||
|scmUrl|SCM URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
|developerName|developer name in generated pom.xml| |OpenAPI-Generator Contributors|
|
||||
|developerEmail|developer email in generated pom.xml| |team@openapitools.org|
|
||||
|developerOrganization|developer organization in generated pom.xml| |OpenAPITools.org|
|
||||
|developerOrganizationUrl|developer organization URL in generated pom.xml| |http://openapitools.org|
|
||||
|licenseName|The name of the license| |Unlicense|
|
||||
|licenseUrl|The URL of the license| |http://unlicense.org|
|
||||
|sourceFolder|source folder for generated code| |src/main/groovy|
|
||||
|serializableModel|boolean - toggle "implements Serializable" for generated models| |false|
|
||||
|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false|
|
||||
|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |false|
|
||||
|withXml|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)| |false|
|
||||
|dateLibrary|Option. Date library to use|<dl><dt>**joda**</dt><dd>Joda (for legacy app only)</dd><dt>**legacy**</dt><dd>Legacy java.util.Date (if you really have a good reason not to use threetenbp</dd><dt>**java8-localdatetime**</dt><dd>Java 8 using LocalDateTime (for legacy app only)</dd><dt>**java8**</dt><dd>Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true</dd><dt>**threetenbp**</dt><dd>Backport of JSR310 (preferred for jdk < 1.8)</dd><dl>|legacy|
|
||||
|java8|Option. Use Java8 classes instead of third party equivalents|<dl><dt>**true**</dt><dd>Use Java 8 classes such as Base64</dd><dt>**false**</dt><dd>Various third party libraries as needed</dd><dl>|false|
|
||||
|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false|
|
||||
|booleanGetterPrefix|Set booleanGetterPrefix| |get|
|
||||
|additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null|
|
||||
|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|snapshotVersion|Uses a SNAPSHOT version.|<dl><dt>**true**</dt><dd>Use a SnapShot Version</dd><dt>**false**</dt><dd>Use a Release Version</dd><dl>|null|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sourceFolder|source folder for generated code| |src/main/groovy|
|
||||
|withXml|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)| |false|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|Set|java.util.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|HashMap|java.util.HashMap|
|
||||
|Array|java.util.List|
|
||||
|ArrayList|java.util.ArrayList|
|
||||
|URI|java.net.URI|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|BigDecimal|java.math.BigDecimal|
|
||||
|Date|java.util.Date|
|
||||
|DateTime|org.joda.time.*|
|
||||
|Array|java.util.List|
|
||||
|List|java.util.*|
|
||||
|UUID|java.util.UUID|
|
||||
|File|java.io.File|
|
||||
|HashMap|java.util.HashMap|
|
||||
|List|java.util.*|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|Map|java.util.Map|
|
||||
|Set|java.util.*|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|URI|java.net.URI|
|
||||
|UUID|java.util.UUID|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
@ -74,90 +74,90 @@ sidebar_label: groovy
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>ArrayList</li>
|
||||
<li>String</li>
|
||||
<li>Double</li>
|
||||
<li>Date</li>
|
||||
<li>Integer</li>
|
||||
<li>byte[]</li>
|
||||
<li>Float</li>
|
||||
<li>boolean</li>
|
||||
<li>Long</li>
|
||||
<li>Object</li>
|
||||
<li>Boolean</li>
|
||||
<li>Date</li>
|
||||
<li>Double</li>
|
||||
<li>File</li>
|
||||
<li>Float</li>
|
||||
<li>Integer</li>
|
||||
<li>Long</li>
|
||||
<li>Map</li>
|
||||
<li>Object</li>
|
||||
<li>String</li>
|
||||
<li>boolean</li>
|
||||
<li>byte[]</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>localvaraccepts</li>
|
||||
<li>synchronized</li>
|
||||
<li>do</li>
|
||||
<li>float</li>
|
||||
<li>while</li>
|
||||
<li>localvarpath</li>
|
||||
<li>protected</li>
|
||||
<li>continue</li>
|
||||
<li>else</li>
|
||||
<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>abstract</li>
|
||||
<li>apiclient</li>
|
||||
<li>localvarqueryparams</li>
|
||||
<li>catch</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>new</li>
|
||||
<li>package</li>
|
||||
<li>static</li>
|
||||
<li>void</li>
|
||||
<li>localvaraccept</li>
|
||||
<li>double</li>
|
||||
<li>apiexception</li>
|
||||
<li>apiresponse</li>
|
||||
<li>assert</li>
|
||||
<li>boolean</li>
|
||||
<li>break</li>
|
||||
<li>byte</li>
|
||||
<li>finally</li>
|
||||
<li>this</li>
|
||||
<li>strictfp</li>
|
||||
<li>throws</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>null</li>
|
||||
<li>transient</li>
|
||||
<li>apiexception</li>
|
||||
<li>final</li>
|
||||
<li>try</li>
|
||||
<li>object</li>
|
||||
<li>localvarcontenttypes</li>
|
||||
<li>implements</li>
|
||||
<li>private</li>
|
||||
<li>import</li>
|
||||
<li>const</li>
|
||||
<li>configuration</li>
|
||||
<li>finally</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>apiresponse</li>
|
||||
<li>interface</li>
|
||||
<li>long</li>
|
||||
<li>switch</li>
|
||||
<li>default</li>
|
||||
<li>goto</li>
|
||||
<li>public</li>
|
||||
<li>localvarheaderparams</li>
|
||||
<li>native</li>
|
||||
<li>localvarcontenttype</li>
|
||||
<li>assert</li>
|
||||
<li>stringutil</li>
|
||||
<li>class</li>
|
||||
<li>localvarcollectionqueryparams</li>
|
||||
<li>localvarcookieparams</li>
|
||||
<li>localreturntype</li>
|
||||
<li>localvarformparams</li>
|
||||
<li>break</li>
|
||||
<li>volatile</li>
|
||||
<li>localvarauthnames</li>
|
||||
<li>abstract</li>
|
||||
<li>int</li>
|
||||
<li>if</li>
|
||||
<li>implements</li>
|
||||
<li>import</li>
|
||||
<li>instanceof</li>
|
||||
<li>super</li>
|
||||
<li>boolean</li>
|
||||
<li>throw</li>
|
||||
<li>int</li>
|
||||
<li>interface</li>
|
||||
<li>localreturntype</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>char</li>
|
||||
<li>short</li>
|
||||
<li>localvarqueryparams</li>
|
||||
<li>long</li>
|
||||
<li>native</li>
|
||||
<li>new</li>
|
||||
<li>null</li>
|
||||
<li>object</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>
|
||||
|
||||
@ -1,9 +0,0 @@
|
||||
|
||||
---
|
||||
id: generator-opts-config-grpc-schema
|
||||
title: Config Options for grpc-schema
|
||||
sidebar_label: grpc-schema
|
||||
---
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
@ -5,32 +5,32 @@ sidebar_label: haskell-http-client
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|allowFromJsonNulls|allow JSON Null during model decoding from JSON| |true|
|
||||
|allowNonUniqueOperationIds|allow different API modules to contain the same operationId. Each API must be imported qualified| |false|
|
||||
|allowToJsonNulls|allow emitting JSON Null during model encoding to JSON| |false|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|baseModule|Set the base module namespace| |null|
|
||||
|cabalPackage|Set the cabal package name, which consists of one or more alphanumeric words separated by hyphens| |null|
|
||||
|cabalVersion|Set the cabal version number, consisting of a sequence of one or more integers separated by dots| |null|
|
||||
|baseModule|Set the base module namespace| |null|
|
||||
|requestType|Set the name of the type used to generate requests| |null|
|
||||
|configType|Set the name of the type used for configuration| |null|
|
||||
|allowFromJsonNulls|allow JSON Null during model decoding from JSON| |true|
|
||||
|allowToJsonNulls|allow emitting JSON Null during model encoding to JSON| |false|
|
||||
|allowNonUniqueOperationIds|allow different API modules to contain the same operationId. Each API must be imported qualified| |false|
|
||||
|generateLenses|Generate Lens optics for Models| |true|
|
||||
|generateModelConstructors|Generate smart constructors (only supply required fields) for models| |true|
|
||||
|generateEnums|Generate specific datatypes for OpenAPI enums| |true|
|
||||
|generateFormUrlEncodedInstances|Generate FromForm/ToForm instances for models that are used by operations that produce or consume application/x-www-form-urlencoded| |true|
|
||||
|inlineMimeTypes|Inline (hardcode) the content-type and accept parameters on operations, when there is only 1 option| |true|
|
||||
|modelDeriving|Additional classes to include in the deriving() clause of Models| |null|
|
||||
|strictFields|Add strictness annotations to all model fields| |true|
|
||||
|useKatip|Sets the default value for the UseKatip cabal flag. If true, the katip package provides logging instead of monad-logger| |true|
|
||||
|customTestInstanceModule|test module used to provide typeclass instances for types not known by the generator| |null|
|
||||
|dateFormat|format string used to parse/render a date| |%Y-%m-%d|
|
||||
|dateTimeFormat|format string used to parse/render a datetime| |null|
|
||||
|dateTimeParseFormat|overrides the format string used to parse a datetime| |null|
|
||||
|dateFormat|format string used to parse/render a date| |%Y-%m-%d|
|
||||
|customTestInstanceModule|test module used to provide typeclass instances for types not known by the generator| |null|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|generateEnums|Generate specific datatypes for OpenAPI enums| |true|
|
||||
|generateFormUrlEncodedInstances|Generate FromForm/ToForm instances for models that are used by operations that produce or consume application/x-www-form-urlencoded| |true|
|
||||
|generateLenses|Generate Lens optics for Models| |true|
|
||||
|generateModelConstructors|Generate smart constructors (only supply required fields) for models| |true|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true|
|
||||
|inlineMimeTypes|Inline (hardcode) the content-type and accept parameters on operations, when there is only 1 option| |true|
|
||||
|modelDeriving|Additional classes to include in the deriving() clause of Models| |null|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|requestType|Set the name of the type used to generate requests| |null|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|strictFields|Add strictness annotations to all model fields| |true|
|
||||
|useKatip|Sets the default value for the UseKatip cabal flag. If true, the katip package provides logging instead of monad-logger| |true|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
@ -46,52 +46,52 @@ sidebar_label: haskell-http-client
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>Integer</li>
|
||||
<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>Bool</li>
|
||||
<li>Char</li>
|
||||
<li>Double</li>
|
||||
<li>FilePath</li>
|
||||
<li>Float</li>
|
||||
<li>Bool</li>
|
||||
<li>Char</li>
|
||||
<li>List</li>
|
||||
<li>Text</li>
|
||||
<li>String</li>
|
||||
<li>Double</li>
|
||||
<li>Int</li>
|
||||
<li>Integer</li>
|
||||
<li>List</li>
|
||||
<li>String</li>
|
||||
<li>Text</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>qualified</li>
|
||||
<li>instance</li>
|
||||
<li>data</li>
|
||||
<li>import</li>
|
||||
<li>infixr</li>
|
||||
<li>do</li>
|
||||
<li>type</li>
|
||||
<li>pure</li>
|
||||
<li>foreign</li>
|
||||
<li>newtype</li>
|
||||
<li>hiding</li>
|
||||
<li>rec</li>
|
||||
<li>default</li>
|
||||
<li>else</li>
|
||||
<li>of</li>
|
||||
<li>let</li>
|
||||
<li>where</li>
|
||||
<li>class</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>proc</li>
|
||||
<li>in</li>
|
||||
<li>forall</li>
|
||||
<li>module</li>
|
||||
<li>then</li>
|
||||
<li>infix</li>
|
||||
<li>accept</li>
|
||||
<li>contenttype</li>
|
||||
<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>accept</li>
|
||||
<li>as</li>
|
||||
<li>case</li>
|
||||
<li>class</li>
|
||||
<li>contenttype</li>
|
||||
<li>data</li>
|
||||
<li>default</li>
|
||||
<li>deriving</li>
|
||||
<li>infixl</li>
|
||||
<li>mdo</li>
|
||||
<li>do</li>
|
||||
<li>else</li>
|
||||
<li>family</li>
|
||||
<li>forall</li>
|
||||
<li>foreign</li>
|
||||
<li>hiding</li>
|
||||
<li>if</li>
|
||||
<li>import</li>
|
||||
<li>in</li>
|
||||
<li>infix</li>
|
||||
<li>infixl</li>
|
||||
<li>infixr</li>
|
||||
<li>instance</li>
|
||||
<li>let</li>
|
||||
<li>mdo</li>
|
||||
<li>module</li>
|
||||
<li>newtype</li>
|
||||
<li>of</li>
|
||||
<li>proc</li>
|
||||
<li>pure</li>
|
||||
<li>qualified</li>
|
||||
<li>rec</li>
|
||||
<li>return</li>
|
||||
<li>then</li>
|
||||
<li>type</li>
|
||||
<li>where</li>
|
||||
</ul>
|
||||
|
||||
@ -5,14 +5,14 @@ sidebar_label: haskell
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|modelPackage|package for generated models| |null|
|
||||
|apiPackage|package for generated api classes| |null|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|modelPackage|package for generated models| |null|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|serveStatic|serve will serve files from the directory 'static'.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
@ -29,47 +29,47 @@ sidebar_label: haskell
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>Integer</li>
|
||||
<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>Bool</li>
|
||||
<li>Char</li>
|
||||
<li>Double</li>
|
||||
<li>FilePath</li>
|
||||
<li>Float</li>
|
||||
<li>Bool</li>
|
||||
<li>Char</li>
|
||||
<li>Int</li>
|
||||
<li>Integer</li>
|
||||
<li>List</li>
|
||||
<li>String</li>
|
||||
<li>Double</li>
|
||||
<li>Int</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>qualified</li>
|
||||
<li>instance</li>
|
||||
<li>data</li>
|
||||
<li>import</li>
|
||||
<li>infixr</li>
|
||||
<li>do</li>
|
||||
<li>type</li>
|
||||
<li>foreign</li>
|
||||
<li>newtype</li>
|
||||
<li>hiding</li>
|
||||
<li>rec</li>
|
||||
<li>default</li>
|
||||
<li>else</li>
|
||||
<li>of</li>
|
||||
<li>let</li>
|
||||
<li>where</li>
|
||||
<li>class</li>
|
||||
<li>if</li>
|
||||
<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>as</li>
|
||||
<li>case</li>
|
||||
<li>proc</li>
|
||||
<li>in</li>
|
||||
<li>forall</li>
|
||||
<li>module</li>
|
||||
<li>then</li>
|
||||
<li>infix</li>
|
||||
<li>as</li>
|
||||
<li>class</li>
|
||||
<li>data</li>
|
||||
<li>default</li>
|
||||
<li>deriving</li>
|
||||
<li>infixl</li>
|
||||
<li>mdo</li>
|
||||
<li>do</li>
|
||||
<li>else</li>
|
||||
<li>family</li>
|
||||
<li>forall</li>
|
||||
<li>foreign</li>
|
||||
<li>hiding</li>
|
||||
<li>if</li>
|
||||
<li>import</li>
|
||||
<li>in</li>
|
||||
<li>infix</li>
|
||||
<li>infixl</li>
|
||||
<li>infixr</li>
|
||||
<li>instance</li>
|
||||
<li>let</li>
|
||||
<li>mdo</li>
|
||||
<li>module</li>
|
||||
<li>newtype</li>
|
||||
<li>of</li>
|
||||
<li>proc</li>
|
||||
<li>qualified</li>
|
||||
<li>rec</li>
|
||||
<li>then</li>
|
||||
<li>type</li>
|
||||
<li>where</li>
|
||||
</ul>
|
||||
|
||||
@ -5,21 +5,21 @@ sidebar_label: html
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|appName|short name of the application| |null|
|
||||
|appDescription|description of the application| |null|
|
||||
|infoUrl|a URL where users can get more information about the application| |null|
|
||||
|infoEmail|an email address to contact for inquiries about the application| |null|
|
||||
|licenseInfo|a short description of the license| |null|
|
||||
|licenseUrl|a URL pointing to the full license| |null|
|
||||
|invokerPackage|root package for generated code| |null|
|
||||
|groupId|groupId in generated pom.xml| |null|
|
||||
|appName|short name of the application| |null|
|
||||
|artifactId|artifactId in generated pom.xml. This also becomes part of the generated library's filename| |null|
|
||||
|artifactVersion|artifact version in generated pom.xml. This also becomes part of the generated library's filename| |null|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|groupId|groupId in generated pom.xml| |null|
|
||||
|infoEmail|an email address to contact for inquiries about the application| |null|
|
||||
|infoUrl|a URL where users can get more information about the application| |null|
|
||||
|invokerPackage|root package for generated code| |null|
|
||||
|licenseInfo|a short description of the license| |null|
|
||||
|licenseUrl|a URL pointing to the full license| |null|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
|
||||
@ -5,25 +5,25 @@ sidebar_label: html2
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|appName|short name of the application| |null|
|
||||
|appDescription|description of the application| |null|
|
||||
|infoUrl|a URL where users can get more information about the application| |null|
|
||||
|infoEmail|an email address to contact for inquiries about the application| |null|
|
||||
|licenseInfo|a short description of the license| |null|
|
||||
|licenseUrl|a URL pointing to the full license| |null|
|
||||
|invokerPackage|root package for generated code| |null|
|
||||
|phpInvokerPackage|root package for generated php code| |null|
|
||||
|perlModuleName|root module name for generated perl code| |null|
|
||||
|pythonPackageName|package name for generated python code| |null|
|
||||
|packageName|C# package name| |null|
|
||||
|groupId|groupId in generated pom.xml| |null|
|
||||
|appName|short name of the application| |null|
|
||||
|artifactId|artifactId in generated pom.xml. This also becomes part of the generated library's filename| |null|
|
||||
|artifactVersion|artifact version in generated pom.xml. This also becomes part of the generated library's filename| |null|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|groupId|groupId in generated pom.xml| |null|
|
||||
|infoEmail|an email address to contact for inquiries about the application| |null|
|
||||
|infoUrl|a URL where users can get more information about the application| |null|
|
||||
|invokerPackage|root package for generated code| |null|
|
||||
|licenseInfo|a short description of the license| |null|
|
||||
|licenseUrl|a URL pointing to the full license| |null|
|
||||
|packageName|C# package name| |null|
|
||||
|perlModuleName|root module name for generated perl code| |null|
|
||||
|phpInvokerPackage|root package for generated php code| |null|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|pythonPackageName|package name for generated python code| |null|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
|
||||
@ -5,64 +5,64 @@ sidebar_label: java-inflector
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|modelPackage|package for generated models| |org.openapitools.model|
|
||||
|apiPackage|package for generated api classes| |org.openapitools.controllers|
|
||||
|invokerPackage|root package for generated code| |org.openapitools.controllers|
|
||||
|groupId|groupId in generated pom.xml| |org.openapitools|
|
||||
|artifactId|artifactId in generated pom.xml. This also becomes part of the generated library's filename| |openapi-inflector-server|
|
||||
|artifactVersion|artifact version in generated pom.xml. This also becomes part of the generated library's filename| |1.0.0|
|
||||
|artifactUrl|artifact URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
|artifactDescription|artifact description in generated pom.xml| |OpenAPI Java|
|
||||
|artifactId|artifactId in generated pom.xml. This also becomes part of the generated library's filename| |openapi-inflector-server|
|
||||
|artifactUrl|artifact URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
|artifactVersion|artifact version in generated pom.xml. This also becomes part of the generated library's filename| |1.0.0|
|
||||
|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false|
|
||||
|booleanGetterPrefix|Set booleanGetterPrefix| |get|
|
||||
|dateLibrary|Option. Date library to use|<dl><dt>**joda**</dt><dd>Joda (for legacy app only)</dd><dt>**legacy**</dt><dd>Legacy java.util.Date (if you really have a good reason not to use threetenbp</dd><dt>**java8-localdatetime**</dt><dd>Java 8 using LocalDateTime (for legacy app only)</dd><dt>**java8**</dt><dd>Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true</dd><dt>**threetenbp**</dt><dd>Backport of JSR310 (preferred for jdk < 1.8)</dd><dl>|legacy|
|
||||
|developerEmail|developer email in generated pom.xml| |team@openapitools.org|
|
||||
|developerName|developer name in generated pom.xml| |OpenAPI-Generator Contributors|
|
||||
|developerOrganization|developer organization in generated pom.xml| |OpenAPITools.org|
|
||||
|developerOrganizationUrl|developer organization URL in generated pom.xml| |http://openapitools.org|
|
||||
|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false|
|
||||
|groupId|groupId in generated pom.xml| |org.openapitools|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |false|
|
||||
|invokerPackage|root package for generated code| |org.openapitools.controllers|
|
||||
|java8|Option. Use Java8 classes instead of third party equivalents|<dl><dt>**true**</dt><dd>Use Java 8 classes such as Base64</dd><dt>**false**</dt><dd>Various third party libraries as needed</dd><dl>|false|
|
||||
|licenseName|The name of the license| |Unlicense|
|
||||
|licenseUrl|The URL of the license| |http://unlicense.org|
|
||||
|modelPackage|package for generated models| |org.openapitools.model|
|
||||
|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|scmConnection|SCM connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git|
|
||||
|scmDeveloperConnection|SCM developer connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git|
|
||||
|scmUrl|SCM URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
|developerName|developer name in generated pom.xml| |OpenAPI-Generator Contributors|
|
||||
|developerEmail|developer email in generated pom.xml| |team@openapitools.org|
|
||||
|developerOrganization|developer organization in generated pom.xml| |OpenAPITools.org|
|
||||
|developerOrganizationUrl|developer organization URL in generated pom.xml| |http://openapitools.org|
|
||||
|licenseName|The name of the license| |Unlicense|
|
||||
|licenseUrl|The URL of the license| |http://unlicense.org|
|
||||
|sourceFolder|source folder for generated code| |src/gen/java|
|
||||
|serializableModel|boolean - toggle "implements Serializable" for generated models| |false|
|
||||
|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false|
|
||||
|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |false|
|
||||
|withXml|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)| |false|
|
||||
|dateLibrary|Option. Date library to use|<dl><dt>**joda**</dt><dd>Joda (for legacy app only)</dd><dt>**legacy**</dt><dd>Legacy java.util.Date (if you really have a good reason not to use threetenbp</dd><dt>**java8-localdatetime**</dt><dd>Java 8 using LocalDateTime (for legacy app only)</dd><dt>**java8**</dt><dd>Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true</dd><dt>**threetenbp**</dt><dd>Backport of JSR310 (preferred for jdk < 1.8)</dd><dl>|legacy|
|
||||
|java8|Option. Use Java8 classes instead of third party equivalents|<dl><dt>**true**</dt><dd>Use Java 8 classes such as Base64</dd><dt>**false**</dt><dd>Various third party libraries as needed</dd><dl>|false|
|
||||
|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false|
|
||||
|booleanGetterPrefix|Set booleanGetterPrefix| |get|
|
||||
|additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null|
|
||||
|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|snapshotVersion|Uses a SNAPSHOT version.|<dl><dt>**true**</dt><dd>Use a SnapShot Version</dd><dt>**false**</dt><dd>Use a Release Version</dd><dl>|null|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sourceFolder|source folder for generated code| |src/gen/java|
|
||||
|withXml|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)| |false|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|Set|java.util.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|HashMap|java.util.HashMap|
|
||||
|Array|java.util.List|
|
||||
|ArrayList|java.util.ArrayList|
|
||||
|URI|java.net.URI|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|BigDecimal|java.math.BigDecimal|
|
||||
|Date|java.util.Date|
|
||||
|DateTime|org.joda.time.*|
|
||||
|Array|java.util.List|
|
||||
|List|java.util.*|
|
||||
|UUID|java.util.UUID|
|
||||
|File|java.io.File|
|
||||
|HashMap|java.util.HashMap|
|
||||
|List|java.util.*|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|Map|java.util.Map|
|
||||
|Set|java.util.*|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|URI|java.net.URI|
|
||||
|UUID|java.util.UUID|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
@ -75,87 +75,87 @@ sidebar_label: java-inflector
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>Integer</li>
|
||||
<li>byte[]</li>
|
||||
<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>Boolean</li>
|
||||
<li>Double</li>
|
||||
<li>Float</li>
|
||||
<li>boolean</li>
|
||||
<li>Integer</li>
|
||||
<li>Long</li>
|
||||
<li>Object</li>
|
||||
<li>String</li>
|
||||
<li>Boolean</li>
|
||||
<li>Double</li>
|
||||
<li>boolean</li>
|
||||
<li>byte[]</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>localvaraccepts</li>
|
||||
<li>synchronized</li>
|
||||
<li>do</li>
|
||||
<li>float</li>
|
||||
<li>while</li>
|
||||
<li>localvarpath</li>
|
||||
<li>protected</li>
|
||||
<li>continue</li>
|
||||
<li>else</li>
|
||||
<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>abstract</li>
|
||||
<li>apiclient</li>
|
||||
<li>localvarqueryparams</li>
|
||||
<li>catch</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>new</li>
|
||||
<li>package</li>
|
||||
<li>static</li>
|
||||
<li>void</li>
|
||||
<li>localvaraccept</li>
|
||||
<li>double</li>
|
||||
<li>apiexception</li>
|
||||
<li>apiresponse</li>
|
||||
<li>assert</li>
|
||||
<li>boolean</li>
|
||||
<li>break</li>
|
||||
<li>byte</li>
|
||||
<li>finally</li>
|
||||
<li>this</li>
|
||||
<li>strictfp</li>
|
||||
<li>throws</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>null</li>
|
||||
<li>transient</li>
|
||||
<li>apiexception</li>
|
||||
<li>final</li>
|
||||
<li>try</li>
|
||||
<li>object</li>
|
||||
<li>localvarcontenttypes</li>
|
||||
<li>implements</li>
|
||||
<li>private</li>
|
||||
<li>import</li>
|
||||
<li>const</li>
|
||||
<li>configuration</li>
|
||||
<li>finally</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>apiresponse</li>
|
||||
<li>interface</li>
|
||||
<li>long</li>
|
||||
<li>switch</li>
|
||||
<li>default</li>
|
||||
<li>goto</li>
|
||||
<li>public</li>
|
||||
<li>localvarheaderparams</li>
|
||||
<li>native</li>
|
||||
<li>localvarcontenttype</li>
|
||||
<li>assert</li>
|
||||
<li>stringutil</li>
|
||||
<li>class</li>
|
||||
<li>localvarcollectionqueryparams</li>
|
||||
<li>localvarcookieparams</li>
|
||||
<li>localreturntype</li>
|
||||
<li>localvarformparams</li>
|
||||
<li>break</li>
|
||||
<li>volatile</li>
|
||||
<li>localvarauthnames</li>
|
||||
<li>abstract</li>
|
||||
<li>int</li>
|
||||
<li>if</li>
|
||||
<li>implements</li>
|
||||
<li>import</li>
|
||||
<li>instanceof</li>
|
||||
<li>super</li>
|
||||
<li>boolean</li>
|
||||
<li>throw</li>
|
||||
<li>int</li>
|
||||
<li>interface</li>
|
||||
<li>localreturntype</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>char</li>
|
||||
<li>short</li>
|
||||
<li>localvarqueryparams</li>
|
||||
<li>long</li>
|
||||
<li>native</li>
|
||||
<li>new</li>
|
||||
<li>null</li>
|
||||
<li>object</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>
|
||||
|
||||
@ -5,69 +5,69 @@ sidebar_label: java-msf4j
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|modelPackage|package for generated models| |org.openapitools.model|
|
||||
|apiPackage|package for generated api classes| |org.openapitools.api|
|
||||
|invokerPackage|root package for generated code| |org.openapitools.api|
|
||||
|groupId|groupId in generated pom.xml| |org.openapitools|
|
||||
|artifactId|artifactId in generated pom.xml. This also becomes part of the generated library's filename| |openapi-jaxrs-server|
|
||||
|artifactVersion|artifact version in generated pom.xml. This also becomes part of the generated library's filename| |1.0.0|
|
||||
|artifactUrl|artifact URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
|artifactDescription|artifact description in generated pom.xml| |OpenAPI Java|
|
||||
|artifactId|artifactId in generated pom.xml. This also becomes part of the generated library's filename| |openapi-jaxrs-server|
|
||||
|artifactUrl|artifact URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
|artifactVersion|artifact version in generated pom.xml. This also becomes part of the generated library's filename| |1.0.0|
|
||||
|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false|
|
||||
|booleanGetterPrefix|Set booleanGetterPrefix| |get|
|
||||
|dateLibrary|Option. Date library to use|<dl><dt>**joda**</dt><dd>Joda (for legacy app only)</dd><dt>**legacy**</dt><dd>Legacy java.util.Date (if you really have a good reason not to use threetenbp</dd><dt>**java8-localdatetime**</dt><dd>Java 8 using LocalDateTime (for legacy app only)</dd><dt>**java8**</dt><dd>Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true</dd><dt>**threetenbp**</dt><dd>Backport of JSR310 (preferred for jdk < 1.8)</dd><dl>|legacy|
|
||||
|developerEmail|developer email in generated pom.xml| |team@openapitools.org|
|
||||
|developerName|developer name in generated pom.xml| |OpenAPI-Generator Contributors|
|
||||
|developerOrganization|developer organization in generated pom.xml| |OpenAPITools.org|
|
||||
|developerOrganizationUrl|developer organization URL in generated pom.xml| |http://openapitools.org|
|
||||
|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false|
|
||||
|groupId|groupId in generated pom.xml| |org.openapitools|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |false|
|
||||
|implFolder|folder for generated implementation code| |src/main/java|
|
||||
|invokerPackage|root package for generated code| |org.openapitools.api|
|
||||
|java8|Option. Use Java8 classes instead of third party equivalents|<dl><dt>**true**</dt><dd>Use Java 8 classes such as Base64</dd><dt>**false**</dt><dd>Various third party libraries as needed</dd><dl>|false|
|
||||
|library|library template (sub-template)|<dl><dt>**jersey1**</dt><dd>Jersey core 1.x</dd><dt>**jersey2**</dt><dd>Jersey core 2.x</dd><dl>|jersey2|
|
||||
|licenseName|The name of the license| |Unlicense|
|
||||
|licenseUrl|The URL of the license| |http://unlicense.org|
|
||||
|modelPackage|package for generated models| |org.openapitools.model|
|
||||
|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|scmConnection|SCM connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git|
|
||||
|scmDeveloperConnection|SCM developer connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git|
|
||||
|scmUrl|SCM URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
|developerName|developer name in generated pom.xml| |OpenAPI-Generator Contributors|
|
||||
|developerEmail|developer email in generated pom.xml| |team@openapitools.org|
|
||||
|developerOrganization|developer organization in generated pom.xml| |OpenAPITools.org|
|
||||
|developerOrganizationUrl|developer organization URL in generated pom.xml| |http://openapitools.org|
|
||||
|licenseName|The name of the license| |Unlicense|
|
||||
|licenseUrl|The URL of the license| |http://unlicense.org|
|
||||
|sourceFolder|source folder for generated code| |src/main/java|
|
||||
|serializableModel|boolean - toggle "implements Serializable" for generated models| |false|
|
||||
|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false|
|
||||
|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |false|
|
||||
|withXml|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)| |false|
|
||||
|dateLibrary|Option. Date library to use|<dl><dt>**joda**</dt><dd>Joda (for legacy app only)</dd><dt>**legacy**</dt><dd>Legacy java.util.Date (if you really have a good reason not to use threetenbp</dd><dt>**java8-localdatetime**</dt><dd>Java 8 using LocalDateTime (for legacy app only)</dd><dt>**java8**</dt><dd>Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true</dd><dt>**threetenbp**</dt><dd>Backport of JSR310 (preferred for jdk < 1.8)</dd><dl>|legacy|
|
||||
|java8|Option. Use Java8 classes instead of third party equivalents|<dl><dt>**true**</dt><dd>Use Java 8 classes such as Base64</dd><dt>**false**</dt><dd>Various third party libraries as needed</dd><dl>|false|
|
||||
|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false|
|
||||
|booleanGetterPrefix|Set booleanGetterPrefix| |get|
|
||||
|additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null|
|
||||
|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|serverPort|The port on which the server should be started| |8080|
|
||||
|snapshotVersion|Uses a SNAPSHOT version.|<dl><dt>**true**</dt><dd>Use a SnapShot Version</dd><dt>**false**</dt><dd>Use a Release Version</dd><dl>|null|
|
||||
|implFolder|folder for generated implementation code| |src/main/java|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sourceFolder|source folder for generated code| |src/main/java|
|
||||
|title|a title describing the application| |OpenAPI Server|
|
||||
|useBeanValidation|Use BeanValidation API annotations| |true|
|
||||
|serverPort|The port on which the server should be started| |8080|
|
||||
|library|library template (sub-template)|<dl><dt>**jersey1**</dt><dd>Jersey core 1.x</dd><dt>**jersey2**</dt><dd>Jersey core 2.x</dd><dl>|jersey2|
|
||||
|withXml|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)| |false|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|Set|java.util.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|HashMap|java.util.HashMap|
|
||||
|Array|java.util.List|
|
||||
|ArrayList|java.util.ArrayList|
|
||||
|URI|java.net.URI|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|BigDecimal|java.math.BigDecimal|
|
||||
|Date|java.util.Date|
|
||||
|DateTime|org.joda.time.*|
|
||||
|Array|java.util.List|
|
||||
|List|java.util.*|
|
||||
|UUID|java.util.UUID|
|
||||
|File|java.io.File|
|
||||
|HashMap|java.util.HashMap|
|
||||
|List|java.util.*|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|Map|java.util.Map|
|
||||
|Set|java.util.*|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|URI|java.net.URI|
|
||||
|UUID|java.util.UUID|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
@ -80,87 +80,87 @@ sidebar_label: java-msf4j
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>Integer</li>
|
||||
<li>byte[]</li>
|
||||
<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>Boolean</li>
|
||||
<li>Double</li>
|
||||
<li>Float</li>
|
||||
<li>boolean</li>
|
||||
<li>Integer</li>
|
||||
<li>Long</li>
|
||||
<li>Object</li>
|
||||
<li>String</li>
|
||||
<li>Boolean</li>
|
||||
<li>Double</li>
|
||||
<li>boolean</li>
|
||||
<li>byte[]</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>localvaraccepts</li>
|
||||
<li>synchronized</li>
|
||||
<li>do</li>
|
||||
<li>float</li>
|
||||
<li>while</li>
|
||||
<li>localvarpath</li>
|
||||
<li>protected</li>
|
||||
<li>continue</li>
|
||||
<li>else</li>
|
||||
<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>abstract</li>
|
||||
<li>apiclient</li>
|
||||
<li>localvarqueryparams</li>
|
||||
<li>catch</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>new</li>
|
||||
<li>package</li>
|
||||
<li>static</li>
|
||||
<li>void</li>
|
||||
<li>localvaraccept</li>
|
||||
<li>double</li>
|
||||
<li>apiexception</li>
|
||||
<li>apiresponse</li>
|
||||
<li>assert</li>
|
||||
<li>boolean</li>
|
||||
<li>break</li>
|
||||
<li>byte</li>
|
||||
<li>finally</li>
|
||||
<li>this</li>
|
||||
<li>strictfp</li>
|
||||
<li>throws</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>null</li>
|
||||
<li>transient</li>
|
||||
<li>apiexception</li>
|
||||
<li>final</li>
|
||||
<li>try</li>
|
||||
<li>object</li>
|
||||
<li>localvarcontenttypes</li>
|
||||
<li>implements</li>
|
||||
<li>private</li>
|
||||
<li>import</li>
|
||||
<li>const</li>
|
||||
<li>configuration</li>
|
||||
<li>finally</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>apiresponse</li>
|
||||
<li>interface</li>
|
||||
<li>long</li>
|
||||
<li>switch</li>
|
||||
<li>default</li>
|
||||
<li>goto</li>
|
||||
<li>public</li>
|
||||
<li>localvarheaderparams</li>
|
||||
<li>native</li>
|
||||
<li>localvarcontenttype</li>
|
||||
<li>assert</li>
|
||||
<li>stringutil</li>
|
||||
<li>class</li>
|
||||
<li>localvarcollectionqueryparams</li>
|
||||
<li>localvarcookieparams</li>
|
||||
<li>localreturntype</li>
|
||||
<li>localvarformparams</li>
|
||||
<li>break</li>
|
||||
<li>volatile</li>
|
||||
<li>localvarauthnames</li>
|
||||
<li>abstract</li>
|
||||
<li>int</li>
|
||||
<li>if</li>
|
||||
<li>implements</li>
|
||||
<li>import</li>
|
||||
<li>instanceof</li>
|
||||
<li>super</li>
|
||||
<li>boolean</li>
|
||||
<li>throw</li>
|
||||
<li>int</li>
|
||||
<li>interface</li>
|
||||
<li>localreturntype</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>char</li>
|
||||
<li>short</li>
|
||||
<li>localvarqueryparams</li>
|
||||
<li>long</li>
|
||||
<li>native</li>
|
||||
<li>new</li>
|
||||
<li>null</li>
|
||||
<li>object</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>
|
||||
|
||||
@ -5,71 +5,71 @@ sidebar_label: java-pkmst
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|modelPackage|package for generated models| |com.prokarma.pkmst.model|
|
||||
|apiPackage|package for generated api classes| |com.prokarma.pkmst.controller|
|
||||
|invokerPackage|root package for generated code| |com.prokarma.pkmst.controller|
|
||||
|groupId|groupId in generated pom.xml| |com.prokarma|
|
||||
|artifactId|artifactId in generated pom.xml. This also becomes part of the generated library's filename| |pkmst-microservice|
|
||||
|artifactVersion|artifact version in generated pom.xml. This also becomes part of the generated library's filename| |1.0.0|
|
||||
|artifactUrl|artifact URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
|artifactDescription|artifact description in generated pom.xml| |OpenAPI Java|
|
||||
|artifactId|artifactId in generated pom.xml. This also becomes part of the generated library's filename| |pkmst-microservice|
|
||||
|artifactUrl|artifact URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
|artifactVersion|artifact version in generated pom.xml. This also becomes part of the generated library's filename| |1.0.0|
|
||||
|basePackage|base package for java source code| |null|
|
||||
|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false|
|
||||
|booleanGetterPrefix|Set booleanGetterPrefix| |get|
|
||||
|dateLibrary|Option. Date library to use|<dl><dt>**joda**</dt><dd>Joda (for legacy app only)</dd><dt>**legacy**</dt><dd>Legacy java.util.Date (if you really have a good reason not to use threetenbp</dd><dt>**java8-localdatetime**</dt><dd>Java 8 using LocalDateTime (for legacy app only)</dd><dt>**java8**</dt><dd>Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true</dd><dt>**threetenbp**</dt><dd>Backport of JSR310 (preferred for jdk < 1.8)</dd><dl>|threetenbp|
|
||||
|developerEmail|developer email in generated pom.xml| |team@openapitools.org|
|
||||
|developerName|developer name in generated pom.xml| |OpenAPI-Generator Contributors|
|
||||
|developerOrganization|developer organization in generated pom.xml| |OpenAPITools.org|
|
||||
|developerOrganizationUrl|developer organization URL in generated pom.xml| |http://openapitools.org|
|
||||
|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|eurekaUri|Eureka URI| |null|
|
||||
|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false|
|
||||
|groupId|groupId in generated pom.xml| |com.prokarma|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |false|
|
||||
|invokerPackage|root package for generated code| |com.prokarma.pkmst.controller|
|
||||
|java8|Option. Use Java8 classes instead of third party equivalents|<dl><dt>**true**</dt><dd>Use Java 8 classes such as Base64</dd><dt>**false**</dt><dd>Various third party libraries as needed</dd><dl>|false|
|
||||
|licenseName|The name of the license| |Unlicense|
|
||||
|licenseUrl|The URL of the license| |http://unlicense.org|
|
||||
|modelPackage|package for generated models| |com.prokarma.pkmst.model|
|
||||
|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|pkmstInterceptor|PKMST Interceptor| |null|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|scmConnection|SCM connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git|
|
||||
|scmDeveloperConnection|SCM developer connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git|
|
||||
|scmUrl|SCM URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
|developerName|developer name in generated pom.xml| |OpenAPI-Generator Contributors|
|
||||
|developerEmail|developer email in generated pom.xml| |team@openapitools.org|
|
||||
|developerOrganization|developer organization in generated pom.xml| |OpenAPITools.org|
|
||||
|developerOrganizationUrl|developer organization URL in generated pom.xml| |http://openapitools.org|
|
||||
|licenseName|The name of the license| |Unlicense|
|
||||
|licenseUrl|The URL of the license| |http://unlicense.org|
|
||||
|sourceFolder|source folder for generated code| |src/main/java|
|
||||
|serializableModel|boolean - toggle "implements Serializable" for generated models| |false|
|
||||
|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false|
|
||||
|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |false|
|
||||
|withXml|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)| |false|
|
||||
|dateLibrary|Option. Date library to use|<dl><dt>**joda**</dt><dd>Joda (for legacy app only)</dd><dt>**legacy**</dt><dd>Legacy java.util.Date (if you really have a good reason not to use threetenbp</dd><dt>**java8-localdatetime**</dt><dd>Java 8 using LocalDateTime (for legacy app only)</dd><dt>**java8**</dt><dd>Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true</dd><dt>**threetenbp**</dt><dd>Backport of JSR310 (preferred for jdk < 1.8)</dd><dl>|threetenbp|
|
||||
|java8|Option. Use Java8 classes instead of third party equivalents|<dl><dt>**true**</dt><dd>Use Java 8 classes such as Base64</dd><dt>**false**</dt><dd>Various third party libraries as needed</dd><dl>|false|
|
||||
|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false|
|
||||
|booleanGetterPrefix|Set booleanGetterPrefix| |get|
|
||||
|additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null|
|
||||
|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|snapshotVersion|Uses a SNAPSHOT version.|<dl><dt>**true**</dt><dd>Use a SnapShot Version</dd><dt>**false**</dt><dd>Use a Release Version</dd><dl>|null|
|
||||
|basePackage|base package for java source code| |null|
|
||||
|serviceName|Service Name| |null|
|
||||
|title|server title name or client service name| |null|
|
||||
|eurekaUri|Eureka URI| |null|
|
||||
|zipkinUri|Zipkin URI| |null|
|
||||
|snapshotVersion|Uses a SNAPSHOT version.|<dl><dt>**true**</dt><dd>Use a SnapShot Version</dd><dt>**false**</dt><dd>Use a Release Version</dd><dl>|null|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sourceFolder|source folder for generated code| |src/main/java|
|
||||
|springBootAdminUri|Spring-Boot URI| |null|
|
||||
|pkmstInterceptor|PKMST Interceptor| |null|
|
||||
|title|server title name or client service name| |null|
|
||||
|withXml|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)| |false|
|
||||
|zipkinUri|Zipkin URI| |null|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|Set|java.util.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|HashMap|java.util.HashMap|
|
||||
|Array|java.util.List|
|
||||
|ArrayList|java.util.ArrayList|
|
||||
|URI|java.net.URI|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|BigDecimal|java.math.BigDecimal|
|
||||
|Date|java.util.Date|
|
||||
|DateTime|org.joda.time.*|
|
||||
|Array|java.util.List|
|
||||
|List|java.util.*|
|
||||
|UUID|java.util.UUID|
|
||||
|File|java.io.File|
|
||||
|HashMap|java.util.HashMap|
|
||||
|List|java.util.*|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|Map|java.util.Map|
|
||||
|Set|java.util.*|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|URI|java.net.URI|
|
||||
|UUID|java.util.UUID|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
@ -82,87 +82,87 @@ sidebar_label: java-pkmst
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>Integer</li>
|
||||
<li>byte[]</li>
|
||||
<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>Boolean</li>
|
||||
<li>Double</li>
|
||||
<li>Float</li>
|
||||
<li>boolean</li>
|
||||
<li>Integer</li>
|
||||
<li>Long</li>
|
||||
<li>Object</li>
|
||||
<li>String</li>
|
||||
<li>Boolean</li>
|
||||
<li>Double</li>
|
||||
<li>boolean</li>
|
||||
<li>byte[]</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>localvaraccepts</li>
|
||||
<li>synchronized</li>
|
||||
<li>do</li>
|
||||
<li>float</li>
|
||||
<li>while</li>
|
||||
<li>localvarpath</li>
|
||||
<li>protected</li>
|
||||
<li>continue</li>
|
||||
<li>else</li>
|
||||
<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>abstract</li>
|
||||
<li>apiclient</li>
|
||||
<li>localvarqueryparams</li>
|
||||
<li>catch</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>new</li>
|
||||
<li>package</li>
|
||||
<li>static</li>
|
||||
<li>void</li>
|
||||
<li>localvaraccept</li>
|
||||
<li>double</li>
|
||||
<li>apiexception</li>
|
||||
<li>apiresponse</li>
|
||||
<li>assert</li>
|
||||
<li>boolean</li>
|
||||
<li>break</li>
|
||||
<li>byte</li>
|
||||
<li>finally</li>
|
||||
<li>this</li>
|
||||
<li>strictfp</li>
|
||||
<li>throws</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>null</li>
|
||||
<li>transient</li>
|
||||
<li>apiexception</li>
|
||||
<li>final</li>
|
||||
<li>try</li>
|
||||
<li>object</li>
|
||||
<li>localvarcontenttypes</li>
|
||||
<li>implements</li>
|
||||
<li>private</li>
|
||||
<li>import</li>
|
||||
<li>const</li>
|
||||
<li>configuration</li>
|
||||
<li>finally</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>apiresponse</li>
|
||||
<li>interface</li>
|
||||
<li>long</li>
|
||||
<li>switch</li>
|
||||
<li>default</li>
|
||||
<li>goto</li>
|
||||
<li>public</li>
|
||||
<li>localvarheaderparams</li>
|
||||
<li>native</li>
|
||||
<li>localvarcontenttype</li>
|
||||
<li>assert</li>
|
||||
<li>stringutil</li>
|
||||
<li>class</li>
|
||||
<li>localvarcollectionqueryparams</li>
|
||||
<li>localvarcookieparams</li>
|
||||
<li>localreturntype</li>
|
||||
<li>localvarformparams</li>
|
||||
<li>break</li>
|
||||
<li>volatile</li>
|
||||
<li>localvarauthnames</li>
|
||||
<li>abstract</li>
|
||||
<li>int</li>
|
||||
<li>if</li>
|
||||
<li>implements</li>
|
||||
<li>import</li>
|
||||
<li>instanceof</li>
|
||||
<li>super</li>
|
||||
<li>boolean</li>
|
||||
<li>throw</li>
|
||||
<li>int</li>
|
||||
<li>interface</li>
|
||||
<li>localreturntype</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>char</li>
|
||||
<li>short</li>
|
||||
<li>localvarqueryparams</li>
|
||||
<li>long</li>
|
||||
<li>native</li>
|
||||
<li>new</li>
|
||||
<li>null</li>
|
||||
<li>object</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>
|
||||
|
||||
@ -5,73 +5,73 @@ sidebar_label: java-play-framework
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|modelPackage|package for generated models| |apimodels|
|
||||
|apiPackage|package for generated api classes| |controllers|
|
||||
|invokerPackage|root package for generated code| |org.openapitools.api|
|
||||
|groupId|groupId in generated pom.xml| |org.openapitools|
|
||||
|artifactId|artifactId in generated pom.xml. This also becomes part of the generated library's filename| |openapi-java-playframework|
|
||||
|artifactVersion|artifact version in generated pom.xml. This also becomes part of the generated library's filename| |1.0.0|
|
||||
|artifactUrl|artifact URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
|artifactDescription|artifact description in generated pom.xml| |OpenAPI Java|
|
||||
|artifactId|artifactId in generated pom.xml. This also becomes part of the generated library's filename| |openapi-java-playframework|
|
||||
|artifactUrl|artifact URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
|artifactVersion|artifact version in generated pom.xml. This also becomes part of the generated library's filename| |1.0.0|
|
||||
|basePackage|base package for generated code| |org.openapitools|
|
||||
|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false|
|
||||
|booleanGetterPrefix|Set booleanGetterPrefix| |get|
|
||||
|configPackage|configuration package for generated code| |org.openapitools.configuration|
|
||||
|controllerOnly|Whether to generate only API interface stubs without the server files.| |false|
|
||||
|dateLibrary|Option. Date library to use|<dl><dt>**joda**</dt><dd>Joda (for legacy app only)</dd><dt>**legacy**</dt><dd>Legacy java.util.Date (if you really have a good reason not to use threetenbp</dd><dt>**java8-localdatetime**</dt><dd>Java 8 using LocalDateTime (for legacy app only)</dd><dt>**java8**</dt><dd>Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true</dd><dt>**threetenbp**</dt><dd>Backport of JSR310 (preferred for jdk < 1.8)</dd><dl>|threetenbp|
|
||||
|developerEmail|developer email in generated pom.xml| |team@openapitools.org|
|
||||
|developerName|developer name in generated pom.xml| |OpenAPI-Generator Contributors|
|
||||
|developerOrganization|developer organization in generated pom.xml| |OpenAPITools.org|
|
||||
|developerOrganizationUrl|developer organization URL in generated pom.xml| |http://openapitools.org|
|
||||
|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false|
|
||||
|groupId|groupId in generated pom.xml| |org.openapitools|
|
||||
|handleExceptions|Add a 'throw exception' to each controller function. Add also a custom error handler where you can put your custom logic| |true|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |false|
|
||||
|invokerPackage|root package for generated code| |org.openapitools.api|
|
||||
|java8|Option. Use Java8 classes instead of third party equivalents|<dl><dt>**true**</dt><dd>Use Java 8 classes such as Base64</dd><dt>**false**</dt><dd>Various third party libraries as needed</dd><dl>|false|
|
||||
|licenseName|The name of the license| |Unlicense|
|
||||
|licenseUrl|The URL of the license| |http://unlicense.org|
|
||||
|modelPackage|package for generated models| |apimodels|
|
||||
|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|scmConnection|SCM connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git|
|
||||
|scmDeveloperConnection|SCM developer connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git|
|
||||
|scmUrl|SCM URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
|developerName|developer name in generated pom.xml| |OpenAPI-Generator Contributors|
|
||||
|developerEmail|developer email in generated pom.xml| |team@openapitools.org|
|
||||
|developerOrganization|developer organization in generated pom.xml| |OpenAPITools.org|
|
||||
|developerOrganizationUrl|developer organization URL in generated pom.xml| |http://openapitools.org|
|
||||
|licenseName|The name of the license| |Unlicense|
|
||||
|licenseUrl|The URL of the license| |http://unlicense.org|
|
||||
|sourceFolder|source folder for generated code| |/app|
|
||||
|serializableModel|boolean - toggle "implements Serializable" for generated models| |false|
|
||||
|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false|
|
||||
|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |false|
|
||||
|withXml|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)| |false|
|
||||
|dateLibrary|Option. Date library to use|<dl><dt>**joda**</dt><dd>Joda (for legacy app only)</dd><dt>**legacy**</dt><dd>Legacy java.util.Date (if you really have a good reason not to use threetenbp</dd><dt>**java8-localdatetime**</dt><dd>Java 8 using LocalDateTime (for legacy app only)</dd><dt>**java8**</dt><dd>Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true</dd><dt>**threetenbp**</dt><dd>Backport of JSR310 (preferred for jdk < 1.8)</dd><dl>|threetenbp|
|
||||
|java8|Option. Use Java8 classes instead of third party equivalents|<dl><dt>**true**</dt><dd>Use Java 8 classes such as Base64</dd><dt>**false**</dt><dd>Various third party libraries as needed</dd><dl>|false|
|
||||
|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false|
|
||||
|booleanGetterPrefix|Set booleanGetterPrefix| |get|
|
||||
|additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null|
|
||||
|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|snapshotVersion|Uses a SNAPSHOT version.|<dl><dt>**true**</dt><dd>Use a SnapShot Version</dd><dt>**false**</dt><dd>Use a Release Version</dd><dl>|null|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sourceFolder|source folder for generated code| |/app|
|
||||
|title|server title name or client service name| |openapi-java-playframework|
|
||||
|configPackage|configuration package for generated code| |org.openapitools.configuration|
|
||||
|basePackage|base package for generated code| |org.openapitools|
|
||||
|controllerOnly|Whether to generate only API interface stubs without the server files.| |false|
|
||||
|useBeanValidation|Use BeanValidation API annotations| |true|
|
||||
|useInterfaces|Makes the controllerImp implements an interface to facilitate automatic completion when updating from version x to y of your spec| |true|
|
||||
|handleExceptions|Add a 'throw exception' to each controller function. Add also a custom error handler where you can put your custom logic| |true|
|
||||
|wrapCalls|Add a wrapper to each controller function to handle things like metrics, response modification, etc..| |true|
|
||||
|useSwaggerUI|Add a route to /api which show your documentation in swagger-ui. Will also import needed dependencies| |true|
|
||||
|withXml|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)| |false|
|
||||
|wrapCalls|Add a wrapper to each controller function to handle things like metrics, response modification, etc..| |true|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|Set|java.util.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|HashMap|java.util.HashMap|
|
||||
|Array|java.util.List|
|
||||
|ArrayList|java.util.ArrayList|
|
||||
|URI|java.net.URI|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|BigDecimal|java.math.BigDecimal|
|
||||
|Date|java.util.Date|
|
||||
|DateTime|org.joda.time.*|
|
||||
|Array|java.util.List|
|
||||
|List|java.util.*|
|
||||
|UUID|java.util.UUID|
|
||||
|File|java.io.File|
|
||||
|HashMap|java.util.HashMap|
|
||||
|List|java.util.*|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|Map|java.util.Map|
|
||||
|Set|java.util.*|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|URI|java.net.URI|
|
||||
|UUID|java.util.UUID|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
@ -84,87 +84,87 @@ sidebar_label: java-play-framework
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>Integer</li>
|
||||
<li>byte[]</li>
|
||||
<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>Boolean</li>
|
||||
<li>Double</li>
|
||||
<li>Float</li>
|
||||
<li>boolean</li>
|
||||
<li>Integer</li>
|
||||
<li>Long</li>
|
||||
<li>Object</li>
|
||||
<li>String</li>
|
||||
<li>Boolean</li>
|
||||
<li>Double</li>
|
||||
<li>boolean</li>
|
||||
<li>byte[]</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>localvaraccepts</li>
|
||||
<li>synchronized</li>
|
||||
<li>do</li>
|
||||
<li>float</li>
|
||||
<li>while</li>
|
||||
<li>localvarpath</li>
|
||||
<li>protected</li>
|
||||
<li>continue</li>
|
||||
<li>else</li>
|
||||
<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>abstract</li>
|
||||
<li>apiclient</li>
|
||||
<li>localvarqueryparams</li>
|
||||
<li>catch</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>new</li>
|
||||
<li>package</li>
|
||||
<li>static</li>
|
||||
<li>void</li>
|
||||
<li>localvaraccept</li>
|
||||
<li>double</li>
|
||||
<li>apiexception</li>
|
||||
<li>apiresponse</li>
|
||||
<li>assert</li>
|
||||
<li>boolean</li>
|
||||
<li>break</li>
|
||||
<li>byte</li>
|
||||
<li>finally</li>
|
||||
<li>this</li>
|
||||
<li>strictfp</li>
|
||||
<li>throws</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>null</li>
|
||||
<li>transient</li>
|
||||
<li>apiexception</li>
|
||||
<li>final</li>
|
||||
<li>try</li>
|
||||
<li>object</li>
|
||||
<li>localvarcontenttypes</li>
|
||||
<li>implements</li>
|
||||
<li>private</li>
|
||||
<li>import</li>
|
||||
<li>const</li>
|
||||
<li>configuration</li>
|
||||
<li>finally</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>apiresponse</li>
|
||||
<li>interface</li>
|
||||
<li>long</li>
|
||||
<li>switch</li>
|
||||
<li>default</li>
|
||||
<li>goto</li>
|
||||
<li>public</li>
|
||||
<li>localvarheaderparams</li>
|
||||
<li>native</li>
|
||||
<li>localvarcontenttype</li>
|
||||
<li>assert</li>
|
||||
<li>stringutil</li>
|
||||
<li>class</li>
|
||||
<li>localvarcollectionqueryparams</li>
|
||||
<li>localvarcookieparams</li>
|
||||
<li>localreturntype</li>
|
||||
<li>localvarformparams</li>
|
||||
<li>break</li>
|
||||
<li>volatile</li>
|
||||
<li>localvarauthnames</li>
|
||||
<li>abstract</li>
|
||||
<li>int</li>
|
||||
<li>if</li>
|
||||
<li>implements</li>
|
||||
<li>import</li>
|
||||
<li>instanceof</li>
|
||||
<li>super</li>
|
||||
<li>boolean</li>
|
||||
<li>throw</li>
|
||||
<li>int</li>
|
||||
<li>interface</li>
|
||||
<li>localreturntype</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>char</li>
|
||||
<li>short</li>
|
||||
<li>localvarqueryparams</li>
|
||||
<li>long</li>
|
||||
<li>native</li>
|
||||
<li>new</li>
|
||||
<li>null</li>
|
||||
<li>object</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>
|
||||
|
||||
@ -5,64 +5,64 @@ sidebar_label: java-undertow-server
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|modelPackage|package for generated models| |null|
|
||||
|apiPackage|package for generated api classes| |null|
|
||||
|invokerPackage|root package for generated code| |org.openapitools.handler|
|
||||
|groupId|groupId in generated pom.xml| |org.openapitools|
|
||||
|artifactId|artifactId in generated pom.xml. This also becomes part of the generated library's filename| |openapi-undertow-server|
|
||||
|artifactVersion|artifact version in generated pom.xml. This also becomes part of the generated library's filename| |1.0.0|
|
||||
|artifactUrl|artifact URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
|artifactDescription|artifact description in generated pom.xml| |OpenAPI Java|
|
||||
|artifactId|artifactId in generated pom.xml. This also becomes part of the generated library's filename| |openapi-undertow-server|
|
||||
|artifactUrl|artifact URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
|artifactVersion|artifact version in generated pom.xml. This also becomes part of the generated library's filename| |1.0.0|
|
||||
|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false|
|
||||
|booleanGetterPrefix|Set booleanGetterPrefix| |get|
|
||||
|dateLibrary|Option. Date library to use|<dl><dt>**joda**</dt><dd>Joda (for legacy app only)</dd><dt>**legacy**</dt><dd>Legacy java.util.Date (if you really have a good reason not to use threetenbp</dd><dt>**java8-localdatetime**</dt><dd>Java 8 using LocalDateTime (for legacy app only)</dd><dt>**java8**</dt><dd>Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true</dd><dt>**threetenbp**</dt><dd>Backport of JSR310 (preferred for jdk < 1.8)</dd><dl>|legacy|
|
||||
|developerEmail|developer email in generated pom.xml| |team@openapitools.org|
|
||||
|developerName|developer name in generated pom.xml| |OpenAPI-Generator Contributors|
|
||||
|developerOrganization|developer organization in generated pom.xml| |OpenAPITools.org|
|
||||
|developerOrganizationUrl|developer organization URL in generated pom.xml| |http://openapitools.org|
|
||||
|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false|
|
||||
|groupId|groupId in generated pom.xml| |org.openapitools|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |false|
|
||||
|invokerPackage|root package for generated code| |org.openapitools.handler|
|
||||
|java8|Option. Use Java8 classes instead of third party equivalents|<dl><dt>**true**</dt><dd>Use Java 8 classes such as Base64</dd><dt>**false**</dt><dd>Various third party libraries as needed</dd><dl>|false|
|
||||
|licenseName|The name of the license| |Unlicense|
|
||||
|licenseUrl|The URL of the license| |http://unlicense.org|
|
||||
|modelPackage|package for generated models| |null|
|
||||
|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|scmConnection|SCM connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git|
|
||||
|scmDeveloperConnection|SCM developer connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git|
|
||||
|scmUrl|SCM URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
|developerName|developer name in generated pom.xml| |OpenAPI-Generator Contributors|
|
||||
|developerEmail|developer email in generated pom.xml| |team@openapitools.org|
|
||||
|developerOrganization|developer organization in generated pom.xml| |OpenAPITools.org|
|
||||
|developerOrganizationUrl|developer organization URL in generated pom.xml| |http://openapitools.org|
|
||||
|licenseName|The name of the license| |Unlicense|
|
||||
|licenseUrl|The URL of the license| |http://unlicense.org|
|
||||
|sourceFolder|source folder for generated code| |src/main/java|
|
||||
|serializableModel|boolean - toggle "implements Serializable" for generated models| |false|
|
||||
|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false|
|
||||
|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |false|
|
||||
|withXml|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)| |false|
|
||||
|dateLibrary|Option. Date library to use|<dl><dt>**joda**</dt><dd>Joda (for legacy app only)</dd><dt>**legacy**</dt><dd>Legacy java.util.Date (if you really have a good reason not to use threetenbp</dd><dt>**java8-localdatetime**</dt><dd>Java 8 using LocalDateTime (for legacy app only)</dd><dt>**java8**</dt><dd>Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true</dd><dt>**threetenbp**</dt><dd>Backport of JSR310 (preferred for jdk < 1.8)</dd><dl>|legacy|
|
||||
|java8|Option. Use Java8 classes instead of third party equivalents|<dl><dt>**true**</dt><dd>Use Java 8 classes such as Base64</dd><dt>**false**</dt><dd>Various third party libraries as needed</dd><dl>|false|
|
||||
|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false|
|
||||
|booleanGetterPrefix|Set booleanGetterPrefix| |get|
|
||||
|additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null|
|
||||
|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|snapshotVersion|Uses a SNAPSHOT version.|<dl><dt>**true**</dt><dd>Use a SnapShot Version</dd><dt>**false**</dt><dd>Use a Release Version</dd><dl>|null|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sourceFolder|source folder for generated code| |src/main/java|
|
||||
|withXml|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)| |false|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|Set|java.util.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|HashMap|java.util.HashMap|
|
||||
|Array|java.util.List|
|
||||
|ArrayList|java.util.ArrayList|
|
||||
|URI|java.net.URI|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|BigDecimal|java.math.BigDecimal|
|
||||
|Date|java.util.Date|
|
||||
|DateTime|org.joda.time.*|
|
||||
|Array|java.util.List|
|
||||
|List|java.util.*|
|
||||
|UUID|java.util.UUID|
|
||||
|File|java.io.File|
|
||||
|HashMap|java.util.HashMap|
|
||||
|List|java.util.*|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|Map|java.util.Map|
|
||||
|Set|java.util.*|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|URI|java.net.URI|
|
||||
|UUID|java.util.UUID|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
@ -75,87 +75,87 @@ sidebar_label: java-undertow-server
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>Integer</li>
|
||||
<li>byte[]</li>
|
||||
<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>Boolean</li>
|
||||
<li>Double</li>
|
||||
<li>Float</li>
|
||||
<li>boolean</li>
|
||||
<li>Integer</li>
|
||||
<li>Long</li>
|
||||
<li>Object</li>
|
||||
<li>String</li>
|
||||
<li>Boolean</li>
|
||||
<li>Double</li>
|
||||
<li>boolean</li>
|
||||
<li>byte[]</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>localvaraccepts</li>
|
||||
<li>synchronized</li>
|
||||
<li>do</li>
|
||||
<li>float</li>
|
||||
<li>while</li>
|
||||
<li>localvarpath</li>
|
||||
<li>protected</li>
|
||||
<li>continue</li>
|
||||
<li>else</li>
|
||||
<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>abstract</li>
|
||||
<li>apiclient</li>
|
||||
<li>localvarqueryparams</li>
|
||||
<li>catch</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>new</li>
|
||||
<li>package</li>
|
||||
<li>static</li>
|
||||
<li>void</li>
|
||||
<li>localvaraccept</li>
|
||||
<li>double</li>
|
||||
<li>apiexception</li>
|
||||
<li>apiresponse</li>
|
||||
<li>assert</li>
|
||||
<li>boolean</li>
|
||||
<li>break</li>
|
||||
<li>byte</li>
|
||||
<li>finally</li>
|
||||
<li>this</li>
|
||||
<li>strictfp</li>
|
||||
<li>throws</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>null</li>
|
||||
<li>transient</li>
|
||||
<li>apiexception</li>
|
||||
<li>final</li>
|
||||
<li>try</li>
|
||||
<li>object</li>
|
||||
<li>localvarcontenttypes</li>
|
||||
<li>implements</li>
|
||||
<li>private</li>
|
||||
<li>import</li>
|
||||
<li>const</li>
|
||||
<li>configuration</li>
|
||||
<li>finally</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>apiresponse</li>
|
||||
<li>interface</li>
|
||||
<li>long</li>
|
||||
<li>switch</li>
|
||||
<li>default</li>
|
||||
<li>goto</li>
|
||||
<li>public</li>
|
||||
<li>localvarheaderparams</li>
|
||||
<li>native</li>
|
||||
<li>localvarcontenttype</li>
|
||||
<li>assert</li>
|
||||
<li>stringutil</li>
|
||||
<li>class</li>
|
||||
<li>localvarcollectionqueryparams</li>
|
||||
<li>localvarcookieparams</li>
|
||||
<li>localreturntype</li>
|
||||
<li>localvarformparams</li>
|
||||
<li>break</li>
|
||||
<li>volatile</li>
|
||||
<li>localvarauthnames</li>
|
||||
<li>abstract</li>
|
||||
<li>int</li>
|
||||
<li>if</li>
|
||||
<li>implements</li>
|
||||
<li>import</li>
|
||||
<li>instanceof</li>
|
||||
<li>super</li>
|
||||
<li>boolean</li>
|
||||
<li>throw</li>
|
||||
<li>int</li>
|
||||
<li>interface</li>
|
||||
<li>localreturntype</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>char</li>
|
||||
<li>short</li>
|
||||
<li>localvarqueryparams</li>
|
||||
<li>long</li>
|
||||
<li>native</li>
|
||||
<li>new</li>
|
||||
<li>null</li>
|
||||
<li>object</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>
|
||||
|
||||
@ -5,64 +5,64 @@ sidebar_label: java-vertx-web
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|modelPackage|package for generated models| |org.openapitools.vertxweb.server.model|
|
||||
|apiPackage|package for generated api classes| |org.openapitools.vertxweb.server.api|
|
||||
|invokerPackage|root package for generated code| |org.openapitools.vertxweb.server|
|
||||
|groupId|groupId in generated pom.xml| |org.openapitools|
|
||||
|artifactId|artifactId in generated pom.xml. This also becomes part of the generated library's filename| |openapi-java-vertx-web-server|
|
||||
|artifactVersion|artifact version in generated pom.xml. This also becomes part of the generated library's filename| |1.0.0-SNAPSHOT|
|
||||
|artifactUrl|artifact URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
|artifactDescription|artifact description in generated pom.xml| |OpenAPI Java|
|
||||
|artifactId|artifactId in generated pom.xml. This also becomes part of the generated library's filename| |openapi-java-vertx-web-server|
|
||||
|artifactUrl|artifact URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
|artifactVersion|artifact version in generated pom.xml. This also becomes part of the generated library's filename| |1.0.0-SNAPSHOT|
|
||||
|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false|
|
||||
|booleanGetterPrefix|Set booleanGetterPrefix| |get|
|
||||
|dateLibrary|Option. Date library to use|<dl><dt>**joda**</dt><dd>Joda (for legacy app only)</dd><dt>**legacy**</dt><dd>Legacy java.util.Date (if you really have a good reason not to use threetenbp</dd><dt>**java8-localdatetime**</dt><dd>Java 8 using LocalDateTime (for legacy app only)</dd><dt>**java8**</dt><dd>Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true</dd><dt>**threetenbp**</dt><dd>Backport of JSR310 (preferred for jdk < 1.8)</dd><dl>|java8|
|
||||
|developerEmail|developer email in generated pom.xml| |team@openapitools.org|
|
||||
|developerName|developer name in generated pom.xml| |OpenAPI-Generator Contributors|
|
||||
|developerOrganization|developer organization in generated pom.xml| |OpenAPITools.org|
|
||||
|developerOrganizationUrl|developer organization URL in generated pom.xml| |http://openapitools.org|
|
||||
|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false|
|
||||
|groupId|groupId in generated pom.xml| |org.openapitools|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |false|
|
||||
|invokerPackage|root package for generated code| |org.openapitools.vertxweb.server|
|
||||
|java8|Option. Use Java8 classes instead of third party equivalents|<dl><dt>**true**</dt><dd>Use Java 8 classes such as Base64</dd><dt>**false**</dt><dd>Various third party libraries as needed</dd><dl>|false|
|
||||
|licenseName|The name of the license| |Unlicense|
|
||||
|licenseUrl|The URL of the license| |http://unlicense.org|
|
||||
|modelPackage|package for generated models| |org.openapitools.vertxweb.server.model|
|
||||
|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|scmConnection|SCM connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git|
|
||||
|scmDeveloperConnection|SCM developer connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git|
|
||||
|scmUrl|SCM URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
|developerName|developer name in generated pom.xml| |OpenAPI-Generator Contributors|
|
||||
|developerEmail|developer email in generated pom.xml| |team@openapitools.org|
|
||||
|developerOrganization|developer organization in generated pom.xml| |OpenAPITools.org|
|
||||
|developerOrganizationUrl|developer organization URL in generated pom.xml| |http://openapitools.org|
|
||||
|licenseName|The name of the license| |Unlicense|
|
||||
|licenseUrl|The URL of the license| |http://unlicense.org|
|
||||
|sourceFolder|source folder for generated code| |src/main/java|
|
||||
|serializableModel|boolean - toggle "implements Serializable" for generated models| |false|
|
||||
|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false|
|
||||
|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |false|
|
||||
|withXml|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)| |false|
|
||||
|dateLibrary|Option. Date library to use|<dl><dt>**joda**</dt><dd>Joda (for legacy app only)</dd><dt>**legacy**</dt><dd>Legacy java.util.Date (if you really have a good reason not to use threetenbp</dd><dt>**java8-localdatetime**</dt><dd>Java 8 using LocalDateTime (for legacy app only)</dd><dt>**java8**</dt><dd>Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true</dd><dt>**threetenbp**</dt><dd>Backport of JSR310 (preferred for jdk < 1.8)</dd><dl>|java8|
|
||||
|java8|Option. Use Java8 classes instead of third party equivalents|<dl><dt>**true**</dt><dd>Use Java 8 classes such as Base64</dd><dt>**false**</dt><dd>Various third party libraries as needed</dd><dl>|false|
|
||||
|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false|
|
||||
|booleanGetterPrefix|Set booleanGetterPrefix| |get|
|
||||
|additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null|
|
||||
|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|snapshotVersion|Uses a SNAPSHOT version.|<dl><dt>**true**</dt><dd>Use a SnapShot Version</dd><dt>**false**</dt><dd>Use a Release Version</dd><dl>|null|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sourceFolder|source folder for generated code| |src/main/java|
|
||||
|withXml|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)| |false|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|Set|java.util.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|HashMap|java.util.HashMap|
|
||||
|Array|java.util.List|
|
||||
|ArrayList|java.util.ArrayList|
|
||||
|URI|java.net.URI|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|BigDecimal|java.math.BigDecimal|
|
||||
|Date|java.util.Date|
|
||||
|DateTime|org.joda.time.*|
|
||||
|Array|java.util.List|
|
||||
|List|java.util.*|
|
||||
|UUID|java.util.UUID|
|
||||
|File|java.io.File|
|
||||
|HashMap|java.util.HashMap|
|
||||
|List|java.util.*|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|Map|java.util.Map|
|
||||
|Set|java.util.*|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|URI|java.net.URI|
|
||||
|UUID|java.util.UUID|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
@ -75,87 +75,87 @@ sidebar_label: java-vertx-web
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>Integer</li>
|
||||
<li>byte[]</li>
|
||||
<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>Boolean</li>
|
||||
<li>Double</li>
|
||||
<li>Float</li>
|
||||
<li>boolean</li>
|
||||
<li>Integer</li>
|
||||
<li>Long</li>
|
||||
<li>Object</li>
|
||||
<li>String</li>
|
||||
<li>Boolean</li>
|
||||
<li>Double</li>
|
||||
<li>boolean</li>
|
||||
<li>byte[]</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>localvaraccepts</li>
|
||||
<li>synchronized</li>
|
||||
<li>do</li>
|
||||
<li>float</li>
|
||||
<li>while</li>
|
||||
<li>localvarpath</li>
|
||||
<li>protected</li>
|
||||
<li>continue</li>
|
||||
<li>else</li>
|
||||
<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>abstract</li>
|
||||
<li>apiclient</li>
|
||||
<li>localvarqueryparams</li>
|
||||
<li>catch</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>new</li>
|
||||
<li>package</li>
|
||||
<li>static</li>
|
||||
<li>void</li>
|
||||
<li>localvaraccept</li>
|
||||
<li>double</li>
|
||||
<li>apiexception</li>
|
||||
<li>apiresponse</li>
|
||||
<li>assert</li>
|
||||
<li>boolean</li>
|
||||
<li>break</li>
|
||||
<li>byte</li>
|
||||
<li>finally</li>
|
||||
<li>this</li>
|
||||
<li>strictfp</li>
|
||||
<li>throws</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>null</li>
|
||||
<li>transient</li>
|
||||
<li>apiexception</li>
|
||||
<li>final</li>
|
||||
<li>try</li>
|
||||
<li>object</li>
|
||||
<li>localvarcontenttypes</li>
|
||||
<li>implements</li>
|
||||
<li>private</li>
|
||||
<li>import</li>
|
||||
<li>const</li>
|
||||
<li>configuration</li>
|
||||
<li>finally</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>apiresponse</li>
|
||||
<li>interface</li>
|
||||
<li>long</li>
|
||||
<li>switch</li>
|
||||
<li>default</li>
|
||||
<li>goto</li>
|
||||
<li>public</li>
|
||||
<li>localvarheaderparams</li>
|
||||
<li>native</li>
|
||||
<li>localvarcontenttype</li>
|
||||
<li>assert</li>
|
||||
<li>stringutil</li>
|
||||
<li>class</li>
|
||||
<li>localvarcollectionqueryparams</li>
|
||||
<li>localvarcookieparams</li>
|
||||
<li>localreturntype</li>
|
||||
<li>localvarformparams</li>
|
||||
<li>break</li>
|
||||
<li>volatile</li>
|
||||
<li>localvarauthnames</li>
|
||||
<li>abstract</li>
|
||||
<li>int</li>
|
||||
<li>if</li>
|
||||
<li>implements</li>
|
||||
<li>import</li>
|
||||
<li>instanceof</li>
|
||||
<li>super</li>
|
||||
<li>boolean</li>
|
||||
<li>throw</li>
|
||||
<li>int</li>
|
||||
<li>interface</li>
|
||||
<li>localreturntype</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>char</li>
|
||||
<li>short</li>
|
||||
<li>localvarqueryparams</li>
|
||||
<li>long</li>
|
||||
<li>native</li>
|
||||
<li>new</li>
|
||||
<li>null</li>
|
||||
<li>object</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>
|
||||
|
||||
@ -5,67 +5,67 @@ sidebar_label: java-vertx
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|modelPackage|package for generated models| |org.openapitools.server.api.model|
|
||||
|apiPackage|package for generated api classes| |org.openapitools.server.api.verticle|
|
||||
|invokerPackage|root package for generated code| |org.openapitools|
|
||||
|groupId|groupId in generated pom.xml| |org.openapitools|
|
||||
|artifactId|artifactId in generated pom.xml. This also becomes part of the generated library's filename| |openapi-java-vertx-server|
|
||||
|artifactVersion|artifact version in generated pom.xml. This also becomes part of the generated library's filename| |1.0.0-SNAPSHOT|
|
||||
|artifactUrl|artifact URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
|artifactDescription|artifact description in generated pom.xml| |OpenAPI Java|
|
||||
|artifactId|artifactId in generated pom.xml. This also becomes part of the generated library's filename| |openapi-java-vertx-server|
|
||||
|artifactUrl|artifact URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
|artifactVersion|artifact version in generated pom.xml. This also becomes part of the generated library's filename| |1.0.0-SNAPSHOT|
|
||||
|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false|
|
||||
|booleanGetterPrefix|Set booleanGetterPrefix| |get|
|
||||
|dateLibrary|Option. Date library to use|<dl><dt>**joda**</dt><dd>Joda (for legacy app only)</dd><dt>**legacy**</dt><dd>Legacy java.util.Date (if you really have a good reason not to use threetenbp</dd><dt>**java8-localdatetime**</dt><dd>Java 8 using LocalDateTime (for legacy app only)</dd><dt>**java8**</dt><dd>Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true</dd><dt>**threetenbp**</dt><dd>Backport of JSR310 (preferred for jdk < 1.8)</dd><dl>|java8|
|
||||
|developerEmail|developer email in generated pom.xml| |team@openapitools.org|
|
||||
|developerName|developer name in generated pom.xml| |OpenAPI-Generator Contributors|
|
||||
|developerOrganization|developer organization in generated pom.xml| |OpenAPITools.org|
|
||||
|developerOrganizationUrl|developer organization URL in generated pom.xml| |http://openapitools.org|
|
||||
|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false|
|
||||
|groupId|groupId in generated pom.xml| |org.openapitools|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |false|
|
||||
|invokerPackage|root package for generated code| |org.openapitools|
|
||||
|java8|Option. Use Java8 classes instead of third party equivalents|<dl><dt>**true**</dt><dd>Use Java 8 classes such as Base64</dd><dt>**false**</dt><dd>Various third party libraries as needed</dd><dl>|false|
|
||||
|licenseName|The name of the license| |Unlicense|
|
||||
|licenseUrl|The URL of the license| |http://unlicense.org|
|
||||
|modelPackage|package for generated models| |org.openapitools.server.api.model|
|
||||
|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|rxInterface|When specified, API interfaces are generated with RX and methods return Single<> and Comparable.| |false|
|
||||
|rxVersion2|When specified in combination with rxInterface, API interfaces are generated with RxJava2.| |false|
|
||||
|scmConnection|SCM connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git|
|
||||
|scmDeveloperConnection|SCM developer connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git|
|
||||
|scmUrl|SCM URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
|developerName|developer name in generated pom.xml| |OpenAPI-Generator Contributors|
|
||||
|developerEmail|developer email in generated pom.xml| |team@openapitools.org|
|
||||
|developerOrganization|developer organization in generated pom.xml| |OpenAPITools.org|
|
||||
|developerOrganizationUrl|developer organization URL in generated pom.xml| |http://openapitools.org|
|
||||
|licenseName|The name of the license| |Unlicense|
|
||||
|licenseUrl|The URL of the license| |http://unlicense.org|
|
||||
|sourceFolder|source folder for generated code| |src/main/java|
|
||||
|serializableModel|boolean - toggle "implements Serializable" for generated models| |false|
|
||||
|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false|
|
||||
|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |false|
|
||||
|withXml|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)| |false|
|
||||
|dateLibrary|Option. Date library to use|<dl><dt>**joda**</dt><dd>Joda (for legacy app only)</dd><dt>**legacy**</dt><dd>Legacy java.util.Date (if you really have a good reason not to use threetenbp</dd><dt>**java8-localdatetime**</dt><dd>Java 8 using LocalDateTime (for legacy app only)</dd><dt>**java8**</dt><dd>Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true</dd><dt>**threetenbp**</dt><dd>Backport of JSR310 (preferred for jdk < 1.8)</dd><dl>|java8|
|
||||
|java8|Option. Use Java8 classes instead of third party equivalents|<dl><dt>**true**</dt><dd>Use Java 8 classes such as Base64</dd><dt>**false**</dt><dd>Various third party libraries as needed</dd><dl>|false|
|
||||
|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false|
|
||||
|booleanGetterPrefix|Set booleanGetterPrefix| |get|
|
||||
|additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null|
|
||||
|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|snapshotVersion|Uses a SNAPSHOT version.|<dl><dt>**true**</dt><dd>Use a SnapShot Version</dd><dt>**false**</dt><dd>Use a Release Version</dd><dl>|null|
|
||||
|rxInterface|When specified, API interfaces are generated with RX and methods return Single<> and Comparable.| |false|
|
||||
|rxVersion2|When specified in combination with rxInterface, API interfaces are generated with RxJava2.| |false|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sourceFolder|source folder for generated code| |src/main/java|
|
||||
|vertxSwaggerRouterVersion|Specify the version of the swagger router library| |null|
|
||||
|withXml|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)| |false|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|Set|java.util.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|HashMap|java.util.HashMap|
|
||||
|Array|java.util.List|
|
||||
|ArrayList|java.util.ArrayList|
|
||||
|URI|java.net.URI|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|BigDecimal|java.math.BigDecimal|
|
||||
|Date|java.util.Date|
|
||||
|DateTime|org.joda.time.*|
|
||||
|Array|java.util.List|
|
||||
|List|java.util.*|
|
||||
|UUID|java.util.UUID|
|
||||
|File|java.io.File|
|
||||
|HashMap|java.util.HashMap|
|
||||
|List|java.util.*|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|Map|java.util.Map|
|
||||
|Set|java.util.*|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|URI|java.net.URI|
|
||||
|UUID|java.util.UUID|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
@ -78,87 +78,87 @@ sidebar_label: java-vertx
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>Integer</li>
|
||||
<li>byte[]</li>
|
||||
<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>Boolean</li>
|
||||
<li>Double</li>
|
||||
<li>Float</li>
|
||||
<li>boolean</li>
|
||||
<li>Integer</li>
|
||||
<li>Long</li>
|
||||
<li>Object</li>
|
||||
<li>String</li>
|
||||
<li>Boolean</li>
|
||||
<li>Double</li>
|
||||
<li>boolean</li>
|
||||
<li>byte[]</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>localvaraccepts</li>
|
||||
<li>synchronized</li>
|
||||
<li>do</li>
|
||||
<li>float</li>
|
||||
<li>while</li>
|
||||
<li>localvarpath</li>
|
||||
<li>protected</li>
|
||||
<li>continue</li>
|
||||
<li>else</li>
|
||||
<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>abstract</li>
|
||||
<li>apiclient</li>
|
||||
<li>localvarqueryparams</li>
|
||||
<li>catch</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>new</li>
|
||||
<li>package</li>
|
||||
<li>static</li>
|
||||
<li>void</li>
|
||||
<li>localvaraccept</li>
|
||||
<li>double</li>
|
||||
<li>apiexception</li>
|
||||
<li>apiresponse</li>
|
||||
<li>assert</li>
|
||||
<li>boolean</li>
|
||||
<li>break</li>
|
||||
<li>byte</li>
|
||||
<li>finally</li>
|
||||
<li>this</li>
|
||||
<li>strictfp</li>
|
||||
<li>throws</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>null</li>
|
||||
<li>transient</li>
|
||||
<li>apiexception</li>
|
||||
<li>final</li>
|
||||
<li>try</li>
|
||||
<li>object</li>
|
||||
<li>localvarcontenttypes</li>
|
||||
<li>implements</li>
|
||||
<li>private</li>
|
||||
<li>import</li>
|
||||
<li>const</li>
|
||||
<li>configuration</li>
|
||||
<li>finally</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>apiresponse</li>
|
||||
<li>interface</li>
|
||||
<li>long</li>
|
||||
<li>switch</li>
|
||||
<li>default</li>
|
||||
<li>goto</li>
|
||||
<li>public</li>
|
||||
<li>localvarheaderparams</li>
|
||||
<li>native</li>
|
||||
<li>localvarcontenttype</li>
|
||||
<li>assert</li>
|
||||
<li>stringutil</li>
|
||||
<li>class</li>
|
||||
<li>localvarcollectionqueryparams</li>
|
||||
<li>localvarcookieparams</li>
|
||||
<li>localreturntype</li>
|
||||
<li>localvarformparams</li>
|
||||
<li>break</li>
|
||||
<li>volatile</li>
|
||||
<li>localvarauthnames</li>
|
||||
<li>abstract</li>
|
||||
<li>int</li>
|
||||
<li>if</li>
|
||||
<li>implements</li>
|
||||
<li>import</li>
|
||||
<li>instanceof</li>
|
||||
<li>super</li>
|
||||
<li>boolean</li>
|
||||
<li>throw</li>
|
||||
<li>int</li>
|
||||
<li>interface</li>
|
||||
<li>localreturntype</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>char</li>
|
||||
<li>short</li>
|
||||
<li>localvarqueryparams</li>
|
||||
<li>long</li>
|
||||
<li>native</li>
|
||||
<li>new</li>
|
||||
<li>null</li>
|
||||
<li>object</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>
|
||||
|
||||
@ -5,79 +5,79 @@ sidebar_label: java
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|modelPackage|package for generated models| |org.openapitools.client.model|
|
||||
|apiPackage|package for generated api classes| |org.openapitools.client.api|
|
||||
|invokerPackage|root package for generated code| |org.openapitools.client|
|
||||
|groupId|groupId in generated pom.xml| |org.openapitools|
|
||||
|artifactId|artifactId in generated pom.xml. This also becomes part of the generated library's filename| |openapi-java-client|
|
||||
|artifactVersion|artifact version in generated pom.xml. This also becomes part of the generated library's filename| |1.0.0|
|
||||
|artifactUrl|artifact URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
|artifactDescription|artifact description in generated pom.xml| |OpenAPI Java|
|
||||
|artifactId|artifactId in generated pom.xml. This also becomes part of the generated library's filename| |openapi-java-client|
|
||||
|artifactUrl|artifact URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
|artifactVersion|artifact version in generated pom.xml. This also becomes part of the generated library's filename| |1.0.0|
|
||||
|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false|
|
||||
|booleanGetterPrefix|Set booleanGetterPrefix| |get|
|
||||
|caseInsensitiveResponseHeaders|Make API response's headers case-insensitive. Available on okhttp-gson, jersey2 libraries| |false|
|
||||
|dateLibrary|Option. Date library to use|<dl><dt>**joda**</dt><dd>Joda (for legacy app only)</dd><dt>**legacy**</dt><dd>Legacy java.util.Date (if you really have a good reason not to use threetenbp</dd><dt>**java8-localdatetime**</dt><dd>Java 8 using LocalDateTime (for legacy app only)</dd><dt>**java8**</dt><dd>Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true</dd><dt>**threetenbp**</dt><dd>Backport of JSR310 (preferred for jdk < 1.8)</dd><dl>|threetenbp|
|
||||
|developerEmail|developer email in generated pom.xml| |team@openapitools.org|
|
||||
|developerName|developer name in generated pom.xml| |OpenAPI-Generator Contributors|
|
||||
|developerOrganization|developer organization in generated pom.xml| |OpenAPITools.org|
|
||||
|developerOrganizationUrl|developer organization URL in generated pom.xml| |http://openapitools.org|
|
||||
|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|feignVersion|Version of OpenFeign: '10.x', '9.x' (default)| |false|
|
||||
|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false|
|
||||
|groupId|groupId in generated pom.xml| |org.openapitools|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |false|
|
||||
|invokerPackage|root package for generated code| |org.openapitools.client|
|
||||
|java8|Option. Use Java8 classes instead of third party equivalents|<dl><dt>**true**</dt><dd>Use Java 8 classes such as Base64</dd><dt>**false**</dt><dd>Various third party libraries as needed</dd><dl>|false|
|
||||
|library|library template (sub-template) to use|<dl><dt>**jersey1**</dt><dd>HTTP client: Jersey client 1.19.x. JSON processing: Jackson 2.9.x. Enable Java6 support using '-DsupportJava6=true'. Enable gzip request encoding using '-DuseGzipFeature=true'. IMPORTANT NOTE: jersey 1.x is no longer actively maintained so please upgrade to 'jersey2' or other HTTP libaries instead.</dd><dt>**jersey2**</dt><dd>HTTP client: Jersey client 2.25.1. JSON processing: Jackson 2.9.x</dd><dt>**feign**</dt><dd>HTTP client: OpenFeign 9.x or 10.x. JSON processing: Jackson 2.9.x. To enable OpenFeign 10.x, set the 'feignVersion' option to '10.x'</dd><dt>**okhttp-gson**</dt><dd>[DEFAULT] HTTP client: OkHttp 3.x. JSON processing: Gson 2.8.x. Enable Parcelable models on Android using '-DparcelableModel=true'. Enable gzip request encoding using '-DuseGzipFeature=true'.</dd><dt>**retrofit**</dt><dd>HTTP client: OkHttp 2.x. JSON processing: Gson 2.x (Retrofit 1.9.0). IMPORTANT NOTE: retrofit1.x is no longer actively maintained so please upgrade to 'retrofit2' instead.</dd><dt>**retrofit2**</dt><dd>HTTP client: OkHttp 3.x. JSON processing: Gson 2.x (Retrofit 2.3.0). Enable the RxJava adapter using '-DuseRxJava[2]=true'. (RxJava 1.x or 2.x)</dd><dt>**resttemplate**</dt><dd>HTTP client: Spring RestTemplate 4.x. JSON processing: Jackson 2.9.x</dd><dt>**webclient**</dt><dd>HTTP client: Spring WebClient 5.x. JSON processing: Jackson 2.9.x</dd><dt>**resteasy**</dt><dd>HTTP client: Resteasy client 3.x. JSON processing: Jackson 2.9.x</dd><dt>**vertx**</dt><dd>HTTP client: VertX client 3.x. JSON processing: Jackson 2.9.x</dd><dt>**google-api-client**</dt><dd>HTTP client: Google API client 1.x. JSON processing: Jackson 2.9.x</dd><dt>**rest-assured**</dt><dd>HTTP client: rest-assured : 4.x. JSON processing: Gson 2.x or Jackson 2.9.x. Only for Java8</dd><dt>**native**</dt><dd>HTTP client: Java native HttpClient. JSON processing: Jackson 2.9.x. Only for Java11+</dd><dt>**microprofile**</dt><dd>HTTP client: Microprofile client X.x. JSON processing: Jackson 2.9.x</dd><dl>|okhttp-gson|
|
||||
|licenseName|The name of the license| |Unlicense|
|
||||
|licenseUrl|The URL of the license| |http://unlicense.org|
|
||||
|modelPackage|package for generated models| |org.openapitools.client.model|
|
||||
|parcelableModel|Whether to generate models for Android that implement Parcelable with the okhttp-gson library.| |false|
|
||||
|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|performBeanValidation|Perform BeanValidation| |false|
|
||||
|playVersion|Version of Play! Framework (possible values "play24", "play25" (default), "play26")| |null|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|scmConnection|SCM connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git|
|
||||
|scmDeveloperConnection|SCM developer connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git|
|
||||
|scmUrl|SCM URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
|developerName|developer name in generated pom.xml| |OpenAPI-Generator Contributors|
|
||||
|developerEmail|developer email in generated pom.xml| |team@openapitools.org|
|
||||
|developerOrganization|developer organization in generated pom.xml| |OpenAPITools.org|
|
||||
|developerOrganizationUrl|developer organization URL in generated pom.xml| |http://openapitools.org|
|
||||
|licenseName|The name of the license| |Unlicense|
|
||||
|licenseUrl|The URL of the license| |http://unlicense.org|
|
||||
|sourceFolder|source folder for generated code| |src/main/java|
|
||||
|serializableModel|boolean - toggle "implements Serializable" for generated models| |false|
|
||||
|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false|
|
||||
|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |false|
|
||||
|withXml|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)| |false|
|
||||
|dateLibrary|Option. Date library to use|<dl><dt>**joda**</dt><dd>Joda (for legacy app only)</dd><dt>**legacy**</dt><dd>Legacy java.util.Date (if you really have a good reason not to use threetenbp</dd><dt>**java8-localdatetime**</dt><dd>Java 8 using LocalDateTime (for legacy app only)</dd><dt>**java8**</dt><dd>Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true</dd><dt>**threetenbp**</dt><dd>Backport of JSR310 (preferred for jdk < 1.8)</dd><dl>|threetenbp|
|
||||
|java8|Option. Use Java8 classes instead of third party equivalents|<dl><dt>**true**</dt><dd>Use Java 8 classes such as Base64</dd><dt>**false**</dt><dd>Various third party libraries as needed</dd><dl>|false|
|
||||
|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false|
|
||||
|booleanGetterPrefix|Set booleanGetterPrefix| |get|
|
||||
|additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null|
|
||||
|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|serializationLibrary|Serialization library, default depends from the library|<dl><dt>**jackson**</dt><dd>Use Jackson as serialization library</dd><dt>**gson**</dt><dd>Use Gson as serialization library</dd><dl>|null|
|
||||
|snapshotVersion|Uses a SNAPSHOT version.|<dl><dt>**true**</dt><dd>Use a SnapShot Version</dd><dt>**false**</dt><dd>Use a Release Version</dd><dl>|null|
|
||||
|useRxJava|Whether to use the RxJava adapter with the retrofit2 library.| |false|
|
||||
|useRxJava2|Whether to use the RxJava2 adapter with the retrofit2 library.| |false|
|
||||
|parcelableModel|Whether to generate models for Android that implement Parcelable with the okhttp-gson library.| |false|
|
||||
|usePlayWS|Use Play! Async HTTP client (Play WS API)| |false|
|
||||
|playVersion|Version of Play! Framework (possible values "play24", "play25" (default), "play26")| |null|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sourceFolder|source folder for generated code| |src/main/java|
|
||||
|supportJava6|Whether to support Java6 with the Jersey1 library.| |false|
|
||||
|useBeanValidation|Use BeanValidation API annotations| |false|
|
||||
|performBeanValidation|Perform BeanValidation| |false|
|
||||
|useGzipFeature|Send gzip-encoded requests| |false|
|
||||
|useRuntimeException|Use RuntimeException instead of Exception| |false|
|
||||
|feignVersion|Version of OpenFeign: '10.x', '9.x' (default)| |false|
|
||||
|usePlayWS|Use Play! Async HTTP client (Play WS API)| |false|
|
||||
|useReflectionEqualsHashCode|Use org.apache.commons.lang3.builder for equals and hashCode in the models. WARNING: This will fail under a security manager, unless the appropriate permissions are set up correctly and also there's potential performance impact.| |false|
|
||||
|caseInsensitiveResponseHeaders|Make API response's headers case-insensitive. Available on okhttp-gson, jersey2 libraries| |false|
|
||||
|library|library template (sub-template) to use|<dl><dt>**jersey1**</dt><dd>HTTP client: Jersey client 1.19.x. JSON processing: Jackson 2.9.x. Enable Java6 support using '-DsupportJava6=true'. Enable gzip request encoding using '-DuseGzipFeature=true'. IMPORTANT NOTE: jersey 1.x is no longer actively maintained so please upgrade to 'jersey2' or other HTTP libaries instead.</dd><dt>**jersey2**</dt><dd>HTTP client: Jersey client 2.25.1. JSON processing: Jackson 2.9.x</dd><dt>**feign**</dt><dd>HTTP client: OpenFeign 9.x or 10.x. JSON processing: Jackson 2.9.x. To enable OpenFeign 10.x, set the 'feignVersion' option to '10.x'</dd><dt>**okhttp-gson**</dt><dd>[DEFAULT] HTTP client: OkHttp 3.x. JSON processing: Gson 2.8.x. Enable Parcelable models on Android using '-DparcelableModel=true'. Enable gzip request encoding using '-DuseGzipFeature=true'.</dd><dt>**retrofit**</dt><dd>HTTP client: OkHttp 2.x. JSON processing: Gson 2.x (Retrofit 1.9.0). IMPORTANT NOTE: retrofit1.x is no longer actively maintained so please upgrade to 'retrofit2' instead.</dd><dt>**retrofit2**</dt><dd>HTTP client: OkHttp 3.x. JSON processing: Gson 2.x (Retrofit 2.3.0). Enable the RxJava adapter using '-DuseRxJava[2]=true'. (RxJava 1.x or 2.x)</dd><dt>**resttemplate**</dt><dd>HTTP client: Spring RestTemplate 4.x. JSON processing: Jackson 2.9.x</dd><dt>**webclient**</dt><dd>HTTP client: Spring WebClient 5.x. JSON processing: Jackson 2.9.x</dd><dt>**resteasy**</dt><dd>HTTP client: Resteasy client 3.x. JSON processing: Jackson 2.9.x</dd><dt>**vertx**</dt><dd>HTTP client: VertX client 3.x. JSON processing: Jackson 2.9.x</dd><dt>**google-api-client**</dt><dd>HTTP client: Google API client 1.x. JSON processing: Jackson 2.9.x</dd><dt>**rest-assured**</dt><dd>HTTP client: rest-assured : 4.x. JSON processing: Gson 2.x or Jackson 2.9.x. Only for Java8</dd><dt>**native**</dt><dd>HTTP client: Java native HttpClient. JSON processing: Jackson 2.9.x. Only for Java11+</dd><dt>**microprofile**</dt><dd>HTTP client: Microprofile client X.x. JSON processing: Jackson 2.9.x</dd><dl>|okhttp-gson|
|
||||
|serializationLibrary|Serialization library, default depends from the library|<dl><dt>**jackson**</dt><dd>Use Jackson as serialization library</dd><dt>**gson**</dt><dd>Use Gson as serialization library</dd><dl>|null|
|
||||
|useRuntimeException|Use RuntimeException instead of Exception| |false|
|
||||
|useRxJava|Whether to use the RxJava adapter with the retrofit2 library.| |false|
|
||||
|useRxJava2|Whether to use the RxJava2 adapter with the retrofit2 library.| |false|
|
||||
|withXml|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)| |false|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|Set|java.util.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|HashMap|java.util.HashMap|
|
||||
|Array|java.util.List|
|
||||
|ArrayList|java.util.ArrayList|
|
||||
|URI|java.net.URI|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|BigDecimal|java.math.BigDecimal|
|
||||
|Date|java.util.Date|
|
||||
|DateTime|org.joda.time.*|
|
||||
|Array|java.util.List|
|
||||
|List|java.util.*|
|
||||
|UUID|java.util.UUID|
|
||||
|File|java.io.File|
|
||||
|HashMap|java.util.HashMap|
|
||||
|List|java.util.*|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|Map|java.util.Map|
|
||||
|Set|java.util.*|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|URI|java.net.URI|
|
||||
|UUID|java.util.UUID|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
@ -90,87 +90,87 @@ sidebar_label: java
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>Integer</li>
|
||||
<li>byte[]</li>
|
||||
<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>Boolean</li>
|
||||
<li>Double</li>
|
||||
<li>Float</li>
|
||||
<li>boolean</li>
|
||||
<li>Integer</li>
|
||||
<li>Long</li>
|
||||
<li>Object</li>
|
||||
<li>String</li>
|
||||
<li>Boolean</li>
|
||||
<li>Double</li>
|
||||
<li>boolean</li>
|
||||
<li>byte[]</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>localvaraccepts</li>
|
||||
<li>synchronized</li>
|
||||
<li>do</li>
|
||||
<li>float</li>
|
||||
<li>while</li>
|
||||
<li>localvarpath</li>
|
||||
<li>protected</li>
|
||||
<li>continue</li>
|
||||
<li>else</li>
|
||||
<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>abstract</li>
|
||||
<li>apiclient</li>
|
||||
<li>localvarqueryparams</li>
|
||||
<li>catch</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>new</li>
|
||||
<li>package</li>
|
||||
<li>static</li>
|
||||
<li>void</li>
|
||||
<li>localvaraccept</li>
|
||||
<li>double</li>
|
||||
<li>apiexception</li>
|
||||
<li>apiresponse</li>
|
||||
<li>assert</li>
|
||||
<li>boolean</li>
|
||||
<li>break</li>
|
||||
<li>byte</li>
|
||||
<li>finally</li>
|
||||
<li>this</li>
|
||||
<li>strictfp</li>
|
||||
<li>throws</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>null</li>
|
||||
<li>transient</li>
|
||||
<li>apiexception</li>
|
||||
<li>final</li>
|
||||
<li>try</li>
|
||||
<li>object</li>
|
||||
<li>localvarcontenttypes</li>
|
||||
<li>implements</li>
|
||||
<li>private</li>
|
||||
<li>import</li>
|
||||
<li>const</li>
|
||||
<li>configuration</li>
|
||||
<li>finally</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>apiresponse</li>
|
||||
<li>interface</li>
|
||||
<li>long</li>
|
||||
<li>switch</li>
|
||||
<li>default</li>
|
||||
<li>goto</li>
|
||||
<li>public</li>
|
||||
<li>localvarheaderparams</li>
|
||||
<li>native</li>
|
||||
<li>localvarcontenttype</li>
|
||||
<li>assert</li>
|
||||
<li>stringutil</li>
|
||||
<li>class</li>
|
||||
<li>localvarcollectionqueryparams</li>
|
||||
<li>localvarcookieparams</li>
|
||||
<li>localreturntype</li>
|
||||
<li>localvarformparams</li>
|
||||
<li>break</li>
|
||||
<li>volatile</li>
|
||||
<li>localvarauthnames</li>
|
||||
<li>abstract</li>
|
||||
<li>int</li>
|
||||
<li>if</li>
|
||||
<li>implements</li>
|
||||
<li>import</li>
|
||||
<li>instanceof</li>
|
||||
<li>super</li>
|
||||
<li>boolean</li>
|
||||
<li>throw</li>
|
||||
<li>int</li>
|
||||
<li>interface</li>
|
||||
<li>localreturntype</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>char</li>
|
||||
<li>short</li>
|
||||
<li>localvarqueryparams</li>
|
||||
<li>long</li>
|
||||
<li>native</li>
|
||||
<li>new</li>
|
||||
<li>null</li>
|
||||
<li>object</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>
|
||||
|
||||
@ -5,12 +5,12 @@ sidebar_label: javascript-closure-angular
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|useEs6|use ES6 templates| |false|
|
||||
|
||||
## IMPORT MAPPING
|
||||
@ -28,58 +28,58 @@ sidebar_label: javascript-closure-angular
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>number</li>
|
||||
<li>Blob</li>
|
||||
<li>boolean</li>
|
||||
<li>string</li>
|
||||
<li>Object</li>
|
||||
<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>Blob</li>
|
||||
<li>Date</li>
|
||||
<li>Object</li>
|
||||
<li>boolean</li>
|
||||
<li>number</li>
|
||||
<li>string</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>implements</li>
|
||||
<li>synchronized</li>
|
||||
<li>private</li>
|
||||
<li>import</li>
|
||||
<li>const</li>
|
||||
<li>for</li>
|
||||
<li>do</li>
|
||||
<li>interface</li>
|
||||
<li>while</li>
|
||||
<li>switch</li>
|
||||
<li>default</li>
|
||||
<li>goto</li>
|
||||
<li>protected</li>
|
||||
<li>public</li>
|
||||
<li>continue</li>
|
||||
<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>abstract</li>
|
||||
<li>assert</li>
|
||||
<li>else</li>
|
||||
<li>catch</li>
|
||||
<li>if</li>
|
||||
<li>class</li>
|
||||
<li>break</li>
|
||||
<li>byte</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>char</li>
|
||||
<li>class</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>final</li>
|
||||
<li>finally</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>new</li>
|
||||
<li>package</li>
|
||||
<li>static</li>
|
||||
<li>void</li>
|
||||
<li>break</li>
|
||||
<li>double</li>
|
||||
<li>byte</li>
|
||||
<li>finally</li>
|
||||
<li>this</li>
|
||||
<li>abstract</li>
|
||||
<li>throws</li>
|
||||
<li>enum</li>
|
||||
<li>int</li>
|
||||
<li>instanceof</li>
|
||||
<li>super</li>
|
||||
<li>extends</li>
|
||||
<li>throw</li>
|
||||
<li>transient</li>
|
||||
<li>char</li>
|
||||
<li>final</li>
|
||||
<li>short</li>
|
||||
<li>try</li>
|
||||
<li>private</li>
|
||||
<li>protected</li>
|
||||
<li>public</li>
|
||||
<li>return</li>
|
||||
<li>short</li>
|
||||
<li>static</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>while</li>
|
||||
</ul>
|
||||
|
||||
@ -5,17 +5,17 @@ sidebar_label: javascript-flowtyped
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|modelPropertyNaming|Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |camelCase|
|
||||
|supportsES6|Generate code that conforms to ES6.| |false|
|
||||
|npmName|The name under which you want to publish generated npm package. Required to generate a full package| |null|
|
||||
|npmVersion|The version of your npm package. If not provided, using the version from the OpenAPI specification file.| |1.0.0|
|
||||
|snapshot|When setting this property to true, the version will be suffixed with -SNAPSHOT.yyyyMMddHHmm| |false|
|
||||
|npmRepository|Use this property to set an url your private npmRepo in the package.json| |null|
|
||||
|npmVersion|The version of your npm package. If not provided, using the version from the OpenAPI specification file.| |1.0.0|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|snapshot|When setting this property to true, the version will be suffixed with -SNAPSHOT.yyyyMMddHHmm| |false|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|supportsES6|Generate code that conforms to ES6.| |false|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
@ -35,101 +35,101 @@ sidebar_label: javascript-flowtyped
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>Array</li>
|
||||
<li>number</li>
|
||||
<li>Blob</li>
|
||||
<li>boolean</li>
|
||||
<li>string</li>
|
||||
<li>Object</li>
|
||||
<li>File</li>
|
||||
<li>Date</li>
|
||||
<li>File</li>
|
||||
<li>Object</li>
|
||||
<li>boolean</li>
|
||||
<li>number</li>
|
||||
<li>string</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>date</li>
|
||||
<li>synchronized</li>
|
||||
<li>requestoptions</li>
|
||||
<li>debugger</li>
|
||||
<li>isfinite</li>
|
||||
<li>do</li>
|
||||
<li>float</li>
|
||||
<li>while</li>
|
||||
<li>hasownproperty</li>
|
||||
<li>number</li>
|
||||
<li>protected</li>
|
||||
<li>continue</li>
|
||||
<li>else</li>
|
||||
<li>function</li>
|
||||
<li>let</li>
|
||||
<li>nan</li>
|
||||
<li>catch</li>
|
||||
<li>export</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>new</li>
|
||||
<li>package</li>
|
||||
<li>static</li>
|
||||
<li>void</li>
|
||||
<li>in</li>
|
||||
<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>abstract</li>
|
||||
<li>arguments</li>
|
||||
<li>array</li>
|
||||
<li>boolean</li>
|
||||
<li>break</li>
|
||||
<li>byte</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>char</li>
|
||||
<li>class</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>date</li>
|
||||
<li>debugger</li>
|
||||
<li>default</li>
|
||||
<li>delete</li>
|
||||
<li>do</li>
|
||||
<li>double</li>
|
||||
<li>var</li>
|
||||
<li>finally</li>
|
||||
<li>this</li>
|
||||
<li>isprototypeof</li>
|
||||
<li>throws</li>
|
||||
<li>formparams</li>
|
||||
<li>else</li>
|
||||
<li>enum</li>
|
||||
<li>headerparams</li>
|
||||
<li>varlocaldeferred</li>
|
||||
<li>useformdata</li>
|
||||
<li>eval</li>
|
||||
<li>export</li>
|
||||
<li>extends</li>
|
||||
<li>null</li>
|
||||
<li>transient</li>
|
||||
<li>false</li>
|
||||
<li>final</li>
|
||||
<li>finally</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>formparams</li>
|
||||
<li>function</li>
|
||||
<li>goto</li>
|
||||
<li>hasownproperty</li>
|
||||
<li>headerparams</li>
|
||||
<li>if</li>
|
||||
<li>implements</li>
|
||||
<li>import</li>
|
||||
<li>in</li>
|
||||
<li>infinity</li>
|
||||
<li>instanceof</li>
|
||||
<li>int</li>
|
||||
<li>interface</li>
|
||||
<li>isfinite</li>
|
||||
<li>isnan</li>
|
||||
<li>isprototypeof</li>
|
||||
<li>let</li>
|
||||
<li>long</li>
|
||||
<li>math</li>
|
||||
<li>nan</li>
|
||||
<li>native</li>
|
||||
<li>new</li>
|
||||
<li>null</li>
|
||||
<li>number</li>
|
||||
<li>object</li>
|
||||
<li>package</li>
|
||||
<li>private</li>
|
||||
<li>protected</li>
|
||||
<li>prototype</li>
|
||||
<li>public</li>
|
||||
<li>queryparameters</li>
|
||||
<li>requestoptions</li>
|
||||
<li>return</li>
|
||||
<li>short</li>
|
||||
<li>static</li>
|
||||
<li>string</li>
|
||||
<li>super</li>
|
||||
<li>switch</li>
|
||||
<li>synchronized</li>
|
||||
<li>this</li>
|
||||
<li>throw</li>
|
||||
<li>throws</li>
|
||||
<li>tostring</li>
|
||||
<li>transient</li>
|
||||
<li>true</li>
|
||||
<li>try</li>
|
||||
<li>math</li>
|
||||
<li>varlocalpath</li>
|
||||
<li>object</li>
|
||||
<li>implements</li>
|
||||
<li>private</li>
|
||||
<li>const</li>
|
||||
<li>import</li>
|
||||
<li>string</li>
|
||||
<li>queryparameters</li>
|
||||
<li>valueof</li>
|
||||
<li>for</li>
|
||||
<li>interface</li>
|
||||
<li>isnan</li>
|
||||
<li>delete</li>
|
||||
<li>long</li>
|
||||
<li>switch</li>
|
||||
<li>undefined</li>
|
||||
<li>default</li>
|
||||
<li>goto</li>
|
||||
<li>public</li>
|
||||
<li>native</li>
|
||||
<li>array</li>
|
||||
<li>yield</li>
|
||||
<li>class</li>
|
||||
<li>typeof</li>
|
||||
<li>break</li>
|
||||
<li>false</li>
|
||||
<li>undefined</li>
|
||||
<li>useformdata</li>
|
||||
<li>valueof</li>
|
||||
<li>var</li>
|
||||
<li>varlocaldeferred</li>
|
||||
<li>varlocalpath</li>
|
||||
<li>void</li>
|
||||
<li>volatile</li>
|
||||
<li>abstract</li>
|
||||
<li>prototype</li>
|
||||
<li>int</li>
|
||||
<li>instanceof</li>
|
||||
<li>super</li>
|
||||
<li>while</li>
|
||||
<li>with</li>
|
||||
<li>boolean</li>
|
||||
<li>throw</li>
|
||||
<li>char</li>
|
||||
<li>short</li>
|
||||
<li>arguments</li>
|
||||
<li>infinity</li>
|
||||
<li>tostring</li>
|
||||
<li>return</li>
|
||||
<li>yield</li>
|
||||
</ul>
|
||||
|
||||
@ -5,28 +5,28 @@ sidebar_label: javascript
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|sourceFolder|source folder for generated code| |src|
|
||||
|invokerPackage|root package for generated code| |null|
|
||||
|apiPackage|package for generated api classes| |null|
|
||||
|modelPackage|package for generated models| |null|
|
||||
|projectName|name of the project (Default: generated from info.title or "openapi-js-client")| |null|
|
||||
|moduleName|module name for AMD, Node or globals (Default: generated from <projectName>)| |null|
|
||||
|projectDescription|description of the project (Default: using info.description or "Client library of <projectName>")| |null|
|
||||
|projectVersion|version of the project (Default: using info.version or "1.0.0")| |null|
|
||||
|licenseName|name of the license the project uses (Default: using info.license.name)| |null|
|
||||
|usePromises|use Promises as return values from the client API, instead of superagent callbacks| |false|
|
||||
|emitModelMethods|generate getters and setters for model properties| |false|
|
||||
|emitJSDoc|generate JSDoc comments| |true|
|
||||
|useInheritance|use JavaScript prototype chains & delegation for inheritance| |true|
|
||||
|emitModelMethods|generate getters and setters for model properties| |false|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true|
|
||||
|useES6|use JavaScript ES6 (ECMAScript 6) (beta). Default is ES6.| |true|
|
||||
|invokerPackage|root package for generated code| |null|
|
||||
|licenseName|name of the license the project uses (Default: using info.license.name)| |null|
|
||||
|modelPackage|package for generated models| |null|
|
||||
|modelPropertyNaming|Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |camelCase|
|
||||
|moduleName|module name for AMD, Node or globals (Default: generated from <projectName>)| |null|
|
||||
|npmRepository|Use this property to set an url your private npmRepo in the package.json| |null|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|projectDescription|description of the project (Default: using info.description or "Client library of <projectName>")| |null|
|
||||
|projectName|name of the project (Default: generated from info.title or "openapi-js-client")| |null|
|
||||
|projectVersion|version of the project (Default: using info.version or "1.0.0")| |null|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sourceFolder|source folder for generated code| |src|
|
||||
|useES6|use JavaScript ES6 (ECMAScript 6) (beta). Default is ES6.| |true|
|
||||
|useInheritance|use JavaScript prototype chains & delegation for inheritance| |true|
|
||||
|usePromises|use Promises as return values from the client API, instead of superagent callbacks| |false|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
@ -47,93 +47,93 @@ sidebar_label: javascript
|
||||
|
||||
<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>Array</li>
|
||||
<li>Blob</li>
|
||||
<li>Boolean</li>
|
||||
<li>Date</li>
|
||||
<li>File</li>
|
||||
<li>Number</li>
|
||||
<li>Object</li>
|
||||
<li>String</li>
|
||||
<li>Boolean</li>
|
||||
<li>File</li>
|
||||
<li>Date</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>date</li>
|
||||
<li>synchronized</li>
|
||||
<li>debugger</li>
|
||||
<li>isfinite</li>
|
||||
<li>do</li>
|
||||
<li>float</li>
|
||||
<li>while</li>
|
||||
<li>hasownproperty</li>
|
||||
<li>number</li>
|
||||
<li>protected</li>
|
||||
<li>continue</li>
|
||||
<li>else</li>
|
||||
<li>function</li>
|
||||
<li>let</li>
|
||||
<li>nan</li>
|
||||
<li>catch</li>
|
||||
<li>export</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>new</li>
|
||||
<li>package</li>
|
||||
<li>static</li>
|
||||
<li>void</li>
|
||||
<li>in</li>
|
||||
<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>abstract</li>
|
||||
<li>arguments</li>
|
||||
<li>array</li>
|
||||
<li>boolean</li>
|
||||
<li>break</li>
|
||||
<li>byte</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>char</li>
|
||||
<li>class</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>date</li>
|
||||
<li>debugger</li>
|
||||
<li>default</li>
|
||||
<li>delete</li>
|
||||
<li>do</li>
|
||||
<li>double</li>
|
||||
<li>var</li>
|
||||
<li>finally</li>
|
||||
<li>this</li>
|
||||
<li>isprototypeof</li>
|
||||
<li>throws</li>
|
||||
<li>else</li>
|
||||
<li>enum</li>
|
||||
<li>eval</li>
|
||||
<li>export</li>
|
||||
<li>extends</li>
|
||||
<li>null</li>
|
||||
<li>transient</li>
|
||||
<li>false</li>
|
||||
<li>final</li>
|
||||
<li>finally</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>function</li>
|
||||
<li>goto</li>
|
||||
<li>hasownproperty</li>
|
||||
<li>if</li>
|
||||
<li>implements</li>
|
||||
<li>import</li>
|
||||
<li>in</li>
|
||||
<li>infinity</li>
|
||||
<li>instanceof</li>
|
||||
<li>int</li>
|
||||
<li>interface</li>
|
||||
<li>isfinite</li>
|
||||
<li>isnan</li>
|
||||
<li>isprototypeof</li>
|
||||
<li>let</li>
|
||||
<li>long</li>
|
||||
<li>math</li>
|
||||
<li>nan</li>
|
||||
<li>native</li>
|
||||
<li>new</li>
|
||||
<li>null</li>
|
||||
<li>number</li>
|
||||
<li>object</li>
|
||||
<li>package</li>
|
||||
<li>private</li>
|
||||
<li>protected</li>
|
||||
<li>prototype</li>
|
||||
<li>public</li>
|
||||
<li>return</li>
|
||||
<li>short</li>
|
||||
<li>static</li>
|
||||
<li>string</li>
|
||||
<li>super</li>
|
||||
<li>switch</li>
|
||||
<li>synchronized</li>
|
||||
<li>this</li>
|
||||
<li>throw</li>
|
||||
<li>throws</li>
|
||||
<li>tostring</li>
|
||||
<li>transient</li>
|
||||
<li>true</li>
|
||||
<li>try</li>
|
||||
<li>math</li>
|
||||
<li>object</li>
|
||||
<li>implements</li>
|
||||
<li>private</li>
|
||||
<li>const</li>
|
||||
<li>import</li>
|
||||
<li>string</li>
|
||||
<li>valueof</li>
|
||||
<li>for</li>
|
||||
<li>interface</li>
|
||||
<li>isnan</li>
|
||||
<li>delete</li>
|
||||
<li>long</li>
|
||||
<li>switch</li>
|
||||
<li>undefined</li>
|
||||
<li>default</li>
|
||||
<li>goto</li>
|
||||
<li>public</li>
|
||||
<li>native</li>
|
||||
<li>array</li>
|
||||
<li>yield</li>
|
||||
<li>class</li>
|
||||
<li>typeof</li>
|
||||
<li>break</li>
|
||||
<li>false</li>
|
||||
<li>undefined</li>
|
||||
<li>valueof</li>
|
||||
<li>var</li>
|
||||
<li>void</li>
|
||||
<li>volatile</li>
|
||||
<li>abstract</li>
|
||||
<li>prototype</li>
|
||||
<li>int</li>
|
||||
<li>instanceof</li>
|
||||
<li>super</li>
|
||||
<li>while</li>
|
||||
<li>with</li>
|
||||
<li>boolean</li>
|
||||
<li>throw</li>
|
||||
<li>char</li>
|
||||
<li>short</li>
|
||||
<li>arguments</li>
|
||||
<li>infinity</li>
|
||||
<li>tostring</li>
|
||||
<li>return</li>
|
||||
<li>yield</li>
|
||||
</ul>
|
||||
|
||||
@ -5,75 +5,74 @@ sidebar_label: jaxrs-cxf-cdi
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|modelPackage|package for generated models| |org.openapitools.model|
|
||||
|apiPackage|package for generated api classes| |org.openapitools.api|
|
||||
|invokerPackage|root package for generated code| |org.openapitools.api|
|
||||
|groupId|groupId in generated pom.xml| |org.openapitools|
|
||||
|artifactId|artifactId in generated pom.xml. This also becomes part of the generated library's filename| |openapi-jaxrs-cxf-cdi-server|
|
||||
|artifactVersion|artifact version in generated pom.xml. This also becomes part of the generated library's filename| |1.0.0|
|
||||
|artifactUrl|artifact URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
|artifactDescription|artifact description in generated pom.xml| |OpenAPI Java|
|
||||
|artifactId|artifactId in generated pom.xml. This also becomes part of the generated library's filename| |openapi-jaxrs-cxf-cdi-server|
|
||||
|artifactUrl|artifact URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
|artifactVersion|artifact version in generated pom.xml. This also becomes part of the generated library's filename| |1.0.0|
|
||||
|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false|
|
||||
|booleanGetterPrefix|Set booleanGetterPrefix| |get|
|
||||
|dateLibrary|Option. Date library to use|<dl><dt>**joda**</dt><dd>Joda (for legacy app only)</dd><dt>**legacy**</dt><dd>Legacy java.util.Date (if you really have a good reason not to use threetenbp</dd><dt>**java8-localdatetime**</dt><dd>Java 8 using LocalDateTime (for legacy app only)</dd><dt>**java8**</dt><dd>Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true</dd><dt>**threetenbp**</dt><dd>Backport of JSR310 (preferred for jdk < 1.8)</dd><dl>|legacy|
|
||||
|developerEmail|developer email in generated pom.xml| |team@openapitools.org|
|
||||
|developerName|developer name in generated pom.xml| |OpenAPI-Generator Contributors|
|
||||
|developerOrganization|developer organization in generated pom.xml| |OpenAPITools.org|
|
||||
|developerOrganizationUrl|developer organization URL in generated pom.xml| |http://openapitools.org|
|
||||
|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false|
|
||||
|generatePom|Whether to generate pom.xml if the file does not already exist.| |true|
|
||||
|groupId|groupId in generated pom.xml| |org.openapitools|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |false|
|
||||
|implFolder|folder for generated implementation code| |src/main/java|
|
||||
|interfaceOnly|Whether to generate only API interface stubs without the server files.| |false|
|
||||
|invokerPackage|root package for generated code| |org.openapitools.api|
|
||||
|java8|Option. Use Java8 classes instead of third party equivalents|<dl><dt>**true**</dt><dd>Use Java 8 classes such as Base64</dd><dt>**false**</dt><dd>Various third party libraries as needed</dd><dl>|false|
|
||||
|library|library template (sub-template)|<dl><dt>**<default>**</dt><dd>JAXRS spec only, to be deployed in an app server (TomEE, JBoss, WLS, ...)</dd><dt>**quarkus**</dt><dd>Server using Quarkus</dd><dt>**thorntail**</dt><dd>Server using Thorntail</dd><dt>**openliberty**</dt><dd>Server using Open Liberty</dd><dt>**helidon**</dt><dd>Server using Helidon</dd><dl>|<default>|
|
||||
|licenseName|The name of the license| |Unlicense|
|
||||
|licenseUrl|The URL of the license| |http://unlicense.org|
|
||||
|modelPackage|package for generated models| |org.openapitools.model|
|
||||
|openApiSpecFileLocation|Location where the file containing the spec will be generated in the output folder. No file generated when set to null or empty string.| |null|
|
||||
|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|returnResponse|Whether generate API interface should return javax.ws.rs.core.Response instead of a deserialized entity. Only useful if interfaceOnly is true.| |false|
|
||||
|scmConnection|SCM connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git|
|
||||
|scmDeveloperConnection|SCM developer connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git|
|
||||
|scmUrl|SCM URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
|developerName|developer name in generated pom.xml| |OpenAPI-Generator Contributors|
|
||||
|developerEmail|developer email in generated pom.xml| |team@openapitools.org|
|
||||
|developerOrganization|developer organization in generated pom.xml| |OpenAPITools.org|
|
||||
|developerOrganizationUrl|developer organization URL in generated pom.xml| |http://openapitools.org|
|
||||
|licenseName|The name of the license| |Unlicense|
|
||||
|licenseUrl|The URL of the license| |http://unlicense.org|
|
||||
|sourceFolder|source folder for generated code| |src/gen/java|
|
||||
|serializableModel|boolean - toggle "implements Serializable" for generated models| |false|
|
||||
|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false|
|
||||
|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |false|
|
||||
|withXml|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)| |false|
|
||||
|dateLibrary|Option. Date library to use|<dl><dt>**joda**</dt><dd>Joda (for legacy app only)</dd><dt>**legacy**</dt><dd>Legacy java.util.Date (if you really have a good reason not to use threetenbp</dd><dt>**java8-localdatetime**</dt><dd>Java 8 using LocalDateTime (for legacy app only)</dd><dt>**java8**</dt><dd>Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true</dd><dt>**threetenbp**</dt><dd>Backport of JSR310 (preferred for jdk < 1.8)</dd><dl>|legacy|
|
||||
|java8|Option. Use Java8 classes instead of third party equivalents|<dl><dt>**true**</dt><dd>Use Java 8 classes such as Base64</dd><dt>**false**</dt><dd>Various third party libraries as needed</dd><dl>|false|
|
||||
|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false|
|
||||
|booleanGetterPrefix|Set booleanGetterPrefix| |get|
|
||||
|additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null|
|
||||
|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|serverPort|The port on which the server should be started| |8080|
|
||||
|snapshotVersion|Uses a SNAPSHOT version.|<dl><dt>**true**</dt><dd>Use a SnapShot Version</dd><dt>**false**</dt><dd>Use a Release Version</dd><dl>|null|
|
||||
|implFolder|folder for generated implementation code| |src/main/java|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sourceFolder|source folder for generated code| |src/gen/java|
|
||||
|title|a title describing the application| |OpenAPI Server|
|
||||
|useBeanValidation|Use BeanValidation API annotations| |true|
|
||||
|serverPort|The port on which the server should be started| |8080|
|
||||
|library|library template (sub-template)|<dl><dt>**<default>**</dt><dd>JAXRS spec only, to be deployed in an app server (TomEE, JBoss, WLS, ...)</dd><dt>**quarkus**</dt><dd>Server using Quarkus</dd><dt>**thorntail**</dt><dd>Server using Thorntail</dd><dt>**openliberty**</dt><dd>Server using Open Liberty</dd><dt>**helidon**</dt><dd>Server using Helidon</dd><dl>|<default>|
|
||||
|generatePom|Whether to generate pom.xml if the file does not already exist.| |true|
|
||||
|interfaceOnly|Whether to generate only API interface stubs without the server files.| |false|
|
||||
|returnResponse|Whether generate API interface should return javax.ws.rs.core.Response instead of a deserialized entity. Only useful if interfaceOnly is true.| |false|
|
||||
|useSwaggerAnnotations|Whether to generate Swagger annotations.| |true|
|
||||
|openApiSpecFileLocation|Location where the file containing the spec will be generated in the output folder. No file generated when set to null or empty string.| |null|
|
||||
|useBeanValidation|Use BeanValidation API annotations| |true|
|
||||
|withXml|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)| |false|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|Set|java.util.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|HashMap|java.util.HashMap|
|
||||
|Array|java.util.List|
|
||||
|ArrayList|java.util.ArrayList|
|
||||
|URI|java.net.URI|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|LocalDate|org.joda.time.LocalDate|
|
||||
|BigDecimal|java.math.BigDecimal|
|
||||
|Date|java.util.Date|
|
||||
|DateTime|org.joda.time.*|
|
||||
|Array|java.util.List|
|
||||
|List|java.util.*|
|
||||
|UUID|java.util.UUID|
|
||||
|File|java.io.File|
|
||||
|HashMap|java.util.HashMap|
|
||||
|List|java.util.*|
|
||||
|LocalDate|org.joda.time.LocalDate|
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|Map|java.util.Map|
|
||||
|Set|java.util.*|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|URI|java.net.URI|
|
||||
|UUID|java.util.UUID|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
@ -86,87 +85,87 @@ sidebar_label: jaxrs-cxf-cdi
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>Integer</li>
|
||||
<li>byte[]</li>
|
||||
<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>Boolean</li>
|
||||
<li>Double</li>
|
||||
<li>Float</li>
|
||||
<li>boolean</li>
|
||||
<li>Integer</li>
|
||||
<li>Long</li>
|
||||
<li>Object</li>
|
||||
<li>String</li>
|
||||
<li>Boolean</li>
|
||||
<li>Double</li>
|
||||
<li>boolean</li>
|
||||
<li>byte[]</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>localvaraccepts</li>
|
||||
<li>synchronized</li>
|
||||
<li>do</li>
|
||||
<li>float</li>
|
||||
<li>while</li>
|
||||
<li>localvarpath</li>
|
||||
<li>protected</li>
|
||||
<li>continue</li>
|
||||
<li>else</li>
|
||||
<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>abstract</li>
|
||||
<li>apiclient</li>
|
||||
<li>localvarqueryparams</li>
|
||||
<li>catch</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>new</li>
|
||||
<li>package</li>
|
||||
<li>static</li>
|
||||
<li>void</li>
|
||||
<li>localvaraccept</li>
|
||||
<li>double</li>
|
||||
<li>apiexception</li>
|
||||
<li>apiresponse</li>
|
||||
<li>assert</li>
|
||||
<li>boolean</li>
|
||||
<li>break</li>
|
||||
<li>byte</li>
|
||||
<li>finally</li>
|
||||
<li>this</li>
|
||||
<li>strictfp</li>
|
||||
<li>throws</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>null</li>
|
||||
<li>transient</li>
|
||||
<li>apiexception</li>
|
||||
<li>final</li>
|
||||
<li>try</li>
|
||||
<li>object</li>
|
||||
<li>localvarcontenttypes</li>
|
||||
<li>implements</li>
|
||||
<li>private</li>
|
||||
<li>import</li>
|
||||
<li>const</li>
|
||||
<li>configuration</li>
|
||||
<li>finally</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>apiresponse</li>
|
||||
<li>interface</li>
|
||||
<li>long</li>
|
||||
<li>switch</li>
|
||||
<li>default</li>
|
||||
<li>goto</li>
|
||||
<li>public</li>
|
||||
<li>localvarheaderparams</li>
|
||||
<li>native</li>
|
||||
<li>localvarcontenttype</li>
|
||||
<li>assert</li>
|
||||
<li>stringutil</li>
|
||||
<li>class</li>
|
||||
<li>localvarcollectionqueryparams</li>
|
||||
<li>localvarcookieparams</li>
|
||||
<li>localreturntype</li>
|
||||
<li>localvarformparams</li>
|
||||
<li>break</li>
|
||||
<li>volatile</li>
|
||||
<li>localvarauthnames</li>
|
||||
<li>abstract</li>
|
||||
<li>int</li>
|
||||
<li>if</li>
|
||||
<li>implements</li>
|
||||
<li>import</li>
|
||||
<li>instanceof</li>
|
||||
<li>super</li>
|
||||
<li>boolean</li>
|
||||
<li>throw</li>
|
||||
<li>int</li>
|
||||
<li>interface</li>
|
||||
<li>localreturntype</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>char</li>
|
||||
<li>short</li>
|
||||
<li>localvarqueryparams</li>
|
||||
<li>long</li>
|
||||
<li>native</li>
|
||||
<li>new</li>
|
||||
<li>null</li>
|
||||
<li>object</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>
|
||||
|
||||
@ -5,68 +5,68 @@ sidebar_label: jaxrs-cxf-client
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|modelPackage|package for generated models| |org.openapitools.model|
|
||||
|apiPackage|package for generated api classes| |org.openapitools.api|
|
||||
|invokerPackage|root package for generated code| |org.openapitools.api|
|
||||
|groupId|groupId in generated pom.xml| |org.openapitools|
|
||||
|artifactId|artifactId in generated pom.xml. This also becomes part of the generated library's filename| |openapi-jaxrs-client|
|
||||
|artifactVersion|artifact version in generated pom.xml. This also becomes part of the generated library's filename| |1.0.0|
|
||||
|artifactUrl|artifact URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
|artifactDescription|artifact description in generated pom.xml| |OpenAPI Java|
|
||||
|artifactId|artifactId in generated pom.xml. This also becomes part of the generated library's filename| |openapi-jaxrs-client|
|
||||
|artifactUrl|artifact URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
|artifactVersion|artifact version in generated pom.xml. This also becomes part of the generated library's filename| |1.0.0|
|
||||
|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false|
|
||||
|booleanGetterPrefix|Set booleanGetterPrefix| |get|
|
||||
|dateLibrary|Option. Date library to use|<dl><dt>**joda**</dt><dd>Joda (for legacy app only)</dd><dt>**legacy**</dt><dd>Legacy java.util.Date (if you really have a good reason not to use threetenbp</dd><dt>**java8-localdatetime**</dt><dd>Java 8 using LocalDateTime (for legacy app only)</dd><dt>**java8**</dt><dd>Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true</dd><dt>**threetenbp**</dt><dd>Backport of JSR310 (preferred for jdk < 1.8)</dd><dl>|legacy|
|
||||
|developerEmail|developer email in generated pom.xml| |team@openapitools.org|
|
||||
|developerName|developer name in generated pom.xml| |OpenAPI-Generator Contributors|
|
||||
|developerOrganization|developer organization in generated pom.xml| |OpenAPITools.org|
|
||||
|developerOrganizationUrl|developer organization URL in generated pom.xml| |http://openapitools.org|
|
||||
|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false|
|
||||
|groupId|groupId in generated pom.xml| |org.openapitools|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |false|
|
||||
|invokerPackage|root package for generated code| |org.openapitools.api|
|
||||
|java8|Option. Use Java8 classes instead of third party equivalents|<dl><dt>**true**</dt><dd>Use Java 8 classes such as Base64</dd><dt>**false**</dt><dd>Various third party libraries as needed</dd><dl>|false|
|
||||
|licenseName|The name of the license| |Unlicense|
|
||||
|licenseUrl|The URL of the license| |http://unlicense.org|
|
||||
|modelPackage|package for generated models| |org.openapitools.model|
|
||||
|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|scmConnection|SCM connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git|
|
||||
|scmDeveloperConnection|SCM developer connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git|
|
||||
|scmUrl|SCM URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
|developerName|developer name in generated pom.xml| |OpenAPI-Generator Contributors|
|
||||
|developerEmail|developer email in generated pom.xml| |team@openapitools.org|
|
||||
|developerOrganization|developer organization in generated pom.xml| |OpenAPITools.org|
|
||||
|developerOrganizationUrl|developer organization URL in generated pom.xml| |http://openapitools.org|
|
||||
|licenseName|The name of the license| |Unlicense|
|
||||
|licenseUrl|The URL of the license| |http://unlicense.org|
|
||||
|sourceFolder|source folder for generated code| |src/gen/java|
|
||||
|serializableModel|boolean - toggle "implements Serializable" for generated models| |false|
|
||||
|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false|
|
||||
|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |false|
|
||||
|withXml|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)| |false|
|
||||
|dateLibrary|Option. Date library to use|<dl><dt>**joda**</dt><dd>Joda (for legacy app only)</dd><dt>**legacy**</dt><dd>Legacy java.util.Date (if you really have a good reason not to use threetenbp</dd><dt>**java8-localdatetime**</dt><dd>Java 8 using LocalDateTime (for legacy app only)</dd><dt>**java8**</dt><dd>Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true</dd><dt>**threetenbp**</dt><dd>Backport of JSR310 (preferred for jdk < 1.8)</dd><dl>|legacy|
|
||||
|java8|Option. Use Java8 classes instead of third party equivalents|<dl><dt>**true**</dt><dd>Use Java 8 classes such as Base64</dd><dt>**false**</dt><dd>Various third party libraries as needed</dd><dl>|false|
|
||||
|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false|
|
||||
|booleanGetterPrefix|Set booleanGetterPrefix| |get|
|
||||
|additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null|
|
||||
|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|snapshotVersion|Uses a SNAPSHOT version.|<dl><dt>**true**</dt><dd>Use a SnapShot Version</dd><dt>**false**</dt><dd>Use a Release Version</dd><dl>|null|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sourceFolder|source folder for generated code| |src/gen/java|
|
||||
|useBeanValidation|Use BeanValidation API annotations| |false|
|
||||
|useGenericResponse|Use generic response| |false|
|
||||
|useGzipFeatureForTests|Use Gzip Feature for tests| |false|
|
||||
|useLoggingFeatureForTests|Use Logging Feature for tests| |false|
|
||||
|useGenericResponse|Use generic response| |false|
|
||||
|withXml|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)| |false|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|Set|java.util.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|HashMap|java.util.HashMap|
|
||||
|Array|java.util.List|
|
||||
|ArrayList|java.util.ArrayList|
|
||||
|URI|java.net.URI|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|LocalDate|org.joda.time.LocalDate|
|
||||
|BigDecimal|java.math.BigDecimal|
|
||||
|Date|java.util.Date|
|
||||
|DateTime|org.joda.time.*|
|
||||
|Array|java.util.List|
|
||||
|List|java.util.*|
|
||||
|UUID|java.util.UUID|
|
||||
|File|java.io.File|
|
||||
|HashMap|java.util.HashMap|
|
||||
|List|java.util.*|
|
||||
|LocalDate|org.joda.time.LocalDate|
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|Map|java.util.Map|
|
||||
|Set|java.util.*|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|URI|java.net.URI|
|
||||
|UUID|java.util.UUID|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
@ -79,87 +79,87 @@ sidebar_label: jaxrs-cxf-client
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>Integer</li>
|
||||
<li>byte[]</li>
|
||||
<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>Boolean</li>
|
||||
<li>Double</li>
|
||||
<li>Float</li>
|
||||
<li>boolean</li>
|
||||
<li>Integer</li>
|
||||
<li>Long</li>
|
||||
<li>Object</li>
|
||||
<li>String</li>
|
||||
<li>Boolean</li>
|
||||
<li>Double</li>
|
||||
<li>boolean</li>
|
||||
<li>byte[]</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>localvaraccepts</li>
|
||||
<li>synchronized</li>
|
||||
<li>do</li>
|
||||
<li>float</li>
|
||||
<li>while</li>
|
||||
<li>localvarpath</li>
|
||||
<li>protected</li>
|
||||
<li>continue</li>
|
||||
<li>else</li>
|
||||
<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>abstract</li>
|
||||
<li>apiclient</li>
|
||||
<li>localvarqueryparams</li>
|
||||
<li>catch</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>new</li>
|
||||
<li>package</li>
|
||||
<li>static</li>
|
||||
<li>void</li>
|
||||
<li>localvaraccept</li>
|
||||
<li>double</li>
|
||||
<li>apiexception</li>
|
||||
<li>apiresponse</li>
|
||||
<li>assert</li>
|
||||
<li>boolean</li>
|
||||
<li>break</li>
|
||||
<li>byte</li>
|
||||
<li>finally</li>
|
||||
<li>this</li>
|
||||
<li>strictfp</li>
|
||||
<li>throws</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>null</li>
|
||||
<li>transient</li>
|
||||
<li>apiexception</li>
|
||||
<li>final</li>
|
||||
<li>try</li>
|
||||
<li>object</li>
|
||||
<li>localvarcontenttypes</li>
|
||||
<li>implements</li>
|
||||
<li>private</li>
|
||||
<li>import</li>
|
||||
<li>const</li>
|
||||
<li>configuration</li>
|
||||
<li>finally</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>apiresponse</li>
|
||||
<li>interface</li>
|
||||
<li>long</li>
|
||||
<li>switch</li>
|
||||
<li>default</li>
|
||||
<li>goto</li>
|
||||
<li>public</li>
|
||||
<li>localvarheaderparams</li>
|
||||
<li>native</li>
|
||||
<li>localvarcontenttype</li>
|
||||
<li>assert</li>
|
||||
<li>stringutil</li>
|
||||
<li>class</li>
|
||||
<li>localvarcollectionqueryparams</li>
|
||||
<li>localvarcookieparams</li>
|
||||
<li>localreturntype</li>
|
||||
<li>localvarformparams</li>
|
||||
<li>break</li>
|
||||
<li>volatile</li>
|
||||
<li>localvarauthnames</li>
|
||||
<li>abstract</li>
|
||||
<li>int</li>
|
||||
<li>if</li>
|
||||
<li>implements</li>
|
||||
<li>import</li>
|
||||
<li>instanceof</li>
|
||||
<li>super</li>
|
||||
<li>boolean</li>
|
||||
<li>throw</li>
|
||||
<li>int</li>
|
||||
<li>interface</li>
|
||||
<li>localreturntype</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>char</li>
|
||||
<li>short</li>
|
||||
<li>localvarqueryparams</li>
|
||||
<li>long</li>
|
||||
<li>native</li>
|
||||
<li>new</li>
|
||||
<li>null</li>
|
||||
<li>object</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>
|
||||
|
||||
@ -5,90 +5,90 @@ sidebar_label: jaxrs-cxf-extended
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|addConsumesProducesJson|Add @Consumes/@Produces Json to API interface| |false|
|
||||
|additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|modelPackage|package for generated models| |org.openapitools.model|
|
||||
|apiPackage|package for generated api classes| |org.openapitools.api|
|
||||
|invokerPackage|root package for generated code| |org.openapitools.api|
|
||||
|groupId|groupId in generated pom.xml| |org.openapitools|
|
||||
|artifactId|artifactId in generated pom.xml. This also becomes part of the generated library's filename| |openapi-cxf-server|
|
||||
|artifactVersion|artifact version in generated pom.xml. This also becomes part of the generated library's filename| |1.0.0|
|
||||
|artifactUrl|artifact URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
|artifactDescription|artifact description in generated pom.xml| |OpenAPI Java|
|
||||
|artifactId|artifactId in generated pom.xml. This also becomes part of the generated library's filename| |openapi-cxf-server|
|
||||
|artifactUrl|artifact URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
|artifactVersion|artifact version in generated pom.xml. This also becomes part of the generated library's filename| |1.0.0|
|
||||
|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false|
|
||||
|booleanGetterPrefix|Set booleanGetterPrefix| |get|
|
||||
|dateLibrary|Option. Date library to use|<dl><dt>**joda**</dt><dd>Joda (for legacy app only)</dd><dt>**legacy**</dt><dd>Legacy java.util.Date (if you really have a good reason not to use threetenbp</dd><dt>**java8-localdatetime**</dt><dd>Java 8 using LocalDateTime (for legacy app only)</dd><dt>**java8**</dt><dd>Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true</dd><dt>**threetenbp**</dt><dd>Backport of JSR310 (preferred for jdk < 1.8)</dd><dl>|legacy|
|
||||
|developerEmail|developer email in generated pom.xml| |team@openapitools.org|
|
||||
|developerName|developer name in generated pom.xml| |OpenAPI-Generator Contributors|
|
||||
|developerOrganization|developer organization in generated pom.xml| |OpenAPITools.org|
|
||||
|developerOrganizationUrl|developer organization URL in generated pom.xml| |http://openapitools.org|
|
||||
|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false|
|
||||
|generateJbossDeploymentDescriptor|Generate Jboss Deployment Descriptor| |false|
|
||||
|generateNonSpringApplication|Generate non-Spring application| |false|
|
||||
|generateOperationBody|Generate fully functional operation bodies| |false|
|
||||
|generateSpringApplication|Generate Spring application| |false|
|
||||
|generateSpringBootApplication|Generate Spring Boot application| |false|
|
||||
|groupId|groupId in generated pom.xml| |org.openapitools|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |false|
|
||||
|implFolder|folder for generated implementation code| |src/main/java|
|
||||
|invokerPackage|root package for generated code| |org.openapitools.api|
|
||||
|java8|Option. Use Java8 classes instead of third party equivalents|<dl><dt>**true**</dt><dd>Use Java 8 classes such as Base64</dd><dt>**false**</dt><dd>Various third party libraries as needed</dd><dl>|false|
|
||||
|licenseName|The name of the license| |Unlicense|
|
||||
|licenseUrl|The URL of the license| |http://unlicense.org|
|
||||
|loadTestDataFromFile|Load test data from a generated JSON file| |false|
|
||||
|modelPackage|package for generated models| |org.openapitools.model|
|
||||
|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|scmConnection|SCM connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git|
|
||||
|scmDeveloperConnection|SCM developer connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git|
|
||||
|scmUrl|SCM URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
|developerName|developer name in generated pom.xml| |OpenAPI-Generator Contributors|
|
||||
|developerEmail|developer email in generated pom.xml| |team@openapitools.org|
|
||||
|developerOrganization|developer organization in generated pom.xml| |OpenAPITools.org|
|
||||
|developerOrganizationUrl|developer organization URL in generated pom.xml| |http://openapitools.org|
|
||||
|licenseName|The name of the license| |Unlicense|
|
||||
|licenseUrl|The URL of the license| |http://unlicense.org|
|
||||
|sourceFolder|source folder for generated code| |src/main/java|
|
||||
|serializableModel|boolean - toggle "implements Serializable" for generated models| |false|
|
||||
|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false|
|
||||
|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |false|
|
||||
|withXml|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)| |false|
|
||||
|dateLibrary|Option. Date library to use|<dl><dt>**joda**</dt><dd>Joda (for legacy app only)</dd><dt>**legacy**</dt><dd>Legacy java.util.Date (if you really have a good reason not to use threetenbp</dd><dt>**java8-localdatetime**</dt><dd>Java 8 using LocalDateTime (for legacy app only)</dd><dt>**java8**</dt><dd>Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true</dd><dt>**threetenbp**</dt><dd>Backport of JSR310 (preferred for jdk < 1.8)</dd><dl>|legacy|
|
||||
|java8|Option. Use Java8 classes instead of third party equivalents|<dl><dt>**true**</dt><dd>Use Java 8 classes such as Base64</dd><dt>**false**</dt><dd>Various third party libraries as needed</dd><dl>|false|
|
||||
|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false|
|
||||
|booleanGetterPrefix|Set booleanGetterPrefix| |get|
|
||||
|additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null|
|
||||
|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|snapshotVersion|Uses a SNAPSHOT version.|<dl><dt>**true**</dt><dd>Use a SnapShot Version</dd><dt>**false**</dt><dd>Use a Release Version</dd><dl>|null|
|
||||
|implFolder|folder for generated implementation code| |src/main/java|
|
||||
|title|a title describing the application| |OpenAPI Server|
|
||||
|useBeanValidation|Use BeanValidation API annotations| |true|
|
||||
|serverPort|The port on which the server should be started| |8080|
|
||||
|generateSpringApplication|Generate Spring application| |false|
|
||||
|snapshotVersion|Uses a SNAPSHOT version.|<dl><dt>**true**</dt><dd>Use a SnapShot Version</dd><dt>**false**</dt><dd>Use a Release Version</dd><dl>|null|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sourceFolder|source folder for generated code| |src/main/java|
|
||||
|supportMultipleSpringServices|Support generation of Spring services from multiple specifications| |false|
|
||||
|testDataControlFile|JSON file to control test data generation| |null|
|
||||
|testDataFile|JSON file to contain generated test data| |null|
|
||||
|title|a title describing the application| |OpenAPI Server|
|
||||
|useAnnotatedBasePath|Use @Path annotations for basePath| |false|
|
||||
|useBeanValidation|Use BeanValidation API annotations| |true|
|
||||
|useBeanValidationFeature|Use BeanValidation Feature| |false|
|
||||
|useGenericResponse|Use generic response| |false|
|
||||
|useGzipFeature|Use Gzip Feature| |false|
|
||||
|useGzipFeatureForTests|Use Gzip Feature for tests| |false|
|
||||
|useLoggingFeature|Use Logging Feature| |false|
|
||||
|useLoggingFeatureForTests|Use Logging Feature for tests| |false|
|
||||
|useMultipartFeature|Use Multipart Feature| |false|
|
||||
|useSpringAnnotationConfig|Use Spring Annotation Config| |false|
|
||||
|useSwaggerFeature|Use Swagger Feature| |false|
|
||||
|useSwaggerUI|Use Swagger UI| |false|
|
||||
|useWadlFeature|Use WADL Feature| |false|
|
||||
|useMultipartFeature|Use Multipart Feature| |false|
|
||||
|useGzipFeature|Use Gzip Feature| |false|
|
||||
|useGzipFeatureForTests|Use Gzip Feature for tests| |false|
|
||||
|useBeanValidationFeature|Use BeanValidation Feature| |false|
|
||||
|useLoggingFeature|Use Logging Feature| |false|
|
||||
|useLoggingFeatureForTests|Use Logging Feature for tests| |false|
|
||||
|generateSpringBootApplication|Generate Spring Boot application| |false|
|
||||
|generateJbossDeploymentDescriptor|Generate Jboss Deployment Descriptor| |false|
|
||||
|addConsumesProducesJson|Add @Consumes/@Produces Json to API interface| |false|
|
||||
|useAnnotatedBasePath|Use @Path annotations for basePath| |false|
|
||||
|generateNonSpringApplication|Generate non-Spring application| |false|
|
||||
|useGenericResponse|Use generic response| |false|
|
||||
|supportMultipleSpringServices|Support generation of Spring services from multiple specifications| |false|
|
||||
|generateOperationBody|Generate fully functional operation bodies| |false|
|
||||
|loadTestDataFromFile|Load test data from a generated JSON file| |false|
|
||||
|testDataFile|JSON file to contain generated test data| |null|
|
||||
|testDataControlFile|JSON file to control test data generation| |null|
|
||||
|withXml|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)| |false|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|Set|java.util.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|HashMap|java.util.HashMap|
|
||||
|Array|java.util.List|
|
||||
|ArrayList|java.util.ArrayList|
|
||||
|URI|java.net.URI|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|LocalDate|org.joda.time.LocalDate|
|
||||
|BigDecimal|java.math.BigDecimal|
|
||||
|Date|java.util.Date|
|
||||
|DateTime|org.joda.time.*|
|
||||
|Array|java.util.List|
|
||||
|List|java.util.*|
|
||||
|UUID|java.util.UUID|
|
||||
|File|java.io.File|
|
||||
|HashMap|java.util.HashMap|
|
||||
|List|java.util.*|
|
||||
|LocalDate|org.joda.time.LocalDate|
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|Map|java.util.Map|
|
||||
|Set|java.util.*|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|URI|java.net.URI|
|
||||
|UUID|java.util.UUID|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
@ -101,87 +101,87 @@ sidebar_label: jaxrs-cxf-extended
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>Integer</li>
|
||||
<li>byte[]</li>
|
||||
<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>Boolean</li>
|
||||
<li>Double</li>
|
||||
<li>Float</li>
|
||||
<li>boolean</li>
|
||||
<li>Integer</li>
|
||||
<li>Long</li>
|
||||
<li>Object</li>
|
||||
<li>String</li>
|
||||
<li>Boolean</li>
|
||||
<li>Double</li>
|
||||
<li>boolean</li>
|
||||
<li>byte[]</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>localvaraccepts</li>
|
||||
<li>synchronized</li>
|
||||
<li>do</li>
|
||||
<li>float</li>
|
||||
<li>while</li>
|
||||
<li>localvarpath</li>
|
||||
<li>protected</li>
|
||||
<li>continue</li>
|
||||
<li>else</li>
|
||||
<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>abstract</li>
|
||||
<li>apiclient</li>
|
||||
<li>localvarqueryparams</li>
|
||||
<li>catch</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>new</li>
|
||||
<li>package</li>
|
||||
<li>static</li>
|
||||
<li>void</li>
|
||||
<li>localvaraccept</li>
|
||||
<li>double</li>
|
||||
<li>apiexception</li>
|
||||
<li>apiresponse</li>
|
||||
<li>assert</li>
|
||||
<li>boolean</li>
|
||||
<li>break</li>
|
||||
<li>byte</li>
|
||||
<li>finally</li>
|
||||
<li>this</li>
|
||||
<li>strictfp</li>
|
||||
<li>throws</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>null</li>
|
||||
<li>transient</li>
|
||||
<li>apiexception</li>
|
||||
<li>final</li>
|
||||
<li>try</li>
|
||||
<li>object</li>
|
||||
<li>localvarcontenttypes</li>
|
||||
<li>implements</li>
|
||||
<li>private</li>
|
||||
<li>import</li>
|
||||
<li>const</li>
|
||||
<li>configuration</li>
|
||||
<li>finally</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>apiresponse</li>
|
||||
<li>interface</li>
|
||||
<li>long</li>
|
||||
<li>switch</li>
|
||||
<li>default</li>
|
||||
<li>goto</li>
|
||||
<li>public</li>
|
||||
<li>localvarheaderparams</li>
|
||||
<li>native</li>
|
||||
<li>localvarcontenttype</li>
|
||||
<li>assert</li>
|
||||
<li>stringutil</li>
|
||||
<li>class</li>
|
||||
<li>localvarcollectionqueryparams</li>
|
||||
<li>localvarcookieparams</li>
|
||||
<li>localreturntype</li>
|
||||
<li>localvarformparams</li>
|
||||
<li>break</li>
|
||||
<li>volatile</li>
|
||||
<li>localvarauthnames</li>
|
||||
<li>abstract</li>
|
||||
<li>int</li>
|
||||
<li>if</li>
|
||||
<li>implements</li>
|
||||
<li>import</li>
|
||||
<li>instanceof</li>
|
||||
<li>super</li>
|
||||
<li>boolean</li>
|
||||
<li>throw</li>
|
||||
<li>int</li>
|
||||
<li>interface</li>
|
||||
<li>localreturntype</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>char</li>
|
||||
<li>short</li>
|
||||
<li>localvarqueryparams</li>
|
||||
<li>long</li>
|
||||
<li>native</li>
|
||||
<li>new</li>
|
||||
<li>null</li>
|
||||
<li>object</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>
|
||||
|
||||
@ -5,85 +5,85 @@ sidebar_label: jaxrs-cxf
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|addConsumesProducesJson|Add @Consumes/@Produces Json to API interface| |false|
|
||||
|additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|modelPackage|package for generated models| |org.openapitools.model|
|
||||
|apiPackage|package for generated api classes| |org.openapitools.api|
|
||||
|invokerPackage|root package for generated code| |org.openapitools.api|
|
||||
|groupId|groupId in generated pom.xml| |org.openapitools|
|
||||
|artifactId|artifactId in generated pom.xml. This also becomes part of the generated library's filename| |openapi-cxf-server|
|
||||
|artifactVersion|artifact version in generated pom.xml. This also becomes part of the generated library's filename| |1.0.0|
|
||||
|artifactUrl|artifact URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
|artifactDescription|artifact description in generated pom.xml| |OpenAPI Java|
|
||||
|artifactId|artifactId in generated pom.xml. This also becomes part of the generated library's filename| |openapi-cxf-server|
|
||||
|artifactUrl|artifact URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
|artifactVersion|artifact version in generated pom.xml. This also becomes part of the generated library's filename| |1.0.0|
|
||||
|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false|
|
||||
|booleanGetterPrefix|Set booleanGetterPrefix| |get|
|
||||
|dateLibrary|Option. Date library to use|<dl><dt>**joda**</dt><dd>Joda (for legacy app only)</dd><dt>**legacy**</dt><dd>Legacy java.util.Date (if you really have a good reason not to use threetenbp</dd><dt>**java8-localdatetime**</dt><dd>Java 8 using LocalDateTime (for legacy app only)</dd><dt>**java8**</dt><dd>Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true</dd><dt>**threetenbp**</dt><dd>Backport of JSR310 (preferred for jdk < 1.8)</dd><dl>|legacy|
|
||||
|developerEmail|developer email in generated pom.xml| |team@openapitools.org|
|
||||
|developerName|developer name in generated pom.xml| |OpenAPI-Generator Contributors|
|
||||
|developerOrganization|developer organization in generated pom.xml| |OpenAPITools.org|
|
||||
|developerOrganizationUrl|developer organization URL in generated pom.xml| |http://openapitools.org|
|
||||
|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false|
|
||||
|generateJbossDeploymentDescriptor|Generate Jboss Deployment Descriptor| |false|
|
||||
|generateNonSpringApplication|Generate non-Spring application| |false|
|
||||
|generateSpringApplication|Generate Spring application| |false|
|
||||
|generateSpringBootApplication|Generate Spring Boot application| |false|
|
||||
|groupId|groupId in generated pom.xml| |org.openapitools|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |false|
|
||||
|implFolder|folder for generated implementation code| |src/main/java|
|
||||
|invokerPackage|root package for generated code| |org.openapitools.api|
|
||||
|java8|Option. Use Java8 classes instead of third party equivalents|<dl><dt>**true**</dt><dd>Use Java 8 classes such as Base64</dd><dt>**false**</dt><dd>Various third party libraries as needed</dd><dl>|false|
|
||||
|licenseName|The name of the license| |Unlicense|
|
||||
|licenseUrl|The URL of the license| |http://unlicense.org|
|
||||
|modelPackage|package for generated models| |org.openapitools.model|
|
||||
|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|scmConnection|SCM connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git|
|
||||
|scmDeveloperConnection|SCM developer connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git|
|
||||
|scmUrl|SCM URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
|developerName|developer name in generated pom.xml| |OpenAPI-Generator Contributors|
|
||||
|developerEmail|developer email in generated pom.xml| |team@openapitools.org|
|
||||
|developerOrganization|developer organization in generated pom.xml| |OpenAPITools.org|
|
||||
|developerOrganizationUrl|developer organization URL in generated pom.xml| |http://openapitools.org|
|
||||
|licenseName|The name of the license| |Unlicense|
|
||||
|licenseUrl|The URL of the license| |http://unlicense.org|
|
||||
|sourceFolder|source folder for generated code| |src/main/java|
|
||||
|serializableModel|boolean - toggle "implements Serializable" for generated models| |false|
|
||||
|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false|
|
||||
|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |false|
|
||||
|withXml|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)| |false|
|
||||
|dateLibrary|Option. Date library to use|<dl><dt>**joda**</dt><dd>Joda (for legacy app only)</dd><dt>**legacy**</dt><dd>Legacy java.util.Date (if you really have a good reason not to use threetenbp</dd><dt>**java8-localdatetime**</dt><dd>Java 8 using LocalDateTime (for legacy app only)</dd><dt>**java8**</dt><dd>Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true</dd><dt>**threetenbp**</dt><dd>Backport of JSR310 (preferred for jdk < 1.8)</dd><dl>|legacy|
|
||||
|java8|Option. Use Java8 classes instead of third party equivalents|<dl><dt>**true**</dt><dd>Use Java 8 classes such as Base64</dd><dt>**false**</dt><dd>Various third party libraries as needed</dd><dl>|false|
|
||||
|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false|
|
||||
|booleanGetterPrefix|Set booleanGetterPrefix| |get|
|
||||
|additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null|
|
||||
|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|snapshotVersion|Uses a SNAPSHOT version.|<dl><dt>**true**</dt><dd>Use a SnapShot Version</dd><dt>**false**</dt><dd>Use a Release Version</dd><dl>|null|
|
||||
|implFolder|folder for generated implementation code| |src/main/java|
|
||||
|title|a title describing the application| |OpenAPI Server|
|
||||
|useBeanValidation|Use BeanValidation API annotations| |true|
|
||||
|serverPort|The port on which the server should be started| |8080|
|
||||
|generateSpringApplication|Generate Spring application| |false|
|
||||
|snapshotVersion|Uses a SNAPSHOT version.|<dl><dt>**true**</dt><dd>Use a SnapShot Version</dd><dt>**false**</dt><dd>Use a Release Version</dd><dl>|null|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sourceFolder|source folder for generated code| |src/main/java|
|
||||
|title|a title describing the application| |OpenAPI Server|
|
||||
|useAnnotatedBasePath|Use @Path annotations for basePath| |false|
|
||||
|useBeanValidation|Use BeanValidation API annotations| |true|
|
||||
|useBeanValidationFeature|Use BeanValidation Feature| |false|
|
||||
|useGenericResponse|Use generic response| |false|
|
||||
|useGzipFeature|Use Gzip Feature| |false|
|
||||
|useGzipFeatureForTests|Use Gzip Feature for tests| |false|
|
||||
|useLoggingFeature|Use Logging Feature| |false|
|
||||
|useLoggingFeatureForTests|Use Logging Feature for tests| |false|
|
||||
|useMultipartFeature|Use Multipart Feature| |false|
|
||||
|useSpringAnnotationConfig|Use Spring Annotation Config| |false|
|
||||
|useSwaggerFeature|Use Swagger Feature| |false|
|
||||
|useSwaggerUI|Use Swagger UI| |false|
|
||||
|useWadlFeature|Use WADL Feature| |false|
|
||||
|useMultipartFeature|Use Multipart Feature| |false|
|
||||
|useGzipFeature|Use Gzip Feature| |false|
|
||||
|useGzipFeatureForTests|Use Gzip Feature for tests| |false|
|
||||
|useBeanValidationFeature|Use BeanValidation Feature| |false|
|
||||
|useLoggingFeature|Use Logging Feature| |false|
|
||||
|useLoggingFeatureForTests|Use Logging Feature for tests| |false|
|
||||
|generateSpringBootApplication|Generate Spring Boot application| |false|
|
||||
|generateJbossDeploymentDescriptor|Generate Jboss Deployment Descriptor| |false|
|
||||
|addConsumesProducesJson|Add @Consumes/@Produces Json to API interface| |false|
|
||||
|useAnnotatedBasePath|Use @Path annotations for basePath| |false|
|
||||
|generateNonSpringApplication|Generate non-Spring application| |false|
|
||||
|useGenericResponse|Use generic response| |false|
|
||||
|withXml|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)| |false|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|Set|java.util.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|HashMap|java.util.HashMap|
|
||||
|Array|java.util.List|
|
||||
|ArrayList|java.util.ArrayList|
|
||||
|URI|java.net.URI|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|LocalDate|org.joda.time.LocalDate|
|
||||
|BigDecimal|java.math.BigDecimal|
|
||||
|Date|java.util.Date|
|
||||
|DateTime|org.joda.time.*|
|
||||
|Array|java.util.List|
|
||||
|List|java.util.*|
|
||||
|UUID|java.util.UUID|
|
||||
|File|java.io.File|
|
||||
|HashMap|java.util.HashMap|
|
||||
|List|java.util.*|
|
||||
|LocalDate|org.joda.time.LocalDate|
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|Map|java.util.Map|
|
||||
|Set|java.util.*|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|URI|java.net.URI|
|
||||
|UUID|java.util.UUID|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
@ -96,87 +96,87 @@ sidebar_label: jaxrs-cxf
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>Integer</li>
|
||||
<li>byte[]</li>
|
||||
<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>Boolean</li>
|
||||
<li>Double</li>
|
||||
<li>Float</li>
|
||||
<li>boolean</li>
|
||||
<li>Integer</li>
|
||||
<li>Long</li>
|
||||
<li>Object</li>
|
||||
<li>String</li>
|
||||
<li>Boolean</li>
|
||||
<li>Double</li>
|
||||
<li>boolean</li>
|
||||
<li>byte[]</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>localvaraccepts</li>
|
||||
<li>synchronized</li>
|
||||
<li>do</li>
|
||||
<li>float</li>
|
||||
<li>while</li>
|
||||
<li>localvarpath</li>
|
||||
<li>protected</li>
|
||||
<li>continue</li>
|
||||
<li>else</li>
|
||||
<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>abstract</li>
|
||||
<li>apiclient</li>
|
||||
<li>localvarqueryparams</li>
|
||||
<li>catch</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>new</li>
|
||||
<li>package</li>
|
||||
<li>static</li>
|
||||
<li>void</li>
|
||||
<li>localvaraccept</li>
|
||||
<li>double</li>
|
||||
<li>apiexception</li>
|
||||
<li>apiresponse</li>
|
||||
<li>assert</li>
|
||||
<li>boolean</li>
|
||||
<li>break</li>
|
||||
<li>byte</li>
|
||||
<li>finally</li>
|
||||
<li>this</li>
|
||||
<li>strictfp</li>
|
||||
<li>throws</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>null</li>
|
||||
<li>transient</li>
|
||||
<li>apiexception</li>
|
||||
<li>final</li>
|
||||
<li>try</li>
|
||||
<li>object</li>
|
||||
<li>localvarcontenttypes</li>
|
||||
<li>implements</li>
|
||||
<li>private</li>
|
||||
<li>import</li>
|
||||
<li>const</li>
|
||||
<li>configuration</li>
|
||||
<li>finally</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>apiresponse</li>
|
||||
<li>interface</li>
|
||||
<li>long</li>
|
||||
<li>switch</li>
|
||||
<li>default</li>
|
||||
<li>goto</li>
|
||||
<li>public</li>
|
||||
<li>localvarheaderparams</li>
|
||||
<li>native</li>
|
||||
<li>localvarcontenttype</li>
|
||||
<li>assert</li>
|
||||
<li>stringutil</li>
|
||||
<li>class</li>
|
||||
<li>localvarcollectionqueryparams</li>
|
||||
<li>localvarcookieparams</li>
|
||||
<li>localreturntype</li>
|
||||
<li>localvarformparams</li>
|
||||
<li>break</li>
|
||||
<li>volatile</li>
|
||||
<li>localvarauthnames</li>
|
||||
<li>abstract</li>
|
||||
<li>int</li>
|
||||
<li>if</li>
|
||||
<li>implements</li>
|
||||
<li>import</li>
|
||||
<li>instanceof</li>
|
||||
<li>super</li>
|
||||
<li>boolean</li>
|
||||
<li>throw</li>
|
||||
<li>int</li>
|
||||
<li>interface</li>
|
||||
<li>localreturntype</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>char</li>
|
||||
<li>short</li>
|
||||
<li>localvarqueryparams</li>
|
||||
<li>long</li>
|
||||
<li>native</li>
|
||||
<li>new</li>
|
||||
<li>null</li>
|
||||
<li>object</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>
|
||||
|
||||
@ -5,71 +5,71 @@ sidebar_label: jaxrs-jersey
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|modelPackage|package for generated models| |org.openapitools.model|
|
||||
|apiPackage|package for generated api classes| |org.openapitools.api|
|
||||
|invokerPackage|root package for generated code| |org.openapitools.api|
|
||||
|groupId|groupId in generated pom.xml| |org.openapitools|
|
||||
|artifactId|artifactId in generated pom.xml. This also becomes part of the generated library's filename| |openapi-jaxrs-server|
|
||||
|artifactVersion|artifact version in generated pom.xml. This also becomes part of the generated library's filename| |1.0.0|
|
||||
|artifactUrl|artifact URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
|artifactDescription|artifact description in generated pom.xml| |OpenAPI Java|
|
||||
|artifactId|artifactId in generated pom.xml. This also becomes part of the generated library's filename| |openapi-jaxrs-server|
|
||||
|artifactUrl|artifact URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
|artifactVersion|artifact version in generated pom.xml. This also becomes part of the generated library's filename| |1.0.0|
|
||||
|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false|
|
||||
|booleanGetterPrefix|Set booleanGetterPrefix| |get|
|
||||
|dateLibrary|Option. Date library to use|<dl><dt>**joda**</dt><dd>Joda (for legacy app only)</dd><dt>**legacy**</dt><dd>Legacy java.util.Date (if you really have a good reason not to use threetenbp</dd><dt>**java8-localdatetime**</dt><dd>Java 8 using LocalDateTime (for legacy app only)</dd><dt>**java8**</dt><dd>Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true</dd><dt>**threetenbp**</dt><dd>Backport of JSR310 (preferred for jdk < 1.8)</dd><dl>|legacy|
|
||||
|developerEmail|developer email in generated pom.xml| |team@openapitools.org|
|
||||
|developerName|developer name in generated pom.xml| |OpenAPI-Generator Contributors|
|
||||
|developerOrganization|developer organization in generated pom.xml| |OpenAPITools.org|
|
||||
|developerOrganizationUrl|developer organization URL in generated pom.xml| |http://openapitools.org|
|
||||
|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false|
|
||||
|groupId|groupId in generated pom.xml| |org.openapitools|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |false|
|
||||
|implFolder|folder for generated implementation code| |src/main/java|
|
||||
|invokerPackage|root package for generated code| |org.openapitools.api|
|
||||
|java8|Option. Use Java8 classes instead of third party equivalents|<dl><dt>**true**</dt><dd>Use Java 8 classes such as Base64</dd><dt>**false**</dt><dd>Various third party libraries as needed</dd><dl>|false|
|
||||
|library|library template (sub-template)|<dl><dt>**jersey1**</dt><dd>Jersey core 1.x</dd><dt>**jersey2**</dt><dd>Jersey core 2.x</dd><dl>|jersey2|
|
||||
|licenseName|The name of the license| |Unlicense|
|
||||
|licenseUrl|The URL of the license| |http://unlicense.org|
|
||||
|modelPackage|package for generated models| |org.openapitools.model|
|
||||
|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|scmConnection|SCM connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git|
|
||||
|scmDeveloperConnection|SCM developer connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git|
|
||||
|scmUrl|SCM URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
|developerName|developer name in generated pom.xml| |OpenAPI-Generator Contributors|
|
||||
|developerEmail|developer email in generated pom.xml| |team@openapitools.org|
|
||||
|developerOrganization|developer organization in generated pom.xml| |OpenAPITools.org|
|
||||
|developerOrganizationUrl|developer organization URL in generated pom.xml| |http://openapitools.org|
|
||||
|licenseName|The name of the license| |Unlicense|
|
||||
|licenseUrl|The URL of the license| |http://unlicense.org|
|
||||
|sourceFolder|source folder for generated code| |src/main/java|
|
||||
|serializableModel|boolean - toggle "implements Serializable" for generated models| |false|
|
||||
|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false|
|
||||
|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |false|
|
||||
|withXml|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)| |false|
|
||||
|dateLibrary|Option. Date library to use|<dl><dt>**joda**</dt><dd>Joda (for legacy app only)</dd><dt>**legacy**</dt><dd>Legacy java.util.Date (if you really have a good reason not to use threetenbp</dd><dt>**java8-localdatetime**</dt><dd>Java 8 using LocalDateTime (for legacy app only)</dd><dt>**java8**</dt><dd>Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true</dd><dt>**threetenbp**</dt><dd>Backport of JSR310 (preferred for jdk < 1.8)</dd><dl>|legacy|
|
||||
|java8|Option. Use Java8 classes instead of third party equivalents|<dl><dt>**true**</dt><dd>Use Java 8 classes such as Base64</dd><dt>**false**</dt><dd>Various third party libraries as needed</dd><dl>|false|
|
||||
|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false|
|
||||
|booleanGetterPrefix|Set booleanGetterPrefix| |get|
|
||||
|additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null|
|
||||
|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|serverPort|The port on which the server should be started| |8080|
|
||||
|snapshotVersion|Uses a SNAPSHOT version.|<dl><dt>**true**</dt><dd>Use a SnapShot Version</dd><dt>**false**</dt><dd>Use a Release Version</dd><dl>|null|
|
||||
|implFolder|folder for generated implementation code| |src/main/java|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sourceFolder|source folder for generated code| |src/main/java|
|
||||
|supportJava6|Whether to support Java6 with the Jersey1/2 library.| |false|
|
||||
|title|a title describing the application| |OpenAPI Server|
|
||||
|useBeanValidation|Use BeanValidation API annotations| |true|
|
||||
|serverPort|The port on which the server should be started| |8080|
|
||||
|library|library template (sub-template)|<dl><dt>**jersey1**</dt><dd>Jersey core 1.x</dd><dt>**jersey2**</dt><dd>Jersey core 2.x</dd><dl>|jersey2|
|
||||
|supportJava6|Whether to support Java6 with the Jersey1/2 library.| |false|
|
||||
|useTags|use tags for creating interface and controller classnames| |false|
|
||||
|withXml|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)| |false|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|Set|java.util.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|HashMap|java.util.HashMap|
|
||||
|Array|java.util.List|
|
||||
|ArrayList|java.util.ArrayList|
|
||||
|URI|java.net.URI|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|BigDecimal|java.math.BigDecimal|
|
||||
|Date|java.util.Date|
|
||||
|DateTime|org.joda.time.*|
|
||||
|Array|java.util.List|
|
||||
|List|java.util.*|
|
||||
|UUID|java.util.UUID|
|
||||
|File|java.io.File|
|
||||
|HashMap|java.util.HashMap|
|
||||
|List|java.util.*|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|Map|java.util.Map|
|
||||
|Set|java.util.*|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|URI|java.net.URI|
|
||||
|UUID|java.util.UUID|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
@ -82,87 +82,87 @@ sidebar_label: jaxrs-jersey
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>Integer</li>
|
||||
<li>byte[]</li>
|
||||
<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>Boolean</li>
|
||||
<li>Double</li>
|
||||
<li>Float</li>
|
||||
<li>boolean</li>
|
||||
<li>Integer</li>
|
||||
<li>Long</li>
|
||||
<li>Object</li>
|
||||
<li>String</li>
|
||||
<li>Boolean</li>
|
||||
<li>Double</li>
|
||||
<li>boolean</li>
|
||||
<li>byte[]</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>localvaraccepts</li>
|
||||
<li>synchronized</li>
|
||||
<li>do</li>
|
||||
<li>float</li>
|
||||
<li>while</li>
|
||||
<li>localvarpath</li>
|
||||
<li>protected</li>
|
||||
<li>continue</li>
|
||||
<li>else</li>
|
||||
<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>abstract</li>
|
||||
<li>apiclient</li>
|
||||
<li>localvarqueryparams</li>
|
||||
<li>catch</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>new</li>
|
||||
<li>package</li>
|
||||
<li>static</li>
|
||||
<li>void</li>
|
||||
<li>localvaraccept</li>
|
||||
<li>double</li>
|
||||
<li>apiexception</li>
|
||||
<li>apiresponse</li>
|
||||
<li>assert</li>
|
||||
<li>boolean</li>
|
||||
<li>break</li>
|
||||
<li>byte</li>
|
||||
<li>finally</li>
|
||||
<li>this</li>
|
||||
<li>strictfp</li>
|
||||
<li>throws</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>null</li>
|
||||
<li>transient</li>
|
||||
<li>apiexception</li>
|
||||
<li>final</li>
|
||||
<li>try</li>
|
||||
<li>object</li>
|
||||
<li>localvarcontenttypes</li>
|
||||
<li>implements</li>
|
||||
<li>private</li>
|
||||
<li>import</li>
|
||||
<li>const</li>
|
||||
<li>configuration</li>
|
||||
<li>finally</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>apiresponse</li>
|
||||
<li>interface</li>
|
||||
<li>long</li>
|
||||
<li>switch</li>
|
||||
<li>default</li>
|
||||
<li>goto</li>
|
||||
<li>public</li>
|
||||
<li>localvarheaderparams</li>
|
||||
<li>native</li>
|
||||
<li>localvarcontenttype</li>
|
||||
<li>assert</li>
|
||||
<li>stringutil</li>
|
||||
<li>class</li>
|
||||
<li>localvarcollectionqueryparams</li>
|
||||
<li>localvarcookieparams</li>
|
||||
<li>localreturntype</li>
|
||||
<li>localvarformparams</li>
|
||||
<li>break</li>
|
||||
<li>volatile</li>
|
||||
<li>localvarauthnames</li>
|
||||
<li>abstract</li>
|
||||
<li>int</li>
|
||||
<li>if</li>
|
||||
<li>implements</li>
|
||||
<li>import</li>
|
||||
<li>instanceof</li>
|
||||
<li>super</li>
|
||||
<li>boolean</li>
|
||||
<li>throw</li>
|
||||
<li>int</li>
|
||||
<li>interface</li>
|
||||
<li>localreturntype</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>char</li>
|
||||
<li>short</li>
|
||||
<li>localvarqueryparams</li>
|
||||
<li>long</li>
|
||||
<li>native</li>
|
||||
<li>new</li>
|
||||
<li>null</li>
|
||||
<li>object</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>
|
||||
|
||||
@ -5,71 +5,70 @@ sidebar_label: jaxrs-resteasy-eap
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|modelPackage|package for generated models| |org.openapitools.model|
|
||||
|apiPackage|package for generated api classes| |org.openapitools.api|
|
||||
|invokerPackage|root package for generated code| |org.openapitools.api|
|
||||
|groupId|groupId in generated pom.xml| |org.openapitools|
|
||||
|artifactId|artifactId in generated pom.xml. This also becomes part of the generated library's filename| |openapi-jaxrs-resteasy-eap-server|
|
||||
|artifactVersion|artifact version in generated pom.xml. This also becomes part of the generated library's filename| |1.0.0|
|
||||
|artifactUrl|artifact URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
|artifactDescription|artifact description in generated pom.xml| |OpenAPI Java|
|
||||
|artifactId|artifactId in generated pom.xml. This also becomes part of the generated library's filename| |openapi-jaxrs-resteasy-eap-server|
|
||||
|artifactUrl|artifact URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
|artifactVersion|artifact version in generated pom.xml. This also becomes part of the generated library's filename| |1.0.0|
|
||||
|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false|
|
||||
|booleanGetterPrefix|Set booleanGetterPrefix| |get|
|
||||
|dateLibrary|Option. Date library to use|<dl><dt>**joda**</dt><dd>Joda (for legacy app only)</dd><dt>**legacy**</dt><dd>Legacy java.util.Date (if you really have a good reason not to use threetenbp</dd><dt>**java8-localdatetime**</dt><dd>Java 8 using LocalDateTime (for legacy app only)</dd><dt>**java8**</dt><dd>Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true</dd><dt>**threetenbp**</dt><dd>Backport of JSR310 (preferred for jdk < 1.8)</dd><dl>|legacy|
|
||||
|developerEmail|developer email in generated pom.xml| |team@openapitools.org|
|
||||
|developerName|developer name in generated pom.xml| |OpenAPI-Generator Contributors|
|
||||
|developerOrganization|developer organization in generated pom.xml| |OpenAPITools.org|
|
||||
|developerOrganizationUrl|developer organization URL in generated pom.xml| |http://openapitools.org|
|
||||
|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false|
|
||||
|generateJbossDeploymentDescriptor|Generate Jboss Deployment Descriptor| |true|
|
||||
|groupId|groupId in generated pom.xml| |org.openapitools|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |false|
|
||||
|implFolder|folder for generated implementation code| |src/main/java|
|
||||
|invokerPackage|root package for generated code| |org.openapitools.api|
|
||||
|java8|Option. Use Java8 classes instead of third party equivalents|<dl><dt>**true**</dt><dd>Use Java 8 classes such as Base64</dd><dt>**false**</dt><dd>Various third party libraries as needed</dd><dl>|false|
|
||||
|licenseName|The name of the license| |Unlicense|
|
||||
|licenseUrl|The URL of the license| |http://unlicense.org|
|
||||
|modelPackage|package for generated models| |org.openapitools.model|
|
||||
|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|scmConnection|SCM connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git|
|
||||
|scmDeveloperConnection|SCM developer connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git|
|
||||
|scmUrl|SCM URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
|developerName|developer name in generated pom.xml| |OpenAPI-Generator Contributors|
|
||||
|developerEmail|developer email in generated pom.xml| |team@openapitools.org|
|
||||
|developerOrganization|developer organization in generated pom.xml| |OpenAPITools.org|
|
||||
|developerOrganizationUrl|developer organization URL in generated pom.xml| |http://openapitools.org|
|
||||
|licenseName|The name of the license| |Unlicense|
|
||||
|licenseUrl|The URL of the license| |http://unlicense.org|
|
||||
|sourceFolder|source folder for generated code| |src/main/java|
|
||||
|serializableModel|boolean - toggle "implements Serializable" for generated models| |false|
|
||||
|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false|
|
||||
|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |false|
|
||||
|withXml|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)| |false|
|
||||
|dateLibrary|Option. Date library to use|<dl><dt>**joda**</dt><dd>Joda (for legacy app only)</dd><dt>**legacy**</dt><dd>Legacy java.util.Date (if you really have a good reason not to use threetenbp</dd><dt>**java8-localdatetime**</dt><dd>Java 8 using LocalDateTime (for legacy app only)</dd><dt>**java8**</dt><dd>Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true</dd><dt>**threetenbp**</dt><dd>Backport of JSR310 (preferred for jdk < 1.8)</dd><dl>|legacy|
|
||||
|java8|Option. Use Java8 classes instead of third party equivalents|<dl><dt>**true**</dt><dd>Use Java 8 classes such as Base64</dd><dt>**false**</dt><dd>Various third party libraries as needed</dd><dl>|false|
|
||||
|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false|
|
||||
|booleanGetterPrefix|Set booleanGetterPrefix| |get|
|
||||
|additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null|
|
||||
|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|serverPort|The port on which the server should be started| |8080|
|
||||
|snapshotVersion|Uses a SNAPSHOT version.|<dl><dt>**true**</dt><dd>Use a SnapShot Version</dd><dt>**false**</dt><dd>Use a Release Version</dd><dl>|null|
|
||||
|implFolder|folder for generated implementation code| |src/main/java|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sourceFolder|source folder for generated code| |src/main/java|
|
||||
|title|a title describing the application| |OpenAPI Server|
|
||||
|useBeanValidation|Use BeanValidation API annotations| |true|
|
||||
|serverPort|The port on which the server should be started| |8080|
|
||||
|useBeanValidation|Use BeanValidation API annotations| |true|
|
||||
|generateJbossDeploymentDescriptor|Generate Jboss Deployment Descriptor| |true|
|
||||
|useSwaggerFeature|Use dynamic Swagger generator| |false|
|
||||
|withXml|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)| |false|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|Set|java.util.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|HashMap|java.util.HashMap|
|
||||
|Array|java.util.List|
|
||||
|ArrayList|java.util.ArrayList|
|
||||
|URI|java.net.URI|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|BigDecimal|java.math.BigDecimal|
|
||||
|Date|java.util.Date|
|
||||
|DateTime|org.joda.time.*|
|
||||
|Array|java.util.List|
|
||||
|List|java.util.*|
|
||||
|UUID|java.util.UUID|
|
||||
|File|java.io.File|
|
||||
|HashMap|java.util.HashMap|
|
||||
|List|java.util.*|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|Map|java.util.Map|
|
||||
|Set|java.util.*|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|URI|java.net.URI|
|
||||
|UUID|java.util.UUID|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
@ -82,87 +81,87 @@ sidebar_label: jaxrs-resteasy-eap
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>Integer</li>
|
||||
<li>byte[]</li>
|
||||
<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>Boolean</li>
|
||||
<li>Double</li>
|
||||
<li>Float</li>
|
||||
<li>boolean</li>
|
||||
<li>Integer</li>
|
||||
<li>Long</li>
|
||||
<li>Object</li>
|
||||
<li>String</li>
|
||||
<li>Boolean</li>
|
||||
<li>Double</li>
|
||||
<li>boolean</li>
|
||||
<li>byte[]</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>localvaraccepts</li>
|
||||
<li>synchronized</li>
|
||||
<li>do</li>
|
||||
<li>float</li>
|
||||
<li>while</li>
|
||||
<li>localvarpath</li>
|
||||
<li>protected</li>
|
||||
<li>continue</li>
|
||||
<li>else</li>
|
||||
<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>abstract</li>
|
||||
<li>apiclient</li>
|
||||
<li>localvarqueryparams</li>
|
||||
<li>catch</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>new</li>
|
||||
<li>package</li>
|
||||
<li>static</li>
|
||||
<li>void</li>
|
||||
<li>localvaraccept</li>
|
||||
<li>double</li>
|
||||
<li>apiexception</li>
|
||||
<li>apiresponse</li>
|
||||
<li>assert</li>
|
||||
<li>boolean</li>
|
||||
<li>break</li>
|
||||
<li>byte</li>
|
||||
<li>finally</li>
|
||||
<li>this</li>
|
||||
<li>strictfp</li>
|
||||
<li>throws</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>null</li>
|
||||
<li>transient</li>
|
||||
<li>apiexception</li>
|
||||
<li>final</li>
|
||||
<li>try</li>
|
||||
<li>object</li>
|
||||
<li>localvarcontenttypes</li>
|
||||
<li>implements</li>
|
||||
<li>private</li>
|
||||
<li>import</li>
|
||||
<li>const</li>
|
||||
<li>configuration</li>
|
||||
<li>finally</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>apiresponse</li>
|
||||
<li>interface</li>
|
||||
<li>long</li>
|
||||
<li>switch</li>
|
||||
<li>default</li>
|
||||
<li>goto</li>
|
||||
<li>public</li>
|
||||
<li>localvarheaderparams</li>
|
||||
<li>native</li>
|
||||
<li>localvarcontenttype</li>
|
||||
<li>assert</li>
|
||||
<li>stringutil</li>
|
||||
<li>class</li>
|
||||
<li>localvarcollectionqueryparams</li>
|
||||
<li>localvarcookieparams</li>
|
||||
<li>localreturntype</li>
|
||||
<li>localvarformparams</li>
|
||||
<li>break</li>
|
||||
<li>volatile</li>
|
||||
<li>localvarauthnames</li>
|
||||
<li>abstract</li>
|
||||
<li>int</li>
|
||||
<li>if</li>
|
||||
<li>implements</li>
|
||||
<li>import</li>
|
||||
<li>instanceof</li>
|
||||
<li>super</li>
|
||||
<li>boolean</li>
|
||||
<li>throw</li>
|
||||
<li>int</li>
|
||||
<li>interface</li>
|
||||
<li>localreturntype</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>char</li>
|
||||
<li>short</li>
|
||||
<li>localvarqueryparams</li>
|
||||
<li>long</li>
|
||||
<li>native</li>
|
||||
<li>new</li>
|
||||
<li>null</li>
|
||||
<li>object</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>
|
||||
|
||||
@ -5,69 +5,69 @@ sidebar_label: jaxrs-resteasy
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|modelPackage|package for generated models| |org.openapitools.model|
|
||||
|apiPackage|package for generated api classes| |org.openapitools.api|
|
||||
|invokerPackage|root package for generated code| |org.openapitools.api|
|
||||
|groupId|groupId in generated pom.xml| |org.openapitools|
|
||||
|artifactId|artifactId in generated pom.xml. This also becomes part of the generated library's filename| |openapi-jaxrs-resteasy-server|
|
||||
|artifactVersion|artifact version in generated pom.xml. This also becomes part of the generated library's filename| |1.0.0|
|
||||
|artifactUrl|artifact URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
|artifactDescription|artifact description in generated pom.xml| |OpenAPI Java|
|
||||
|artifactId|artifactId in generated pom.xml. This also becomes part of the generated library's filename| |openapi-jaxrs-resteasy-server|
|
||||
|artifactUrl|artifact URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
|artifactVersion|artifact version in generated pom.xml. This also becomes part of the generated library's filename| |1.0.0|
|
||||
|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false|
|
||||
|booleanGetterPrefix|Set booleanGetterPrefix| |get|
|
||||
|dateLibrary|Option. Date library to use|<dl><dt>**joda**</dt><dd>Joda (for legacy app only)</dd><dt>**legacy**</dt><dd>Legacy java.util.Date (if you really have a good reason not to use threetenbp</dd><dt>**java8-localdatetime**</dt><dd>Java 8 using LocalDateTime (for legacy app only)</dd><dt>**java8**</dt><dd>Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true</dd><dt>**threetenbp**</dt><dd>Backport of JSR310 (preferred for jdk < 1.8)</dd><dl>|legacy|
|
||||
|developerEmail|developer email in generated pom.xml| |team@openapitools.org|
|
||||
|developerName|developer name in generated pom.xml| |OpenAPI-Generator Contributors|
|
||||
|developerOrganization|developer organization in generated pom.xml| |OpenAPITools.org|
|
||||
|developerOrganizationUrl|developer organization URL in generated pom.xml| |http://openapitools.org|
|
||||
|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false|
|
||||
|generateJbossDeploymentDescriptor|Generate Jboss Deployment Descriptor| |false|
|
||||
|groupId|groupId in generated pom.xml| |org.openapitools|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |false|
|
||||
|implFolder|folder for generated implementation code| |src/main/java|
|
||||
|invokerPackage|root package for generated code| |org.openapitools.api|
|
||||
|java8|Option. Use Java8 classes instead of third party equivalents|<dl><dt>**true**</dt><dd>Use Java 8 classes such as Base64</dd><dt>**false**</dt><dd>Various third party libraries as needed</dd><dl>|false|
|
||||
|licenseName|The name of the license| |Unlicense|
|
||||
|licenseUrl|The URL of the license| |http://unlicense.org|
|
||||
|modelPackage|package for generated models| |org.openapitools.model|
|
||||
|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|scmConnection|SCM connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git|
|
||||
|scmDeveloperConnection|SCM developer connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git|
|
||||
|scmUrl|SCM URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
|developerName|developer name in generated pom.xml| |OpenAPI-Generator Contributors|
|
||||
|developerEmail|developer email in generated pom.xml| |team@openapitools.org|
|
||||
|developerOrganization|developer organization in generated pom.xml| |OpenAPITools.org|
|
||||
|developerOrganizationUrl|developer organization URL in generated pom.xml| |http://openapitools.org|
|
||||
|licenseName|The name of the license| |Unlicense|
|
||||
|licenseUrl|The URL of the license| |http://unlicense.org|
|
||||
|sourceFolder|source folder for generated code| |src/main/java|
|
||||
|serializableModel|boolean - toggle "implements Serializable" for generated models| |false|
|
||||
|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false|
|
||||
|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |false|
|
||||
|withXml|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)| |false|
|
||||
|dateLibrary|Option. Date library to use|<dl><dt>**joda**</dt><dd>Joda (for legacy app only)</dd><dt>**legacy**</dt><dd>Legacy java.util.Date (if you really have a good reason not to use threetenbp</dd><dt>**java8-localdatetime**</dt><dd>Java 8 using LocalDateTime (for legacy app only)</dd><dt>**java8**</dt><dd>Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true</dd><dt>**threetenbp**</dt><dd>Backport of JSR310 (preferred for jdk < 1.8)</dd><dl>|legacy|
|
||||
|java8|Option. Use Java8 classes instead of third party equivalents|<dl><dt>**true**</dt><dd>Use Java 8 classes such as Base64</dd><dt>**false**</dt><dd>Various third party libraries as needed</dd><dl>|false|
|
||||
|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false|
|
||||
|booleanGetterPrefix|Set booleanGetterPrefix| |get|
|
||||
|additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null|
|
||||
|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|serverPort|The port on which the server should be started| |8080|
|
||||
|snapshotVersion|Uses a SNAPSHOT version.|<dl><dt>**true**</dt><dd>Use a SnapShot Version</dd><dt>**false**</dt><dd>Use a Release Version</dd><dl>|null|
|
||||
|implFolder|folder for generated implementation code| |src/main/java|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sourceFolder|source folder for generated code| |src/main/java|
|
||||
|title|a title describing the application| |OpenAPI Server|
|
||||
|useBeanValidation|Use BeanValidation API annotations| |true|
|
||||
|serverPort|The port on which the server should be started| |8080|
|
||||
|generateJbossDeploymentDescriptor|Generate Jboss Deployment Descriptor| |false|
|
||||
|withXml|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)| |false|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|Set|java.util.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|HashMap|java.util.HashMap|
|
||||
|Array|java.util.List|
|
||||
|ArrayList|java.util.ArrayList|
|
||||
|URI|java.net.URI|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|BigDecimal|java.math.BigDecimal|
|
||||
|Date|java.util.Date|
|
||||
|DateTime|org.joda.time.*|
|
||||
|Array|java.util.List|
|
||||
|List|java.util.*|
|
||||
|UUID|java.util.UUID|
|
||||
|File|java.io.File|
|
||||
|HashMap|java.util.HashMap|
|
||||
|List|java.util.*|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|Map|java.util.Map|
|
||||
|Set|java.util.*|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|URI|java.net.URI|
|
||||
|UUID|java.util.UUID|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
@ -80,87 +80,87 @@ sidebar_label: jaxrs-resteasy
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>Integer</li>
|
||||
<li>byte[]</li>
|
||||
<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>Boolean</li>
|
||||
<li>Double</li>
|
||||
<li>Float</li>
|
||||
<li>boolean</li>
|
||||
<li>Integer</li>
|
||||
<li>Long</li>
|
||||
<li>Object</li>
|
||||
<li>String</li>
|
||||
<li>Boolean</li>
|
||||
<li>Double</li>
|
||||
<li>boolean</li>
|
||||
<li>byte[]</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>localvaraccepts</li>
|
||||
<li>synchronized</li>
|
||||
<li>do</li>
|
||||
<li>float</li>
|
||||
<li>while</li>
|
||||
<li>localvarpath</li>
|
||||
<li>protected</li>
|
||||
<li>continue</li>
|
||||
<li>else</li>
|
||||
<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>abstract</li>
|
||||
<li>apiclient</li>
|
||||
<li>localvarqueryparams</li>
|
||||
<li>catch</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>new</li>
|
||||
<li>package</li>
|
||||
<li>static</li>
|
||||
<li>void</li>
|
||||
<li>localvaraccept</li>
|
||||
<li>double</li>
|
||||
<li>apiexception</li>
|
||||
<li>apiresponse</li>
|
||||
<li>assert</li>
|
||||
<li>boolean</li>
|
||||
<li>break</li>
|
||||
<li>byte</li>
|
||||
<li>finally</li>
|
||||
<li>this</li>
|
||||
<li>strictfp</li>
|
||||
<li>throws</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>null</li>
|
||||
<li>transient</li>
|
||||
<li>apiexception</li>
|
||||
<li>final</li>
|
||||
<li>try</li>
|
||||
<li>object</li>
|
||||
<li>localvarcontenttypes</li>
|
||||
<li>implements</li>
|
||||
<li>private</li>
|
||||
<li>import</li>
|
||||
<li>const</li>
|
||||
<li>configuration</li>
|
||||
<li>finally</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>apiresponse</li>
|
||||
<li>interface</li>
|
||||
<li>long</li>
|
||||
<li>switch</li>
|
||||
<li>default</li>
|
||||
<li>goto</li>
|
||||
<li>public</li>
|
||||
<li>localvarheaderparams</li>
|
||||
<li>native</li>
|
||||
<li>localvarcontenttype</li>
|
||||
<li>assert</li>
|
||||
<li>stringutil</li>
|
||||
<li>class</li>
|
||||
<li>localvarcollectionqueryparams</li>
|
||||
<li>localvarcookieparams</li>
|
||||
<li>localreturntype</li>
|
||||
<li>localvarformparams</li>
|
||||
<li>break</li>
|
||||
<li>volatile</li>
|
||||
<li>localvarauthnames</li>
|
||||
<li>abstract</li>
|
||||
<li>int</li>
|
||||
<li>if</li>
|
||||
<li>implements</li>
|
||||
<li>import</li>
|
||||
<li>instanceof</li>
|
||||
<li>super</li>
|
||||
<li>boolean</li>
|
||||
<li>throw</li>
|
||||
<li>int</li>
|
||||
<li>interface</li>
|
||||
<li>localreturntype</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>char</li>
|
||||
<li>short</li>
|
||||
<li>localvarqueryparams</li>
|
||||
<li>long</li>
|
||||
<li>native</li>
|
||||
<li>new</li>
|
||||
<li>null</li>
|
||||
<li>object</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>
|
||||
|
||||
@ -5,74 +5,74 @@ sidebar_label: jaxrs-spec
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|modelPackage|package for generated models| |org.openapitools.model|
|
||||
|apiPackage|package for generated api classes| |org.openapitools.api|
|
||||
|invokerPackage|root package for generated code| |org.openapitools.api|
|
||||
|groupId|groupId in generated pom.xml| |org.openapitools|
|
||||
|artifactId|artifactId in generated pom.xml. This also becomes part of the generated library's filename| |openapi-jaxrs-server|
|
||||
|artifactVersion|artifact version in generated pom.xml. This also becomes part of the generated library's filename| |1.0.0|
|
||||
|artifactUrl|artifact URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
|artifactDescription|artifact description in generated pom.xml| |OpenAPI Java|
|
||||
|artifactId|artifactId in generated pom.xml. This also becomes part of the generated library's filename| |openapi-jaxrs-server|
|
||||
|artifactUrl|artifact URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
|artifactVersion|artifact version in generated pom.xml. This also becomes part of the generated library's filename| |1.0.0|
|
||||
|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false|
|
||||
|booleanGetterPrefix|Set booleanGetterPrefix| |get|
|
||||
|dateLibrary|Option. Date library to use|<dl><dt>**joda**</dt><dd>Joda (for legacy app only)</dd><dt>**legacy**</dt><dd>Legacy java.util.Date (if you really have a good reason not to use threetenbp</dd><dt>**java8-localdatetime**</dt><dd>Java 8 using LocalDateTime (for legacy app only)</dd><dt>**java8**</dt><dd>Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true</dd><dt>**threetenbp**</dt><dd>Backport of JSR310 (preferred for jdk < 1.8)</dd><dl>|legacy|
|
||||
|developerEmail|developer email in generated pom.xml| |team@openapitools.org|
|
||||
|developerName|developer name in generated pom.xml| |OpenAPI-Generator Contributors|
|
||||
|developerOrganization|developer organization in generated pom.xml| |OpenAPITools.org|
|
||||
|developerOrganizationUrl|developer organization URL in generated pom.xml| |http://openapitools.org|
|
||||
|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false|
|
||||
|generatePom|Whether to generate pom.xml if the file does not already exist.| |true|
|
||||
|groupId|groupId in generated pom.xml| |org.openapitools|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |false|
|
||||
|implFolder|folder for generated implementation code| |src/main/java|
|
||||
|interfaceOnly|Whether to generate only API interface stubs without the server files.| |false|
|
||||
|invokerPackage|root package for generated code| |org.openapitools.api|
|
||||
|java8|Option. Use Java8 classes instead of third party equivalents|<dl><dt>**true**</dt><dd>Use Java 8 classes such as Base64</dd><dt>**false**</dt><dd>Various third party libraries as needed</dd><dl>|false|
|
||||
|library|library template (sub-template)|<dl><dt>**<default>**</dt><dd>JAXRS spec only, to be deployed in an app server (TomEE, JBoss, WLS, ...)</dd><dt>**quarkus**</dt><dd>Server using Quarkus</dd><dt>**thorntail**</dt><dd>Server using Thorntail</dd><dt>**openliberty**</dt><dd>Server using Open Liberty</dd><dt>**helidon**</dt><dd>Server using Helidon</dd><dl>|<default>|
|
||||
|licenseName|The name of the license| |Unlicense|
|
||||
|licenseUrl|The URL of the license| |http://unlicense.org|
|
||||
|modelPackage|package for generated models| |org.openapitools.model|
|
||||
|openApiSpecFileLocation|Location where the file containing the spec will be generated in the output folder. No file generated when set to null or empty string.| |null|
|
||||
|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|returnResponse|Whether generate API interface should return javax.ws.rs.core.Response instead of a deserialized entity. Only useful if interfaceOnly is true.| |false|
|
||||
|scmConnection|SCM connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git|
|
||||
|scmDeveloperConnection|SCM developer connection in generated pom.xml| |scm:git:git@github.com:openapitools/openapi-generator.git|
|
||||
|scmUrl|SCM URL in generated pom.xml| |https://github.com/openapitools/openapi-generator|
|
||||
|developerName|developer name in generated pom.xml| |OpenAPI-Generator Contributors|
|
||||
|developerEmail|developer email in generated pom.xml| |team@openapitools.org|
|
||||
|developerOrganization|developer organization in generated pom.xml| |OpenAPITools.org|
|
||||
|developerOrganizationUrl|developer organization URL in generated pom.xml| |http://openapitools.org|
|
||||
|licenseName|The name of the license| |Unlicense|
|
||||
|licenseUrl|The URL of the license| |http://unlicense.org|
|
||||
|sourceFolder|source folder for generated code| |src/main/java|
|
||||
|serializableModel|boolean - toggle "implements Serializable" for generated models| |false|
|
||||
|bigDecimalAsString|Treat BigDecimal values as Strings to avoid precision loss.| |false|
|
||||
|fullJavaUtil|whether to use fully qualified name for classes under java.util. This option only works for Java API client| |false|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |false|
|
||||
|withXml|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)| |false|
|
||||
|dateLibrary|Option. Date library to use|<dl><dt>**joda**</dt><dd>Joda (for legacy app only)</dd><dt>**legacy**</dt><dd>Legacy java.util.Date (if you really have a good reason not to use threetenbp</dd><dt>**java8-localdatetime**</dt><dd>Java 8 using LocalDateTime (for legacy app only)</dd><dt>**java8**</dt><dd>Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true</dd><dt>**threetenbp**</dt><dd>Backport of JSR310 (preferred for jdk < 1.8)</dd><dl>|legacy|
|
||||
|java8|Option. Use Java8 classes instead of third party equivalents|<dl><dt>**true**</dt><dd>Use Java 8 classes such as Base64</dd><dt>**false**</dt><dd>Various third party libraries as needed</dd><dl>|false|
|
||||
|disableHtmlEscaping|Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)| |false|
|
||||
|booleanGetterPrefix|Set booleanGetterPrefix| |get|
|
||||
|additionalModelTypeAnnotations|Additional annotations for model type(class level annotations)| |null|
|
||||
|parentGroupId|parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentArtifactId|parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|parentVersion|parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect| |null|
|
||||
|serverPort|The port on which the server should be started| |8080|
|
||||
|snapshotVersion|Uses a SNAPSHOT version.|<dl><dt>**true**</dt><dd>Use a SnapShot Version</dd><dt>**false**</dt><dd>Use a Release Version</dd><dl>|null|
|
||||
|implFolder|folder for generated implementation code| |src/main/java|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sourceFolder|source folder for generated code| |src/main/java|
|
||||
|title|a title describing the application| |OpenAPI Server|
|
||||
|useBeanValidation|Use BeanValidation API annotations| |true|
|
||||
|serverPort|The port on which the server should be started| |8080|
|
||||
|library|library template (sub-template)|<dl><dt>**<default>**</dt><dd>JAXRS spec only, to be deployed in an app server (TomEE, JBoss, WLS, ...)</dd><dt>**quarkus**</dt><dd>Server using Quarkus</dd><dt>**thorntail**</dt><dd>Server using Thorntail</dd><dt>**openliberty**</dt><dd>Server using Open Liberty</dd><dt>**helidon**</dt><dd>Server using Helidon</dd><dl>|<default>|
|
||||
|generatePom|Whether to generate pom.xml if the file does not already exist.| |true|
|
||||
|interfaceOnly|Whether to generate only API interface stubs without the server files.| |false|
|
||||
|returnResponse|Whether generate API interface should return javax.ws.rs.core.Response instead of a deserialized entity. Only useful if interfaceOnly is true.| |false|
|
||||
|useSwaggerAnnotations|Whether to generate Swagger annotations.| |true|
|
||||
|openApiSpecFileLocation|Location where the file containing the spec will be generated in the output folder. No file generated when set to null or empty string.| |null|
|
||||
|withXml|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)| |false|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|Set|java.util.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|HashMap|java.util.HashMap|
|
||||
|Array|java.util.List|
|
||||
|ArrayList|java.util.ArrayList|
|
||||
|URI|java.net.URI|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|LocalDate|org.joda.time.LocalDate|
|
||||
|BigDecimal|java.math.BigDecimal|
|
||||
|Date|java.util.Date|
|
||||
|DateTime|org.joda.time.*|
|
||||
|Array|java.util.List|
|
||||
|List|java.util.*|
|
||||
|UUID|java.util.UUID|
|
||||
|File|java.io.File|
|
||||
|HashMap|java.util.HashMap|
|
||||
|List|java.util.*|
|
||||
|LocalDate|org.joda.time.LocalDate|
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|Map|java.util.Map|
|
||||
|Set|java.util.*|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|URI|java.net.URI|
|
||||
|UUID|java.util.UUID|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
@ -85,87 +85,87 @@ sidebar_label: jaxrs-spec
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>Integer</li>
|
||||
<li>byte[]</li>
|
||||
<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>Boolean</li>
|
||||
<li>Double</li>
|
||||
<li>Float</li>
|
||||
<li>boolean</li>
|
||||
<li>Integer</li>
|
||||
<li>Long</li>
|
||||
<li>Object</li>
|
||||
<li>String</li>
|
||||
<li>Boolean</li>
|
||||
<li>Double</li>
|
||||
<li>boolean</li>
|
||||
<li>byte[]</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>localvaraccepts</li>
|
||||
<li>synchronized</li>
|
||||
<li>do</li>
|
||||
<li>float</li>
|
||||
<li>while</li>
|
||||
<li>localvarpath</li>
|
||||
<li>protected</li>
|
||||
<li>continue</li>
|
||||
<li>else</li>
|
||||
<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>abstract</li>
|
||||
<li>apiclient</li>
|
||||
<li>localvarqueryparams</li>
|
||||
<li>catch</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>new</li>
|
||||
<li>package</li>
|
||||
<li>static</li>
|
||||
<li>void</li>
|
||||
<li>localvaraccept</li>
|
||||
<li>double</li>
|
||||
<li>apiexception</li>
|
||||
<li>apiresponse</li>
|
||||
<li>assert</li>
|
||||
<li>boolean</li>
|
||||
<li>break</li>
|
||||
<li>byte</li>
|
||||
<li>finally</li>
|
||||
<li>this</li>
|
||||
<li>strictfp</li>
|
||||
<li>throws</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>null</li>
|
||||
<li>transient</li>
|
||||
<li>apiexception</li>
|
||||
<li>final</li>
|
||||
<li>try</li>
|
||||
<li>object</li>
|
||||
<li>localvarcontenttypes</li>
|
||||
<li>implements</li>
|
||||
<li>private</li>
|
||||
<li>import</li>
|
||||
<li>const</li>
|
||||
<li>configuration</li>
|
||||
<li>finally</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>apiresponse</li>
|
||||
<li>interface</li>
|
||||
<li>long</li>
|
||||
<li>switch</li>
|
||||
<li>default</li>
|
||||
<li>goto</li>
|
||||
<li>public</li>
|
||||
<li>localvarheaderparams</li>
|
||||
<li>native</li>
|
||||
<li>localvarcontenttype</li>
|
||||
<li>assert</li>
|
||||
<li>stringutil</li>
|
||||
<li>class</li>
|
||||
<li>localvarcollectionqueryparams</li>
|
||||
<li>localvarcookieparams</li>
|
||||
<li>localreturntype</li>
|
||||
<li>localvarformparams</li>
|
||||
<li>break</li>
|
||||
<li>volatile</li>
|
||||
<li>localvarauthnames</li>
|
||||
<li>abstract</li>
|
||||
<li>int</li>
|
||||
<li>if</li>
|
||||
<li>implements</li>
|
||||
<li>import</li>
|
||||
<li>instanceof</li>
|
||||
<li>super</li>
|
||||
<li>boolean</li>
|
||||
<li>throw</li>
|
||||
<li>int</li>
|
||||
<li>interface</li>
|
||||
<li>localreturntype</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>char</li>
|
||||
<li>short</li>
|
||||
<li>localvarqueryparams</li>
|
||||
<li>long</li>
|
||||
<li>native</li>
|
||||
<li>new</li>
|
||||
<li>null</li>
|
||||
<li>object</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>
|
||||
|
||||
@ -5,32 +5,32 @@ sidebar_label: jmeter
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|Set|java.util.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|HashMap|java.util.HashMap|
|
||||
|Array|java.util.List|
|
||||
|ArrayList|java.util.ArrayList|
|
||||
|URI|java.net.URI|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|BigDecimal|java.math.BigDecimal|
|
||||
|Date|java.util.Date|
|
||||
|DateTime|org.joda.time.*|
|
||||
|Array|java.util.List|
|
||||
|List|java.util.*|
|
||||
|UUID|java.util.UUID|
|
||||
|File|java.io.File|
|
||||
|HashMap|java.util.HashMap|
|
||||
|List|java.util.*|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|Map|java.util.Map|
|
||||
|Set|java.util.*|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|URI|java.net.URI|
|
||||
|UUID|java.util.UUID|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
|
||||
@ -5,40 +5,40 @@ sidebar_label: kotlin-server
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sourceFolder|source folder for generated code| |src/main/kotlin|
|
||||
|packageName|Generated artifact package name.| |org.openapitools.server|
|
||||
|apiSuffix|suffix for api classes| |Api|
|
||||
|groupId|Generated artifact package's organization (i.e. maven groupId).| |org.openapitools|
|
||||
|artifactId|Generated artifact id (name of jar).| |kotlin-server|
|
||||
|artifactVersion|Generated artifact's package version.| |1.0.0|
|
||||
|enumPropertyNaming|Naming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'| |camelCase|
|
||||
|serializationLibrary|What serialization library to use: 'moshi' (default), or 'gson'| |moshi|
|
||||
|parcelizeModels|toggle "@Parcelize" for generated models| |null|
|
||||
|serializableModel|boolean - toggle "implements Serializable" for generated models| |null|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |null|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |null|
|
||||
|modelMutable|Create mutable models| |false|
|
||||
|library|library template (sub-template)|<dl><dt>**ktor**</dt><dd>ktor framework</dd><dl>|ktor|
|
||||
|featureAutoHead|Automatically provide responses to HEAD requests for existing routes that have the GET verb defined.| |true|
|
||||
|featureConditionalHeaders|Avoid sending content if client already has same content, by checking ETag or LastModified properties.| |false|
|
||||
|featureHSTS|Avoid sending content if client already has same content, by checking ETag or LastModified properties.| |true|
|
||||
|featureCORS|Ktor by default provides an interceptor for implementing proper support for Cross-Origin Resource Sharing (CORS). See enable-cors.org.| |false|
|
||||
|featureCompression|Adds ability to compress outgoing content using gzip, deflate or custom encoder and thus reduce size of the response.| |true|
|
||||
|featureConditionalHeaders|Avoid sending content if client already has same content, by checking ETag or LastModified properties.| |false|
|
||||
|featureHSTS|Avoid sending content if client already has same content, by checking ETag or LastModified properties.| |true|
|
||||
|groupId|Generated artifact package's organization (i.e. maven groupId).| |org.openapitools|
|
||||
|library|library template (sub-template)|<dl><dt>**ktor**</dt><dd>ktor framework</dd><dl>|ktor|
|
||||
|modelMutable|Create mutable models| |false|
|
||||
|packageName|Generated artifact package name.| |org.openapitools.server|
|
||||
|parcelizeModels|toggle "@Parcelize" for generated models| |null|
|
||||
|serializableModel|boolean - toggle "implements Serializable" for generated models| |null|
|
||||
|serializationLibrary|What serialization library to use: 'moshi' (default), or 'gson'| |moshi|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |null|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |null|
|
||||
|sourceFolder|source folder for generated code| |src/main/kotlin|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|LocalDateTime|java.time.LocalDateTime|
|
||||
|LocalTime|java.time.LocalTime|
|
||||
|UUID|java.util.UUID|
|
||||
|URI|java.net.URI|
|
||||
|File|java.io.File|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|LocalDate|java.time.LocalDate|
|
||||
|BigDecimal|java.math.BigDecimal|
|
||||
|Date|java.util.Date|
|
||||
|DateTime|java.time.LocalDateTime|
|
||||
|File|java.io.File|
|
||||
|LocalDate|java.time.LocalDate|
|
||||
|LocalDateTime|java.time.LocalDateTime|
|
||||
|LocalTime|java.time.LocalTime|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|URI|java.net.URI|
|
||||
|UUID|java.util.UUID|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
@ -52,50 +52,50 @@ sidebar_label: kotlin-server
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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.collections.List</li>
|
||||
<li>kotlin.Float</li>
|
||||
<li>kotlin.Double</li>
|
||||
<li>kotlin.String</li>
|
||||
<li>kotlin.Array</li>
|
||||
<li>kotlin.Byte</li>
|
||||
<li>kotlin.collections.Map</li>
|
||||
<li>kotlin.Short</li>
|
||||
<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.Long</li>
|
||||
<li>kotlin.Char</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>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>for</li>
|
||||
<li>do</li>
|
||||
<li>interface</li>
|
||||
<li>while</li>
|
||||
<li>when</li>
|
||||
<li>continue</li>
|
||||
<li>else</li>
|
||||
<li>typealias</li>
|
||||
<li>class</li>
|
||||
<li>if</li>
|
||||
<li>typeof</li>
|
||||
<li>val</li>
|
||||
<li>package</li>
|
||||
<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>as</li>
|
||||
<li>break</li>
|
||||
<li>in</li>
|
||||
<li>var</li>
|
||||
<li>class</li>
|
||||
<li>continue</li>
|
||||
<li>do</li>
|
||||
<li>else</li>
|
||||
<li>false</li>
|
||||
<li>this</li>
|
||||
<li>for</li>
|
||||
<li>fun</li>
|
||||
<li>if</li>
|
||||
<li>in</li>
|
||||
<li>interface</li>
|
||||
<li>is</li>
|
||||
<li>super</li>
|
||||
<li>as</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>fun</li>
|
||||
<li>return</li>
|
||||
<li>object</li>
|
||||
<li>typealias</li>
|
||||
<li>typeof</li>
|
||||
<li>val</li>
|
||||
<li>var</li>
|
||||
<li>when</li>
|
||||
<li>while</li>
|
||||
</ul>
|
||||
|
||||
@ -5,49 +5,49 @@ sidebar_label: kotlin-spring
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sourceFolder|source folder for generated code| |src/main/kotlin|
|
||||
|packageName|Generated artifact package name.| |org.openapitools|
|
||||
|apiPackage|api package for generated code| |org.openapitools.api|
|
||||
|apiSuffix|suffix for api classes| |Api|
|
||||
|groupId|Generated artifact package's organization (i.e. maven groupId).| |org.openapitools|
|
||||
|artifactId|Generated artifact id (name of jar).| |openapi-spring|
|
||||
|artifactVersion|Generated artifact's package version.| |1.0.0|
|
||||
|enumPropertyNaming|Naming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'| |camelCase|
|
||||
|serializationLibrary|What serialization library to use: 'moshi' (default), or 'gson'| |moshi|
|
||||
|parcelizeModels|toggle "@Parcelize" for generated models| |null|
|
||||
|serializableModel|boolean - toggle "implements Serializable" for generated models| |null|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |null|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |null|
|
||||
|modelMutable|Create mutable models| |false|
|
||||
|title|server title name or client service name| |OpenAPI Kotlin Spring|
|
||||
|basePackage|base package (invokerPackage) for generated code| |org.openapitools|
|
||||
|serverPort|configuration the port in which the sever is to run on| |8080|
|
||||
|modelPackage|model package for generated code| |org.openapitools.model|
|
||||
|apiPackage|api package for generated code| |org.openapitools.api|
|
||||
|delegatePattern|Whether to generate the server files using the delegate pattern| |false|
|
||||
|enumPropertyNaming|Naming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'| |camelCase|
|
||||
|exceptionHandler|generate default global exception handlers (not compatible with reactive. enabling reactive will disable exceptionHandler )| |true|
|
||||
|gradleBuildFile|generate a gradle build file using the Kotlin DSL| |true|
|
||||
|swaggerAnnotations|generate swagger annotations to go alongside controllers and models| |false|
|
||||
|serviceInterface|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| |false|
|
||||
|serviceImplementation|generate stub service implementations that extends service interfaces. If this is set to true service interfaces will also be generated| |false|
|
||||
|useBeanValidation|Use BeanValidation API annotations to validate data types| |true|
|
||||
|reactive|use coroutines for reactive behavior| |false|
|
||||
|groupId|Generated artifact package's organization (i.e. maven groupId).| |org.openapitools|
|
||||
|interfaceOnly|Whether to generate only API interface stubs without the server files.| |false|
|
||||
|delegatePattern|Whether to generate the server files using the delegate pattern| |false|
|
||||
|library|library template (sub-template)|<dl><dt>**spring-boot**</dt><dd>Spring-boot Server application.</dd><dl>|spring-boot|
|
||||
|modelMutable|Create mutable models| |false|
|
||||
|modelPackage|model package for generated code| |org.openapitools.model|
|
||||
|packageName|Generated artifact package name.| |org.openapitools|
|
||||
|parcelizeModels|toggle "@Parcelize" for generated models| |null|
|
||||
|reactive|use coroutines for reactive behavior| |false|
|
||||
|serializableModel|boolean - toggle "implements Serializable" for generated models| |null|
|
||||
|serializationLibrary|What serialization library to use: 'moshi' (default), or 'gson'| |moshi|
|
||||
|serverPort|configuration the port in which the sever is to run on| |8080|
|
||||
|serviceImplementation|generate stub service implementations that extends service interfaces. If this is set to true service interfaces will also be generated| |false|
|
||||
|serviceInterface|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| |false|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |null|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |null|
|
||||
|sourceFolder|source folder for generated code| |src/main/kotlin|
|
||||
|swaggerAnnotations|generate swagger annotations to go alongside controllers and models| |false|
|
||||
|title|server title name or client service name| |OpenAPI Kotlin Spring|
|
||||
|useBeanValidation|Use BeanValidation API annotations to validate data types| |true|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|LocalDateTime|java.time.LocalDateTime|
|
||||
|LocalTime|java.time.LocalTime|
|
||||
|UUID|java.util.UUID|
|
||||
|URI|java.net.URI|
|
||||
|File|java.io.File|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|LocalDate|java.time.LocalDate|
|
||||
|BigDecimal|java.math.BigDecimal|
|
||||
|Date|java.time.LocalDate|
|
||||
|DateTime|java.time.OffsetDateTime|
|
||||
|File|java.io.File|
|
||||
|LocalDate|java.time.LocalDate|
|
||||
|LocalDateTime|java.time.LocalDateTime|
|
||||
|LocalTime|java.time.LocalTime|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|URI|java.net.URI|
|
||||
|UUID|java.util.UUID|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
@ -61,53 +61,53 @@ sidebar_label: kotlin-spring
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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.collections.List</li>
|
||||
<li>kotlin.Float</li>
|
||||
<li>kotlin.Double</li>
|
||||
<li>kotlin.String</li>
|
||||
<li>kotlin.Array</li>
|
||||
<li>kotlin.Byte</li>
|
||||
<li>kotlin.collections.Map</li>
|
||||
<li>kotlin.Short</li>
|
||||
<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.Long</li>
|
||||
<li>kotlin.Char</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>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>for</li>
|
||||
<li>do</li>
|
||||
<li>interface</li>
|
||||
<li>while</li>
|
||||
<li>when</li>
|
||||
<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>continue</li>
|
||||
<li>else</li>
|
||||
<li>typealias</li>
|
||||
<li>class</li>
|
||||
<li>if</li>
|
||||
<li>typeof</li>
|
||||
<li>val</li>
|
||||
<li>package</li>
|
||||
<li>break</li>
|
||||
<li>in</li>
|
||||
<li>var</li>
|
||||
<li>false</li>
|
||||
<li>this</li>
|
||||
<li>is</li>
|
||||
<li>ApiClient</li>
|
||||
<li>super</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>fun</li>
|
||||
<li>return</li>
|
||||
<li>object</li>
|
||||
<li>ApiException</li>
|
||||
<li>typealias</li>
|
||||
<li>typeof</li>
|
||||
<li>val</li>
|
||||
<li>var</li>
|
||||
<li>when</li>
|
||||
<li>while</li>
|
||||
</ul>
|
||||
|
||||
@ -5,34 +5,34 @@ sidebar_label: kotlin-vertx
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sourceFolder|source folder for generated code| |src/main/kotlin|
|
||||
|packageName|Generated artifact package name.| |org.openapitools|
|
||||
|apiSuffix|suffix for api classes| |Api|
|
||||
|groupId|Generated artifact package's organization (i.e. maven groupId).| |org.openapitools|
|
||||
|artifactId|Generated artifact id (name of jar).| |null|
|
||||
|artifactVersion|Generated artifact's package version.| |1.0.0|
|
||||
|enumPropertyNaming|Naming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'| |camelCase|
|
||||
|serializationLibrary|What serialization library to use: 'moshi' (default), or 'gson'| |moshi|
|
||||
|groupId|Generated artifact package's organization (i.e. maven groupId).| |org.openapitools|
|
||||
|modelMutable|Create mutable models| |false|
|
||||
|packageName|Generated artifact package name.| |org.openapitools|
|
||||
|parcelizeModels|toggle "@Parcelize" for generated models| |null|
|
||||
|serializableModel|boolean - toggle "implements Serializable" for generated models| |null|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |null|
|
||||
|serializationLibrary|What serialization library to use: 'moshi' (default), or 'gson'| |moshi|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |null|
|
||||
|modelMutable|Create mutable models| |false|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |null|
|
||||
|sourceFolder|source folder for generated code| |src/main/kotlin|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|LocalDateTime|java.time.LocalDateTime|
|
||||
|LocalTime|java.time.LocalTime|
|
||||
|UUID|java.util.UUID|
|
||||
|URI|java.net.URI|
|
||||
|File|java.io.File|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|LocalDate|java.time.LocalDate|
|
||||
|BigDecimal|java.math.BigDecimal|
|
||||
|Date|java.util.Date|
|
||||
|DateTime|java.time.LocalDateTime|
|
||||
|File|java.io.File|
|
||||
|LocalDate|java.time.LocalDate|
|
||||
|LocalDateTime|java.time.LocalDateTime|
|
||||
|LocalTime|java.time.LocalTime|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|URI|java.net.URI|
|
||||
|UUID|java.util.UUID|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
@ -46,50 +46,50 @@ sidebar_label: kotlin-vertx
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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.collections.List</li>
|
||||
<li>kotlin.Float</li>
|
||||
<li>kotlin.Double</li>
|
||||
<li>kotlin.String</li>
|
||||
<li>kotlin.Array</li>
|
||||
<li>kotlin.Byte</li>
|
||||
<li>kotlin.collections.Map</li>
|
||||
<li>kotlin.Short</li>
|
||||
<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.Long</li>
|
||||
<li>kotlin.Char</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>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>for</li>
|
||||
<li>do</li>
|
||||
<li>interface</li>
|
||||
<li>while</li>
|
||||
<li>when</li>
|
||||
<li>continue</li>
|
||||
<li>else</li>
|
||||
<li>typealias</li>
|
||||
<li>class</li>
|
||||
<li>if</li>
|
||||
<li>typeof</li>
|
||||
<li>val</li>
|
||||
<li>package</li>
|
||||
<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>as</li>
|
||||
<li>break</li>
|
||||
<li>in</li>
|
||||
<li>var</li>
|
||||
<li>class</li>
|
||||
<li>continue</li>
|
||||
<li>do</li>
|
||||
<li>else</li>
|
||||
<li>false</li>
|
||||
<li>this</li>
|
||||
<li>for</li>
|
||||
<li>fun</li>
|
||||
<li>if</li>
|
||||
<li>in</li>
|
||||
<li>interface</li>
|
||||
<li>is</li>
|
||||
<li>super</li>
|
||||
<li>as</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>fun</li>
|
||||
<li>return</li>
|
||||
<li>object</li>
|
||||
<li>typealias</li>
|
||||
<li>typeof</li>
|
||||
<li>val</li>
|
||||
<li>var</li>
|
||||
<li>when</li>
|
||||
<li>while</li>
|
||||
</ul>
|
||||
|
||||
@ -5,38 +5,38 @@ sidebar_label: kotlin
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sourceFolder|source folder for generated code| |src/main/kotlin|
|
||||
|packageName|Generated artifact package name.| |org.openapitools.client|
|
||||
|apiSuffix|suffix for api classes| |Api|
|
||||
|groupId|Generated artifact package's organization (i.e. maven groupId).| |org.openapitools|
|
||||
|artifactId|Generated artifact id (name of jar).| |kotlin-client|
|
||||
|artifactVersion|Generated artifact's package version.| |1.0.0|
|
||||
|enumPropertyNaming|Naming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'| |camelCase|
|
||||
|serializationLibrary|What serialization library to use: 'moshi' (default), or 'gson'| |moshi|
|
||||
|parcelizeModels|toggle "@Parcelize" for generated models| |null|
|
||||
|serializableModel|boolean - toggle "implements Serializable" for generated models| |null|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |null|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |null|
|
||||
|modelMutable|Create mutable models| |false|
|
||||
|dateLibrary|Option. Date library to use|<dl><dt>**threetenbp-localdatetime**</dt><dd>Threetenbp - Backport of JSR310 (jvm only, for legacy app only)</dd><dt>**string**</dt><dd>String</dd><dt>**java8-localdatetime**</dt><dd>Java 8 native JSR310 (jvm only, for legacy app only)</dd><dt>**java8**</dt><dd>Java 8 native JSR310 (jvm only, preferred for jdk 1.8+)</dd><dt>**threetenbp**</dt><dd>Threetenbp - Backport of JSR310 (jvm only, preferred for jdk < 1.8)</dd><dl>|java8|
|
||||
|collectionType|Option. Collection type to use|<dl><dt>**array**</dt><dd>kotlin.Array</dd><dt>**list**</dt><dd>kotlin.collections.List</dd><dl>|array|
|
||||
|dateLibrary|Option. Date library to use|<dl><dt>**threetenbp-localdatetime**</dt><dd>Threetenbp - Backport of JSR310 (jvm only, for legacy app only)</dd><dt>**string**</dt><dd>String</dd><dt>**java8-localdatetime**</dt><dd>Java 8 native JSR310 (jvm only, for legacy app only)</dd><dt>**java8**</dt><dd>Java 8 native JSR310 (jvm only, preferred for jdk 1.8+)</dd><dt>**threetenbp**</dt><dd>Threetenbp - Backport of JSR310 (jvm only, preferred for jdk < 1.8)</dd><dl>|java8|
|
||||
|enumPropertyNaming|Naming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'| |camelCase|
|
||||
|groupId|Generated artifact package's organization (i.e. maven groupId).| |org.openapitools|
|
||||
|library|Library template (sub-template) to use|<dl><dt>**jvm-okhttp4**</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>**jvm-okhttp3**</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>**jvm-retrofit2**</dt><dd>Platform: Java Virtual Machine. HTTP client: Retrofit 2.6.2.</dd><dt>**multiplatform**</dt><dd>Platform: Kotlin multiplatform. HTTP client: Ktor 1.2.4. JSON processing: Kotlinx Serialization: 0.12.0.</dd><dl>|jvm-okhttp4|
|
||||
|modelMutable|Create mutable models| |false|
|
||||
|packageName|Generated artifact package name.| |org.openapitools.client|
|
||||
|parcelizeModels|toggle "@Parcelize" for generated models| |null|
|
||||
|requestDateConverter|JVM-Option. Defines in how to handle date-time objects that are used for a request (as query or parameter)|<dl><dt>**toJson**</dt><dd>Date formater option using a json converter.</dd><dt>**toString**</dt><dd>[DEFAULT] Use the 'toString'-method of the date-time object to retrieve the related string representation.</dd><dl>|toString|
|
||||
|serializableModel|boolean - toggle "implements Serializable" for generated models| |null|
|
||||
|serializationLibrary|What serialization library to use: 'moshi' (default), or 'gson'| |moshi|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |null|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |null|
|
||||
|sourceFolder|source folder for generated code| |src/main/kotlin|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|LocalDateTime|java.time.LocalDateTime|
|
||||
|LocalTime|java.time.LocalTime|
|
||||
|UUID|java.util.UUID|
|
||||
|URI|java.net.URI|
|
||||
|File|java.io.File|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|LocalDate|java.time.LocalDate|
|
||||
|BigDecimal|java.math.BigDecimal|
|
||||
|Date|java.util.Date|
|
||||
|DateTime|java.time.LocalDateTime|
|
||||
|File|java.io.File|
|
||||
|LocalDate|java.time.LocalDate|
|
||||
|LocalDateTime|java.time.LocalDateTime|
|
||||
|LocalTime|java.time.LocalTime|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|URI|java.net.URI|
|
||||
|UUID|java.util.UUID|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
@ -50,50 +50,50 @@ sidebar_label: kotlin
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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.collections.List</li>
|
||||
<li>kotlin.Float</li>
|
||||
<li>kotlin.Double</li>
|
||||
<li>kotlin.String</li>
|
||||
<li>kotlin.Array</li>
|
||||
<li>kotlin.Byte</li>
|
||||
<li>kotlin.collections.Map</li>
|
||||
<li>kotlin.Short</li>
|
||||
<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.Long</li>
|
||||
<li>kotlin.Char</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>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>for</li>
|
||||
<li>do</li>
|
||||
<li>interface</li>
|
||||
<li>while</li>
|
||||
<li>when</li>
|
||||
<li>continue</li>
|
||||
<li>else</li>
|
||||
<li>typealias</li>
|
||||
<li>class</li>
|
||||
<li>if</li>
|
||||
<li>typeof</li>
|
||||
<li>val</li>
|
||||
<li>package</li>
|
||||
<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>as</li>
|
||||
<li>break</li>
|
||||
<li>in</li>
|
||||
<li>var</li>
|
||||
<li>class</li>
|
||||
<li>continue</li>
|
||||
<li>do</li>
|
||||
<li>else</li>
|
||||
<li>false</li>
|
||||
<li>this</li>
|
||||
<li>for</li>
|
||||
<li>fun</li>
|
||||
<li>if</li>
|
||||
<li>in</li>
|
||||
<li>interface</li>
|
||||
<li>is</li>
|
||||
<li>super</li>
|
||||
<li>as</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>fun</li>
|
||||
<li>return</li>
|
||||
<li>object</li>
|
||||
<li>typealias</li>
|
||||
<li>typeof</li>
|
||||
<li>val</li>
|
||||
<li>var</li>
|
||||
<li>when</li>
|
||||
<li>while</li>
|
||||
</ul>
|
||||
|
||||
@ -5,17 +5,17 @@ sidebar_label: lua
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true|
|
||||
|packageName|Lua package name (convention: single word).| |openapiclient|
|
||||
|packageVersion|Lua package version.| |1.0.0-1|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|time.Time|time|
|
||||
|os|io/ioutil|
|
||||
|*os.File|os|
|
||||
|os|io/ioutil|
|
||||
|time.Time|time|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
@ -26,39 +26,39 @@ sidebar_label: lua
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>nil</li>
|
||||
<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>boolean</li>
|
||||
<li>nil</li>
|
||||
<li>number</li>
|
||||
<li>boolean</li>
|
||||
<li>string</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>string</li>
|
||||
<li>for</li>
|
||||
<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>and</li>
|
||||
<li>boolean</li>
|
||||
<li>break</li>
|
||||
<li>do</li>
|
||||
<li>while</li>
|
||||
<li>local</li>
|
||||
<li>nil</li>
|
||||
<li>number</li>
|
||||
<li>userdata</li>
|
||||
<li>not</li>
|
||||
<li>and</li>
|
||||
<li>else</li>
|
||||
<li>elseif</li>
|
||||
<li>function</li>
|
||||
<li>repeat</li>
|
||||
<li>end</li>
|
||||
<li>if</li>
|
||||
<li>table</li>
|
||||
<li>or</li>
|
||||
<li>break</li>
|
||||
<li>in</li>
|
||||
<li>false</li>
|
||||
<li>thread</li>
|
||||
<li>for</li>
|
||||
<li>function</li>
|
||||
<li>if</li>
|
||||
<li>in</li>
|
||||
<li>local</li>
|
||||
<li>nil</li>
|
||||
<li>not</li>
|
||||
<li>number</li>
|
||||
<li>or</li>
|
||||
<li>repeat</li>
|
||||
<li>return</li>
|
||||
<li>string</li>
|
||||
<li>table</li>
|
||||
<li>then</li>
|
||||
<li>boolean</li>
|
||||
<li>thread</li>
|
||||
<li>true</li>
|
||||
<li>until</li>
|
||||
<li>return</li>
|
||||
<li>userdata</li>
|
||||
<li>while</li>
|
||||
</ul>
|
||||
|
||||
@ -5,32 +5,32 @@ sidebar_label: markdown
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|Set|java.util.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|HashMap|java.util.HashMap|
|
||||
|Array|java.util.List|
|
||||
|ArrayList|java.util.ArrayList|
|
||||
|URI|java.net.URI|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|BigDecimal|java.math.BigDecimal|
|
||||
|Date|java.util.Date|
|
||||
|DateTime|org.joda.time.*|
|
||||
|Array|java.util.List|
|
||||
|List|java.util.*|
|
||||
|UUID|java.util.UUID|
|
||||
|File|java.io.File|
|
||||
|HashMap|java.util.HashMap|
|
||||
|List|java.util.*|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|Map|java.util.Map|
|
||||
|Set|java.util.*|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|URI|java.net.URI|
|
||||
|UUID|java.util.UUID|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
|
||||
@ -6,8 +6,8 @@ sidebar_label: mysql-schema
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|defaultDatabaseName|Default database name for all MySQL queries| ||
|
||||
|jsonDataTypeEnabled|Use special JSON MySQL data type for complex model properties. Requires MySQL version 5.7.8. Generates TEXT data type when disabled| |true|
|
||||
|identifierNamingConvention|Naming convention of MySQL identifiers(table names and column names). This is not related to database name which is defined by defaultDatabaseName option|<dl><dt>**original**</dt><dd>Do not transform original names</dd><dt>**snake_case**</dt><dd>Use snake_case names</dd><dl>|original|
|
||||
|jsonDataTypeEnabled|Use special JSON MySQL data type for complex model properties. Requires MySQL version 5.7.8. Generates TEXT data type when disabled| |true|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
@ -23,294 +23,294 @@ sidebar_label: mysql-schema
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>date</li>
|
||||
<li>void</li>
|
||||
<li>bool</li>
|
||||
<li>string</li>
|
||||
<li>double</li>
|
||||
<li>byte</li>
|
||||
<li>mixed</li>
|
||||
<li>integer</li>
|
||||
<li>float</li>
|
||||
<li>URI</li>
|
||||
<li>int</li>
|
||||
<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>BigDecimal</li>
|
||||
<li>ByteArray</li>
|
||||
<li>Date</li>
|
||||
<li>DateTime</li>
|
||||
<li>long</li>
|
||||
<li>BigDecimal</li>
|
||||
<li>number</li>
|
||||
<li>boolean</li>
|
||||
<li>file</li>
|
||||
<li>binary</li>
|
||||
<li>char</li>
|
||||
<li>short</li>
|
||||
<li>ByteArray</li>
|
||||
<li>URI</li>
|
||||
<li>UUID</li>
|
||||
<li>binary</li>
|
||||
<li>bool</li>
|
||||
<li>boolean</li>
|
||||
<li>byte</li>
|
||||
<li>char</li>
|
||||
<li>date</li>
|
||||
<li>double</li>
|
||||
<li>file</li>
|
||||
<li>float</li>
|
||||
<li>int</li>
|
||||
<li>integer</li>
|
||||
<li>long</li>
|
||||
<li>mixed</li>
|
||||
<li>number</li>
|
||||
<li>short</li>
|
||||
<li>string</li>
|
||||
<li>void</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>dec</li>
|
||||
<li>low_priority</li>
|
||||
<li>references</li>
|
||||
<li>leading</li>
|
||||
<li>insensitive</li>
|
||||
<li>ssl</li>
|
||||
<li>character</li>
|
||||
<li>int2</li>
|
||||
<li>int1</li>
|
||||
<li>io_after_gtids</li>
|
||||
<li>trailing</li>
|
||||
<li>int4</li>
|
||||
<li>int3</li>
|
||||
<li>utc_time</li>
|
||||
<li>int8</li>
|
||||
<li>optimizer_costs</li>
|
||||
<li>rank</li>
|
||||
<li>cube</li>
|
||||
<li>databases</li>
|
||||
<li>using</li>
|
||||
<li>outer</li>
|
||||
<li>require</li>
|
||||
<li>then</li>
|
||||
<li>each</li>
|
||||
<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>accessible</li>
|
||||
<li>add</li>
|
||||
<li>all</li>
|
||||
<li>alter</li>
|
||||
<li>analyze</li>
|
||||
<li>and</li>
|
||||
<li>as</li>
|
||||
<li>left</li>
|
||||
<li>unique</li>
|
||||
<li>except</li>
|
||||
<li>starting</li>
|
||||
<li>schema</li>
|
||||
<li>accessible</li>
|
||||
<li>role</li>
|
||||
<li>deterministic</li>
|
||||
<li>long</li>
|
||||
<li>into</li>
|
||||
<li>smallint</li>
|
||||
<li>default</li>
|
||||
<li>dual</li>
|
||||
<li>partition</li>
|
||||
<li>varying</li>
|
||||
<li>by</li>
|
||||
<li>ntile</li>
|
||||
<li>where</li>
|
||||
<li>xor</li>
|
||||
<li>persist</li>
|
||||
<li>current_time</li>
|
||||
<li>key</li>
|
||||
<li>iterate</li>
|
||||
<li>set</li>
|
||||
<li>column</li>
|
||||
<li>minute_microsecond</li>
|
||||
<li>procedure</li>
|
||||
<li>right</li>
|
||||
<li>union</li>
|
||||
<li>asc</li>
|
||||
<li>asensitive</li>
|
||||
<li>before</li>
|
||||
<li>between</li>
|
||||
<li>bigint</li>
|
||||
<li>binary</li>
|
||||
<li>blob</li>
|
||||
<li>both</li>
|
||||
<li>by</li>
|
||||
<li>call</li>
|
||||
<li>varbinary</li>
|
||||
<li>longblob</li>
|
||||
<li>describe</li>
|
||||
<li>to</li>
|
||||
<li>localtime</li>
|
||||
<li>sql_big_result</li>
|
||||
<li>cascade</li>
|
||||
<li>case</li>
|
||||
<li>change</li>
|
||||
<li>char</li>
|
||||
<li>character</li>
|
||||
<li>check</li>
|
||||
<li>collate</li>
|
||||
<li>column</li>
|
||||
<li>condition</li>
|
||||
<li>constraint</li>
|
||||
<li>continue</li>
|
||||
<li>convert</li>
|
||||
<li>create</li>
|
||||
<li>cross</li>
|
||||
<li>cube</li>
|
||||
<li>cume_dist</li>
|
||||
<li>current_date</li>
|
||||
<li>current_time</li>
|
||||
<li>current_timestamp</li>
|
||||
<li>current_user</li>
|
||||
<li>cursor</li>
|
||||
<li>database</li>
|
||||
<li>databases</li>
|
||||
<li>day_hour</li>
|
||||
<li>day_microsecond</li>
|
||||
<li>day_minute</li>
|
||||
<li>day_second</li>
|
||||
<li>dec</li>
|
||||
<li>decimal</li>
|
||||
<li>declare</li>
|
||||
<li>default</li>
|
||||
<li>delayed</li>
|
||||
<li>delete</li>
|
||||
<li>dense_rank</li>
|
||||
<li>desc</li>
|
||||
<li>describe</li>
|
||||
<li>deterministic</li>
|
||||
<li>distinct</li>
|
||||
<li>distinctrow</li>
|
||||
<li>div</li>
|
||||
<li>double</li>
|
||||
<li>drop</li>
|
||||
<li>dual</li>
|
||||
<li>each</li>
|
||||
<li>else</li>
|
||||
<li>elseif</li>
|
||||
<li>empty</li>
|
||||
<li>enclosed</li>
|
||||
<li>div</li>
|
||||
<li>generated</li>
|
||||
<li>continue</li>
|
||||
<li>leave</li>
|
||||
<li>loop</li>
|
||||
<li>elseif</li>
|
||||
<li>hour_second</li>
|
||||
<li>row_number</li>
|
||||
<li>signal</li>
|
||||
<li>add</li>
|
||||
<li>percent_rank</li>
|
||||
<li>unlock</li>
|
||||
<li>last_value</li>
|
||||
<li>mediumtext</li>
|
||||
<li>check</li>
|
||||
<li>escaped</li>
|
||||
<li>collate</li>
|
||||
<li>schemas</li>
|
||||
<li>persist_only</li>
|
||||
<li>decimal</li>
|
||||
<li>desc</li>
|
||||
<li>cursor</li>
|
||||
<li>drop</li>
|
||||
<li>virtual</li>
|
||||
<li>asensitive</li>
|
||||
<li>for</li>
|
||||
<li>show</li>
|
||||
<li>revoke</li>
|
||||
<li>update</li>
|
||||
<li>purge</li>
|
||||
<li>not</li>
|
||||
<li>undo</li>
|
||||
<li>zerofill</li>
|
||||
<li>json_table</li>
|
||||
<li>load</li>
|
||||
<li>straight_join</li>
|
||||
<li>ignore</li>
|
||||
<li>lines</li>
|
||||
<li>over</li>
|
||||
<li>mediumint</li>
|
||||
<li>varchar</li>
|
||||
<li>false</li>
|
||||
<li>dense_rank</li>
|
||||
<li>mediumblob</li>
|
||||
<li>with</li>
|
||||
<li>window</li>
|
||||
<li>grant</li>
|
||||
<li>day_second</li>
|
||||
<li>explain</li>
|
||||
<li>maxvalue</li>
|
||||
<li>mod</li>
|
||||
<li>select</li>
|
||||
<li>release</li>
|
||||
<li>usage</li>
|
||||
<li>optionally</li>
|
||||
<li>middleint</li>
|
||||
<li>delayed</li>
|
||||
<li>convert</li>
|
||||
<li>localtimestamp</li>
|
||||
<li>sql_small_result</li>
|
||||
<li>when</li>
|
||||
<li>cume_dist</li>
|
||||
<li>else</li>
|
||||
<li>lock</li>
|
||||
<li>join</li>
|
||||
<li>spatial</li>
|
||||
<li>if</li>
|
||||
<li>write</li>
|
||||
<li>between</li>
|
||||
<li>case</li>
|
||||
<li>sqlstate</li>
|
||||
<li>order</li>
|
||||
<li>year_month</li>
|
||||
<li>read_write</li>
|
||||
<li>having</li>
|
||||
<li>natural</li>
|
||||
<li>in</li>
|
||||
<li>double</li>
|
||||
<li>tinytext</li>
|
||||
<li>index</li>
|
||||
<li>tinyint</li>
|
||||
<li>is</li>
|
||||
<li>sensitive</li>
|
||||
<li>grouping</li>
|
||||
<li>exit</li>
|
||||
<li>current_date</li>
|
||||
<li>system</li>
|
||||
<li>analyze</li>
|
||||
<li>binary</li>
|
||||
<li>sqlwarning</li>
|
||||
<li>force</li>
|
||||
<li>interval</li>
|
||||
<li>master_bind</li>
|
||||
<li>minute_second</li>
|
||||
<li>primary</li>
|
||||
<li>regexp</li>
|
||||
<li>range</li>
|
||||
<li>sqlexception</li>
|
||||
<li>infile</li>
|
||||
<li>restrict</li>
|
||||
<li>recursive</li>
|
||||
<li>foreign</li>
|
||||
<li>hour_microsecond</li>
|
||||
<li>out</li>
|
||||
<li>distinctrow</li>
|
||||
<li>get</li>
|
||||
<li>fulltext</li>
|
||||
<li>table</li>
|
||||
<li>current_user</li>
|
||||
<li>linear</li>
|
||||
<li>second_microsecond</li>
|
||||
<li>change</li>
|
||||
<li>utc_timestamp</li>
|
||||
<li>float8</li>
|
||||
<li>io_before_gtids</li>
|
||||
<li>trigger</li>
|
||||
<li>float4</li>
|
||||
<li>kill</li>
|
||||
<li>lead</li>
|
||||
<li>day_minute</li>
|
||||
<li>rlike</li>
|
||||
<li>rename</li>
|
||||
<li>hour_minute</li>
|
||||
<li>fetch</li>
|
||||
<li>stored</li>
|
||||
<li>char</li>
|
||||
<li>except</li>
|
||||
<li>exists</li>
|
||||
<li>constraint</li>
|
||||
<li>high_priority</li>
|
||||
<li>return</li>
|
||||
<li>no_write_to_binlog</li>
|
||||
<li>sql_calc_found_rows</li>
|
||||
<li>before</li>
|
||||
<li>use</li>
|
||||
<li>precision</li>
|
||||
<li>modifies</li>
|
||||
<li>replace</li>
|
||||
<li>integer</li>
|
||||
<li>float</li>
|
||||
<li>while</li>
|
||||
<li>lag</li>
|
||||
<li>optimize</li>
|
||||
<li>nth_value</li>
|
||||
<li>function</li>
|
||||
<li>limit</li>
|
||||
<li>varcharacter</li>
|
||||
<li>create</li>
|
||||
<li>from</li>
|
||||
<li>tinyblob</li>
|
||||
<li>alter</li>
|
||||
<li>group</li>
|
||||
<li>all</li>
|
||||
<li>read</li>
|
||||
<li>like</li>
|
||||
<li>cascade</li>
|
||||
<li>real</li>
|
||||
<li>inner</li>
|
||||
<li>separator</li>
|
||||
<li>both</li>
|
||||
<li>day_microsecond</li>
|
||||
<li>condition</li>
|
||||
<li>blob</li>
|
||||
<li>null</li>
|
||||
<li>true</li>
|
||||
<li>day_hour</li>
|
||||
<li>option</li>
|
||||
<li>longtext</li>
|
||||
<li>keys</li>
|
||||
<li>outfile</li>
|
||||
<li>values</li>
|
||||
<li>distinct</li>
|
||||
<li>insert</li>
|
||||
<li>numeric</li>
|
||||
<li>resignal</li>
|
||||
<li>delete</li>
|
||||
<li>sql</li>
|
||||
<li>database</li>
|
||||
<li>master_ssl_verify_server_cert</li>
|
||||
<li>and</li>
|
||||
<li>current_timestamp</li>
|
||||
<li>of</li>
|
||||
<li>repeat</li>
|
||||
<li>exit</li>
|
||||
<li>explain</li>
|
||||
<li>false</li>
|
||||
<li>fetch</li>
|
||||
<li>first_value</li>
|
||||
<li>row</li>
|
||||
<li>bigint</li>
|
||||
<li>terminated</li>
|
||||
<li>on</li>
|
||||
<li>or</li>
|
||||
<li>cross</li>
|
||||
<li>match</li>
|
||||
<li>reads</li>
|
||||
<li>float</li>
|
||||
<li>float4</li>
|
||||
<li>float8</li>
|
||||
<li>for</li>
|
||||
<li>force</li>
|
||||
<li>foreign</li>
|
||||
<li>from</li>
|
||||
<li>fulltext</li>
|
||||
<li>function</li>
|
||||
<li>generated</li>
|
||||
<li>get</li>
|
||||
<li>grant</li>
|
||||
<li>group</li>
|
||||
<li>grouping</li>
|
||||
<li>groups</li>
|
||||
<li>rows</li>
|
||||
<li>specific</li>
|
||||
<li>int</li>
|
||||
<li>having</li>
|
||||
<li>high_priority</li>
|
||||
<li>hour_microsecond</li>
|
||||
<li>hour_minute</li>
|
||||
<li>hour_second</li>
|
||||
<li>if</li>
|
||||
<li>ignore</li>
|
||||
<li>in</li>
|
||||
<li>index</li>
|
||||
<li>infile</li>
|
||||
<li>inner</li>
|
||||
<li>inout</li>
|
||||
<li>insensitive</li>
|
||||
<li>insert</li>
|
||||
<li>int</li>
|
||||
<li>int1</li>
|
||||
<li>int2</li>
|
||||
<li>int3</li>
|
||||
<li>int4</li>
|
||||
<li>int8</li>
|
||||
<li>integer</li>
|
||||
<li>interval</li>
|
||||
<li>into</li>
|
||||
<li>io_after_gtids</li>
|
||||
<li>io_before_gtids</li>
|
||||
<li>is</li>
|
||||
<li>iterate</li>
|
||||
<li>join</li>
|
||||
<li>json_table</li>
|
||||
<li>key</li>
|
||||
<li>keys</li>
|
||||
<li>kill</li>
|
||||
<li>lag</li>
|
||||
<li>last_value</li>
|
||||
<li>lead</li>
|
||||
<li>leading</li>
|
||||
<li>leave</li>
|
||||
<li>left</li>
|
||||
<li>like</li>
|
||||
<li>limit</li>
|
||||
<li>linear</li>
|
||||
<li>lines</li>
|
||||
<li>load</li>
|
||||
<li>localtime</li>
|
||||
<li>localtimestamp</li>
|
||||
<li>lock</li>
|
||||
<li>long</li>
|
||||
<li>longblob</li>
|
||||
<li>longtext</li>
|
||||
<li>loop</li>
|
||||
<li>low_priority</li>
|
||||
<li>master_bind</li>
|
||||
<li>master_ssl_verify_server_cert</li>
|
||||
<li>match</li>
|
||||
<li>maxvalue</li>
|
||||
<li>mediumblob</li>
|
||||
<li>mediumint</li>
|
||||
<li>mediumtext</li>
|
||||
<li>middleint</li>
|
||||
<li>minute_microsecond</li>
|
||||
<li>minute_second</li>
|
||||
<li>mod</li>
|
||||
<li>modifies</li>
|
||||
<li>natural</li>
|
||||
<li>no_write_to_binlog</li>
|
||||
<li>not</li>
|
||||
<li>nth_value</li>
|
||||
<li>ntile</li>
|
||||
<li>null</li>
|
||||
<li>numeric</li>
|
||||
<li>of</li>
|
||||
<li>on</li>
|
||||
<li>optimize</li>
|
||||
<li>optimizer_costs</li>
|
||||
<li>option</li>
|
||||
<li>optionally</li>
|
||||
<li>or</li>
|
||||
<li>order</li>
|
||||
<li>out</li>
|
||||
<li>outer</li>
|
||||
<li>outfile</li>
|
||||
<li>over</li>
|
||||
<li>partition</li>
|
||||
<li>percent_rank</li>
|
||||
<li>persist</li>
|
||||
<li>persist_only</li>
|
||||
<li>precision</li>
|
||||
<li>primary</li>
|
||||
<li>procedure</li>
|
||||
<li>purge</li>
|
||||
<li>range</li>
|
||||
<li>rank</li>
|
||||
<li>read</li>
|
||||
<li>read_write</li>
|
||||
<li>reads</li>
|
||||
<li>real</li>
|
||||
<li>recursive</li>
|
||||
<li>references</li>
|
||||
<li>regexp</li>
|
||||
<li>release</li>
|
||||
<li>rename</li>
|
||||
<li>repeat</li>
|
||||
<li>replace</li>
|
||||
<li>require</li>
|
||||
<li>resignal</li>
|
||||
<li>restrict</li>
|
||||
<li>return</li>
|
||||
<li>revoke</li>
|
||||
<li>right</li>
|
||||
<li>rlike</li>
|
||||
<li>role</li>
|
||||
<li>row</li>
|
||||
<li>row_number</li>
|
||||
<li>rows</li>
|
||||
<li>schema</li>
|
||||
<li>schemas</li>
|
||||
<li>second_microsecond</li>
|
||||
<li>select</li>
|
||||
<li>sensitive</li>
|
||||
<li>separator</li>
|
||||
<li>set</li>
|
||||
<li>show</li>
|
||||
<li>signal</li>
|
||||
<li>smallint</li>
|
||||
<li>spatial</li>
|
||||
<li>specific</li>
|
||||
<li>sql</li>
|
||||
<li>sql_big_result</li>
|
||||
<li>sql_calc_found_rows</li>
|
||||
<li>sql_small_result</li>
|
||||
<li>sqlexception</li>
|
||||
<li>sqlstate</li>
|
||||
<li>sqlwarning</li>
|
||||
<li>ssl</li>
|
||||
<li>starting</li>
|
||||
<li>stored</li>
|
||||
<li>straight_join</li>
|
||||
<li>system</li>
|
||||
<li>table</li>
|
||||
<li>terminated</li>
|
||||
<li>then</li>
|
||||
<li>tinyblob</li>
|
||||
<li>tinyint</li>
|
||||
<li>tinytext</li>
|
||||
<li>to</li>
|
||||
<li>trailing</li>
|
||||
<li>trigger</li>
|
||||
<li>true</li>
|
||||
<li>undo</li>
|
||||
<li>union</li>
|
||||
<li>unique</li>
|
||||
<li>unlock</li>
|
||||
<li>unsigned</li>
|
||||
<li>update</li>
|
||||
<li>usage</li>
|
||||
<li>use</li>
|
||||
<li>using</li>
|
||||
<li>utc_date</li>
|
||||
<li>utc_time</li>
|
||||
<li>utc_timestamp</li>
|
||||
<li>values</li>
|
||||
<li>varbinary</li>
|
||||
<li>varchar</li>
|
||||
<li>varcharacter</li>
|
||||
<li>varying</li>
|
||||
<li>virtual</li>
|
||||
<li>when</li>
|
||||
<li>where</li>
|
||||
<li>while</li>
|
||||
<li>window</li>
|
||||
<li>with</li>
|
||||
<li>write</li>
|
||||
<li>xor</li>
|
||||
<li>year_month</li>
|
||||
<li>zerofill</li>
|
||||
</ul>
|
||||
|
||||
@ -5,32 +5,32 @@ sidebar_label: nim
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|Set|java.util.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|HashMap|java.util.HashMap|
|
||||
|Array|java.util.List|
|
||||
|ArrayList|java.util.ArrayList|
|
||||
|URI|java.net.URI|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|BigDecimal|java.math.BigDecimal|
|
||||
|Date|java.util.Date|
|
||||
|DateTime|org.joda.time.*|
|
||||
|Array|java.util.List|
|
||||
|List|java.util.*|
|
||||
|UUID|java.util.UUID|
|
||||
|File|java.io.File|
|
||||
|HashMap|java.util.HashMap|
|
||||
|List|java.util.*|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|Map|java.util.Map|
|
||||
|Set|java.util.*|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|URI|java.net.URI|
|
||||
|UUID|java.util.UUID|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
@ -41,92 +41,92 @@ sidebar_label: nim
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>pointer</li>
|
||||
<li>bool</li>
|
||||
<li>string</li>
|
||||
<li>float32</li>
|
||||
<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>bool</li>
|
||||
<li>char</li>
|
||||
<li>cstring</li>
|
||||
<li>float64</li>
|
||||
<li>uint</li>
|
||||
<li>float</li>
|
||||
<li>float32</li>
|
||||
<li>float64</li>
|
||||
<li>int</li>
|
||||
<li>int16</li>
|
||||
<li>int32</li>
|
||||
<li>int64</li>
|
||||
<li>int8</li>
|
||||
<li>char</li>
|
||||
<li>uint64</li>
|
||||
<li>uint32</li>
|
||||
<li>uint8</li>
|
||||
<li>pointer</li>
|
||||
<li>string</li>
|
||||
<li>uint</li>
|
||||
<li>uint16</li>
|
||||
<li>uint32</li>
|
||||
<li>uint64</li>
|
||||
<li>uint8</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>discard</li>
|
||||
<li>mod</li>
|
||||
<li>converter</li>
|
||||
<li>do</li>
|
||||
<li>type</li>
|
||||
<li>while</li>
|
||||
<li>when</li>
|
||||
<li>div</li>
|
||||
<li>nil</li>
|
||||
<li>cast</li>
|
||||
<li>iterator</li>
|
||||
<li>ref</li>
|
||||
<li>bind</li>
|
||||
<li>isnot</li>
|
||||
<li>continue</li>
|
||||
<li>else</li>
|
||||
<li>raise</li>
|
||||
<li>block</li>
|
||||
<li>from</li>
|
||||
<li>let</li>
|
||||
<li>export</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>using</li>
|
||||
<li>static</li>
|
||||
<li>method</li>
|
||||
<li>in</li>
|
||||
<li>var</li>
|
||||
<li>finally</li>
|
||||
<li>is</li>
|
||||
<li>elif</li>
|
||||
<li>enum</li>
|
||||
<li>mixin</li>
|
||||
<li>as</li>
|
||||
<li>shl</li>
|
||||
<li>except</li>
|
||||
<li>try</li>
|
||||
<li>shr</li>
|
||||
<li>object</li>
|
||||
<li>template</li>
|
||||
<li>defer</li>
|
||||
<li>const</li>
|
||||
<li>import</li>
|
||||
<li>concept</li>
|
||||
<li>for</li>
|
||||
<li>distinct</li>
|
||||
<li>interface</li>
|
||||
<li>out</li>
|
||||
<li>tuple</li>
|
||||
<li>not</li>
|
||||
<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>addr</li>
|
||||
<li>and</li>
|
||||
<li>of</li>
|
||||
<li>yield</li>
|
||||
<li>end</li>
|
||||
<li>xor</li>
|
||||
<li>addr</li>
|
||||
<li>include</li>
|
||||
<li>macro</li>
|
||||
<li>proc</li>
|
||||
<li>or</li>
|
||||
<li>break</li>
|
||||
<li>ptr</li>
|
||||
<li>func</li>
|
||||
<li>as</li>
|
||||
<li>asm</li>
|
||||
<li>bind</li>
|
||||
<li>block</li>
|
||||
<li>break</li>
|
||||
<li>case</li>
|
||||
<li>cast</li>
|
||||
<li>concept</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>converter</li>
|
||||
<li>defer</li>
|
||||
<li>discard</li>
|
||||
<li>distinct</li>
|
||||
<li>div</li>
|
||||
<li>do</li>
|
||||
<li>elif</li>
|
||||
<li>else</li>
|
||||
<li>end</li>
|
||||
<li>enum</li>
|
||||
<li>except</li>
|
||||
<li>export</li>
|
||||
<li>finally</li>
|
||||
<li>for</li>
|
||||
<li>from</li>
|
||||
<li>func</li>
|
||||
<li>if</li>
|
||||
<li>import</li>
|
||||
<li>in</li>
|
||||
<li>include</li>
|
||||
<li>interface</li>
|
||||
<li>is</li>
|
||||
<li>isnot</li>
|
||||
<li>iterator</li>
|
||||
<li>let</li>
|
||||
<li>macro</li>
|
||||
<li>method</li>
|
||||
<li>mixin</li>
|
||||
<li>mod</li>
|
||||
<li>nil</li>
|
||||
<li>not</li>
|
||||
<li>notin</li>
|
||||
<li>object</li>
|
||||
<li>of</li>
|
||||
<li>or</li>
|
||||
<li>out</li>
|
||||
<li>proc</li>
|
||||
<li>ptr</li>
|
||||
<li>raise</li>
|
||||
<li>ref</li>
|
||||
<li>return</li>
|
||||
<li>shl</li>
|
||||
<li>shr</li>
|
||||
<li>static</li>
|
||||
<li>template</li>
|
||||
<li>try</li>
|
||||
<li>tuple</li>
|
||||
<li>type</li>
|
||||
<li>using</li>
|
||||
<li>var</li>
|
||||
<li>when</li>
|
||||
<li>while</li>
|
||||
<li>xor</li>
|
||||
<li>yield</li>
|
||||
</ul>
|
||||
|
||||
@ -5,33 +5,33 @@ sidebar_label: nodejs-express-server
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|serverPort|TCP port to listen on.| |null|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|Set|java.util.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|HashMap|java.util.HashMap|
|
||||
|Array|java.util.List|
|
||||
|ArrayList|java.util.ArrayList|
|
||||
|URI|java.net.URI|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|BigDecimal|java.math.BigDecimal|
|
||||
|Date|java.util.Date|
|
||||
|DateTime|org.joda.time.*|
|
||||
|Array|java.util.List|
|
||||
|List|java.util.*|
|
||||
|UUID|java.util.UUID|
|
||||
|File|java.io.File|
|
||||
|HashMap|java.util.HashMap|
|
||||
|List|java.util.*|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|Map|java.util.Map|
|
||||
|Set|java.util.*|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|URI|java.net.URI|
|
||||
|UUID|java.util.UUID|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
@ -46,38 +46,38 @@ sidebar_label: nodejs-express-server
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>const</li>
|
||||
<li>import</li>
|
||||
<li>debugger</li>
|
||||
<li>for</li>
|
||||
<li>do</li>
|
||||
<li>while</li>
|
||||
<li>delete</li>
|
||||
<li>switch</li>
|
||||
<li>default</li>
|
||||
<li>continue</li>
|
||||
<li>else</li>
|
||||
<li>function</li>
|
||||
<li>yield</li>
|
||||
<li>let</li>
|
||||
<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>break</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>class</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>debugger</li>
|
||||
<li>default</li>
|
||||
<li>delete</li>
|
||||
<li>do</li>
|
||||
<li>else</li>
|
||||
<li>export</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>typeof</li>
|
||||
<li>new</li>
|
||||
<li>void</li>
|
||||
<li>break</li>
|
||||
<li>in</li>
|
||||
<li>var</li>
|
||||
<li>finally</li>
|
||||
<li>this</li>
|
||||
<li>instanceof</li>
|
||||
<li>super</li>
|
||||
<li>with</li>
|
||||
<li>extends</li>
|
||||
<li>finally</li>
|
||||
<li>for</li>
|
||||
<li>function</li>
|
||||
<li>if</li>
|
||||
<li>import</li>
|
||||
<li>in</li>
|
||||
<li>instanceof</li>
|
||||
<li>let</li>
|
||||
<li>new</li>
|
||||
<li>return</li>
|
||||
<li>super</li>
|
||||
<li>switch</li>
|
||||
<li>this</li>
|
||||
<li>throw</li>
|
||||
<li>try</li>
|
||||
<li>return</li>
|
||||
<li>typeof</li>
|
||||
<li>var</li>
|
||||
<li>void</li>
|
||||
<li>while</li>
|
||||
<li>with</li>
|
||||
<li>yield</li>
|
||||
</ul>
|
||||
|
||||
@ -5,35 +5,35 @@ sidebar_label: nodejs-server-deprecated
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|googleCloudFunctions|When specified, it will generate the code which runs within Google Cloud Functions instead of standalone Node.JS server. See https://cloud.google.com/functions/docs/quickstart for the details of how to deploy the generated code.| |false|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|exportedName|When the generated code will be deployed to Google Cloud Functions, this option can be used to update the name of the exported function. By default, it refers to the basePath. This does not affect normal standalone nodejs server code.| |null|
|
||||
|googleCloudFunctions|When specified, it will generate the code which runs within Google Cloud Functions instead of standalone Node.JS server. See https://cloud.google.com/functions/docs/quickstart for the details of how to deploy the generated code.| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|serverPort|TCP port to listen on.| |null|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|Set|java.util.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|HashMap|java.util.HashMap|
|
||||
|Array|java.util.List|
|
||||
|ArrayList|java.util.ArrayList|
|
||||
|URI|java.net.URI|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|BigDecimal|java.math.BigDecimal|
|
||||
|Date|java.util.Date|
|
||||
|DateTime|org.joda.time.*|
|
||||
|Array|java.util.List|
|
||||
|List|java.util.*|
|
||||
|UUID|java.util.UUID|
|
||||
|File|java.io.File|
|
||||
|HashMap|java.util.HashMap|
|
||||
|List|java.util.*|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|Map|java.util.Map|
|
||||
|Set|java.util.*|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|URI|java.net.URI|
|
||||
|UUID|java.util.UUID|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
@ -48,38 +48,38 @@ sidebar_label: nodejs-server-deprecated
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>const</li>
|
||||
<li>import</li>
|
||||
<li>debugger</li>
|
||||
<li>for</li>
|
||||
<li>do</li>
|
||||
<li>while</li>
|
||||
<li>delete</li>
|
||||
<li>switch</li>
|
||||
<li>default</li>
|
||||
<li>continue</li>
|
||||
<li>else</li>
|
||||
<li>function</li>
|
||||
<li>yield</li>
|
||||
<li>let</li>
|
||||
<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>break</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>class</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>debugger</li>
|
||||
<li>default</li>
|
||||
<li>delete</li>
|
||||
<li>do</li>
|
||||
<li>else</li>
|
||||
<li>export</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>typeof</li>
|
||||
<li>new</li>
|
||||
<li>void</li>
|
||||
<li>break</li>
|
||||
<li>in</li>
|
||||
<li>var</li>
|
||||
<li>finally</li>
|
||||
<li>this</li>
|
||||
<li>instanceof</li>
|
||||
<li>super</li>
|
||||
<li>with</li>
|
||||
<li>extends</li>
|
||||
<li>finally</li>
|
||||
<li>for</li>
|
||||
<li>function</li>
|
||||
<li>if</li>
|
||||
<li>import</li>
|
||||
<li>in</li>
|
||||
<li>instanceof</li>
|
||||
<li>let</li>
|
||||
<li>new</li>
|
||||
<li>return</li>
|
||||
<li>super</li>
|
||||
<li>switch</li>
|
||||
<li>this</li>
|
||||
<li>throw</li>
|
||||
<li>try</li>
|
||||
<li>return</li>
|
||||
<li>typeof</li>
|
||||
<li>var</li>
|
||||
<li>void</li>
|
||||
<li>while</li>
|
||||
<li>with</li>
|
||||
<li>yield</li>
|
||||
</ul>
|
||||
|
||||
@ -1,16 +0,0 @@
|
||||
|
||||
---
|
||||
id: generator-opts-server-nodejs-server
|
||||
title: Config Options for nodejs-server
|
||||
sidebar_label: nodejs-server
|
||||
---
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|googleCloudFunctions|When specified, it will generate the code which runs within Google Cloud Functions instead of standalone Node.JS server. See https://cloud.google.com/functions/docs/quickstart for the details of how to deploy the generated code.| |false|
|
||||
|exportedName|When the generated code will be deployed to Google Cloud Functions, this option can be used to update the name of the exported function. By default, it refers to the basePath. This does not affect normal standalone nodejs server code.| |null|
|
||||
|serverPort|TCP port to listen on.| |null|
|
||||
@ -5,14 +5,14 @@ sidebar_label: objc
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|coreData|Should generate core data models| |false|
|
||||
|classPrefix|prefix for generated classes (convention: Abbreviation of pod name e.g. `HN` for `HackerNews`).`| |OAI|
|
||||
|podName|cocoapods package name (convention: CameCase).| |OpenAPIClient|
|
||||
|podVersion|cocoapods package version.| |1.0.0|
|
||||
|authorName|Name to use in the podspec file.| |OpenAPI|
|
||||
|authorEmail|Email to use in the podspec file.| |team@openapitools.org|
|
||||
|authorName|Name to use in the podspec file.| |OpenAPI|
|
||||
|classPrefix|prefix for generated classes (convention: Abbreviation of pod name e.g. `HN` for `HackerNews`).`| |OAI|
|
||||
|coreData|Should generate core data models| |false|
|
||||
|gitRepoURL|URL for the git repo where this podspec should point to.| |https://github.com/openapitools/openapi-generator|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true|
|
||||
|podName|cocoapods package name (convention: CameCase).| |OpenAPIClient|
|
||||
|podVersion|cocoapods package version.| |1.0.0|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
@ -30,77 +30,77 @@ sidebar_label: objc
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>NSNumber</li>
|
||||
<li>NSObject</li>
|
||||
<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>BOOL</li>
|
||||
<li>NSData</li>
|
||||
<li>bool</li>
|
||||
<li>BOOL</li>
|
||||
<li>NSURL</li>
|
||||
<li>NSString</li>
|
||||
<li>NSDate</li>
|
||||
<li>NSNumber</li>
|
||||
<li>NSObject</li>
|
||||
<li>NSString</li>
|
||||
<li>NSURL</li>
|
||||
<li>bool</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>struct</li>
|
||||
<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>_packed</li>
|
||||
<li>authsettings</li>
|
||||
<li>auto</li>
|
||||
<li>_packed</li>
|
||||
<li>queryparams</li>
|
||||
<li>extern</li>
|
||||
<li>do</li>
|
||||
<li>float</li>
|
||||
<li>while</li>
|
||||
<li>resourcepath</li>
|
||||
<li>protocol</li>
|
||||
<li>readonly</li>
|
||||
<li>else</li>
|
||||
<li>bodyparam</li>
|
||||
<li>break</li>
|
||||
<li>case</li>
|
||||
<li>cgfloat</li>
|
||||
<li>char</li>
|
||||
<li>class</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>unsafe_unretained</li>
|
||||
<li>property</li>
|
||||
<li>requestcontenttype</li>
|
||||
<li>default</li>
|
||||
<li>description</li>
|
||||
<li>do</li>
|
||||
<li>double</li>
|
||||
<li>else</li>
|
||||
<li>enum</li>
|
||||
<li>extern</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>formparams</li>
|
||||
<li>goto</li>
|
||||
<li>headerparams</li>
|
||||
<li>id</li>
|
||||
<li>if</li>
|
||||
<li>nsinteger</li>
|
||||
<li>responsecontenttype</li>
|
||||
<li>case</li>
|
||||
<li>pathparams</li>
|
||||
<li>void</li>
|
||||
<li>static</li>
|
||||
<li>sizeof</li>
|
||||
<li>double</li>
|
||||
<li>authsettings</li>
|
||||
<li>signed</li>
|
||||
<li>nonatomic</li>
|
||||
<li>formparams</li>
|
||||
<li>typedef</li>
|
||||
<li>enum</li>
|
||||
<li>headerparams</li>
|
||||
<li>bodyparam</li>
|
||||
<li>strong</li>
|
||||
<li>const</li>
|
||||
<li>for</li>
|
||||
<li>nsnumber</li>
|
||||
<li>retain</li>
|
||||
<li>description</li>
|
||||
<li>interface</li>
|
||||
<li>long</li>
|
||||
<li>switch</li>
|
||||
<li>weak</li>
|
||||
<li>default</li>
|
||||
<li>goto</li>
|
||||
<li>localvarfiles</li>
|
||||
<li>class</li>
|
||||
<li>cgfloat</li>
|
||||
<li>break</li>
|
||||
<li>implementation</li>
|
||||
<li>volatile</li>
|
||||
<li>nsobject</li>
|
||||
<li>union</li>
|
||||
<li>int</li>
|
||||
<li>char</li>
|
||||
<li>short</li>
|
||||
<li>unsigned</li>
|
||||
<li>interface</li>
|
||||
<li>localvarfiles</li>
|
||||
<li>long</li>
|
||||
<li>nonatomic</li>
|
||||
<li>nsinteger</li>
|
||||
<li>nsnumber</li>
|
||||
<li>nsobject</li>
|
||||
<li>pathparams</li>
|
||||
<li>property</li>
|
||||
<li>protocol</li>
|
||||
<li>queryparams</li>
|
||||
<li>readonly</li>
|
||||
<li>readwrite</li>
|
||||
<li>return</li>
|
||||
<li>register</li>
|
||||
<li>requestcontenttype</li>
|
||||
<li>resourcepath</li>
|
||||
<li>responsecontenttype</li>
|
||||
<li>retain</li>
|
||||
<li>return</li>
|
||||
<li>short</li>
|
||||
<li>signed</li>
|
||||
<li>sizeof</li>
|
||||
<li>static</li>
|
||||
<li>strong</li>
|
||||
<li>struct</li>
|
||||
<li>switch</li>
|
||||
<li>typedef</li>
|
||||
<li>union</li>
|
||||
<li>unsafe_unretained</li>
|
||||
<li>unsigned</li>
|
||||
<li>void</li>
|
||||
<li>volatile</li>
|
||||
<li>weak</li>
|
||||
<li>while</li>
|
||||
</ul>
|
||||
|
||||
@ -1,13 +0,0 @@
|
||||
|
||||
---
|
||||
id: generator-opts-client-ocaml-client
|
||||
title: Config Options for ocaml-client
|
||||
sidebar_label: ocaml-client
|
||||
---
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
@ -5,31 +5,31 @@ sidebar_label: ocaml
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|Set|java.util.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|HashMap|java.util.HashMap|
|
||||
|Array|java.util.List|
|
||||
|ArrayList|java.util.ArrayList|
|
||||
|URI|java.net.URI|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|BigDecimal|java.math.BigDecimal|
|
||||
|Date|java.util.Date|
|
||||
|DateTime|org.joda.time.*|
|
||||
|Array|java.util.List|
|
||||
|HashMap|java.util.HashMap|
|
||||
|List|java.util.*|
|
||||
|UUID|java.util.UUID|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|Map|java.util.Map|
|
||||
|Set|java.util.*|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|URI|java.net.URI|
|
||||
|UUID|java.util.UUID|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
@ -40,75 +40,75 @@ sidebar_label: ocaml
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>bool</li>
|
||||
<li>string</li>
|
||||
<li>int32</li>
|
||||
<li>int64</li>
|
||||
<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>Yojson.Safe.t</li>
|
||||
<li>bool</li>
|
||||
<li>bytes</li>
|
||||
<li>char</li>
|
||||
<li>Yojson.Safe.t</li>
|
||||
<li>float</li>
|
||||
<li>list</li>
|
||||
<li>int</li>
|
||||
<li>int32</li>
|
||||
<li>int64</li>
|
||||
<li>list</li>
|
||||
<li>string</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>exception</li>
|
||||
<li>struct</li>
|
||||
<li>asr</li>
|
||||
<li>mod</li>
|
||||
<li>do</li>
|
||||
<li>functor</li>
|
||||
<li>type</li>
|
||||
<li>while</li>
|
||||
<li>when</li>
|
||||
<li>rec</li>
|
||||
<li>else</li>
|
||||
<li>function</li>
|
||||
<li>mutable</li>
|
||||
<li>let</li>
|
||||
<li>if</li>
|
||||
<li>val</li>
|
||||
<li>new</li>
|
||||
<li>method</li>
|
||||
<li>in</li>
|
||||
<li>module</li>
|
||||
<li>nonrec</li>
|
||||
<li>then</li>
|
||||
<li>done</li>
|
||||
<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>and</li>
|
||||
<li>as</li>
|
||||
<li>asr</li>
|
||||
<li>assert</li>
|
||||
<li>begin</li>
|
||||
<li>class</li>
|
||||
<li>constraint</li>
|
||||
<li>do</li>
|
||||
<li>done</li>
|
||||
<li>downto</li>
|
||||
<li>else</li>
|
||||
<li>end</li>
|
||||
<li>exception</li>
|
||||
<li>external</li>
|
||||
<li>false</li>
|
||||
<li>for </li>
|
||||
<li>fun</li>
|
||||
<li>function</li>
|
||||
<li>functor</li>
|
||||
<li>if</li>
|
||||
<li>in</li>
|
||||
<li>include</li>
|
||||
<li>inherit</li>
|
||||
<li>initializer</li>
|
||||
<li>land</li>
|
||||
<li>lazy</li>
|
||||
<li>let</li>
|
||||
<li>lor</li>
|
||||
<li>lsl</li>
|
||||
<li>lsr</li>
|
||||
<li>lxor</li>
|
||||
<li>match</li>
|
||||
<li>method</li>
|
||||
<li>mod</li>
|
||||
<li>module</li>
|
||||
<li>mutable</li>
|
||||
<li>new</li>
|
||||
<li>nonrec</li>
|
||||
<li>object</li>
|
||||
<li>of</li>
|
||||
<li>open</li>
|
||||
<li>or</li>
|
||||
<li>private</li>
|
||||
<li>rec</li>
|
||||
<li>result</li>
|
||||
<li>sig</li>
|
||||
<li>struct</li>
|
||||
<li>then</li>
|
||||
<li>to</li>
|
||||
<li>true</li>
|
||||
<li>try</li>
|
||||
<li>begin</li>
|
||||
<li>object</li>
|
||||
<li>private</li>
|
||||
<li>type</li>
|
||||
<li>val</li>
|
||||
<li>virtual</li>
|
||||
<li>lsl</li>
|
||||
<li>lazy</li>
|
||||
<li>for </li>
|
||||
<li>lsr</li>
|
||||
<li>lor</li>
|
||||
<li>sig</li>
|
||||
<li>result</li>
|
||||
<li>and</li>
|
||||
<li>assert</li>
|
||||
<li>of</li>
|
||||
<li>land</li>
|
||||
<li>end</li>
|
||||
<li>class</li>
|
||||
<li>lxor</li>
|
||||
<li>include</li>
|
||||
<li>or</li>
|
||||
<li>downto</li>
|
||||
<li>false</li>
|
||||
<li>match</li>
|
||||
<li>initializer</li>
|
||||
<li>when</li>
|
||||
<li>while</li>
|
||||
<li>with</li>
|
||||
<li>inherit</li>
|
||||
<li>constraint</li>
|
||||
<li>to</li>
|
||||
<li>fun</li>
|
||||
<li>open</li>
|
||||
</ul>
|
||||
|
||||
@ -5,33 +5,33 @@ sidebar_label: openapi-yaml
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|outputFile|Output filename| |openapi/openapi.yaml|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|Set|java.util.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|HashMap|java.util.HashMap|
|
||||
|Array|java.util.List|
|
||||
|ArrayList|java.util.ArrayList|
|
||||
|URI|java.net.URI|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|BigDecimal|java.math.BigDecimal|
|
||||
|Date|java.util.Date|
|
||||
|DateTime|org.joda.time.*|
|
||||
|Array|java.util.List|
|
||||
|List|java.util.*|
|
||||
|UUID|java.util.UUID|
|
||||
|File|java.io.File|
|
||||
|HashMap|java.util.HashMap|
|
||||
|List|java.util.*|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|Map|java.util.Map|
|
||||
|Set|java.util.*|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|URI|java.net.URI|
|
||||
|UUID|java.util.UUID|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
|
||||
@ -5,32 +5,32 @@ sidebar_label: openapi
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|Set|java.util.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|HashMap|java.util.HashMap|
|
||||
|Array|java.util.List|
|
||||
|ArrayList|java.util.ArrayList|
|
||||
|URI|java.net.URI|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|BigDecimal|java.math.BigDecimal|
|
||||
|Date|java.util.Date|
|
||||
|DateTime|org.joda.time.*|
|
||||
|Array|java.util.List|
|
||||
|List|java.util.*|
|
||||
|UUID|java.util.UUID|
|
||||
|File|java.io.File|
|
||||
|HashMap|java.util.HashMap|
|
||||
|List|java.util.*|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|Map|java.util.Map|
|
||||
|Set|java.util.*|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|URI|java.net.URI|
|
||||
|UUID|java.util.UUID|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
|
||||
@ -5,12 +5,12 @@ sidebar_label: perl
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|moduleName|Perl module name (convention: CamelCase or Long::Module).| |OpenAPIClient|
|
||||
|moduleVersion|Perl module version.| |1.0.0|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true|
|
||||
|moduleName|Perl module name (convention: CamelCase or Long::Module).| |OpenAPIClient|
|
||||
|moduleVersion|Perl module version.| |1.0.0|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
@ -26,56 +26,56 @@ sidebar_label: perl
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>boolean</li>
|
||||
<li>ARRAY</li>
|
||||
<li>string</li>
|
||||
<li>double</li>
|
||||
<li>int</li>
|
||||
<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>ARRAY</li>
|
||||
<li>DateTime</li>
|
||||
<li>HASH</li>
|
||||
<li>boolean</li>
|
||||
<li>double</li>
|
||||
<li>int</li>
|
||||
<li>object</li>
|
||||
<li>string</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>sub</li>
|
||||
<li>no</li>
|
||||
<li>cmp</li>
|
||||
<li>lt</li>
|
||||
<li>for</li>
|
||||
<li>elsif</li>
|
||||
<li>do</li>
|
||||
<li>while</li>
|
||||
<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>__end__</li>
|
||||
<li>__file__</li>
|
||||
<li>__line__</li>
|
||||
<li>__package__</li>
|
||||
<li>foreach</li>
|
||||
<li>__end__</li>
|
||||
<li>unless</li>
|
||||
<li>else</li>
|
||||
<li>and</li>
|
||||
<li>cmp</li>
|
||||
<li>continue</li>
|
||||
<li>lock</li>
|
||||
<li>xor</li>
|
||||
<li>core</li>
|
||||
<li>do</li>
|
||||
<li>else</li>
|
||||
<li>elsif</li>
|
||||
<li>eq</li>
|
||||
<li>exp</li>
|
||||
<li>if</li>
|
||||
<li>for</li>
|
||||
<li>foreach</li>
|
||||
<li>ge</li>
|
||||
<li>qq</li>
|
||||
<li>qr</li>
|
||||
<li>gt</li>
|
||||
<li>if</li>
|
||||
<li>le</li>
|
||||
<li>lock</li>
|
||||
<li>lt</li>
|
||||
<li>m</li>
|
||||
<li>ne</li>
|
||||
<li>no</li>
|
||||
<li>or</li>
|
||||
<li>package</li>
|
||||
<li>q</li>
|
||||
<li>qq</li>
|
||||
<li>qr</li>
|
||||
<li>qw</li>
|
||||
<li>qx</li>
|
||||
<li>eq</li>
|
||||
<li>m</li>
|
||||
<li>gt</li>
|
||||
<li>q</li>
|
||||
<li>core</li>
|
||||
<li>__line__</li>
|
||||
<li>s</li>
|
||||
<li>__file__</li>
|
||||
<li>ne</li>
|
||||
<li>le</li>
|
||||
<li>y</li>
|
||||
<li>until</li>
|
||||
<li>tr</li>
|
||||
<li>return</li>
|
||||
<li>s</li>
|
||||
<li>sub</li>
|
||||
<li>tr</li>
|
||||
<li>unless</li>
|
||||
<li>until</li>
|
||||
<li>while</li>
|
||||
<li>xor</li>
|
||||
<li>y</li>
|
||||
</ul>
|
||||
|
||||
@ -5,39 +5,39 @@ sidebar_label: php-laravel
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|modelPackage|package for generated models| |null|
|
||||
|apiPackage|package for generated api classes| |null|
|
||||
|variableNamingConvention|naming convention of variable name, e.g. camelCase.| |snake_case|
|
||||
|invokerPackage|The main namespace to use for all classes. e.g. Yay\Pets| |null|
|
||||
|packageName|The main package name for classes. e.g. GeneratedPetstore| |null|
|
||||
|srcBasePath|The directory to serve as source root.| |null|
|
||||
|artifactVersion|The version to use in the composer package version field. e.g. 1.2.3| |null|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|invokerPackage|The main namespace to use for all classes. e.g. Yay\Pets| |null|
|
||||
|modelPackage|package for generated models| |null|
|
||||
|packageName|The main package name for classes. e.g. GeneratedPetstore| |null|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|srcBasePath|The directory to serve as source root.| |null|
|
||||
|variableNamingConvention|naming convention of variable name, e.g. camelCase.| |snake_case|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|Set|java.util.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|HashMap|java.util.HashMap|
|
||||
|Array|java.util.List|
|
||||
|ArrayList|java.util.ArrayList|
|
||||
|URI|java.net.URI|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|BigDecimal|java.math.BigDecimal|
|
||||
|Date|java.util.Date|
|
||||
|DateTime|org.joda.time.*|
|
||||
|Array|java.util.List|
|
||||
|List|java.util.*|
|
||||
|UUID|java.util.UUID|
|
||||
|File|java.io.File|
|
||||
|HashMap|java.util.HashMap|
|
||||
|List|java.util.*|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|Map|java.util.Map|
|
||||
|Set|java.util.*|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|URI|java.net.URI|
|
||||
|UUID|java.util.UUID|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
@ -50,93 +50,93 @@ sidebar_label: php-laravel
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>void</li>
|
||||
<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>DateTime</li>
|
||||
<li>bool</li>
|
||||
<li>string</li>
|
||||
<li>double</li>
|
||||
<li>boolean</li>
|
||||
<li>byte</li>
|
||||
<li>mixed</li>
|
||||
<li>integer</li>
|
||||
<li>double</li>
|
||||
<li>float</li>
|
||||
<li>int</li>
|
||||
<li>DateTime</li>
|
||||
<li>integer</li>
|
||||
<li>mixed</li>
|
||||
<li>number</li>
|
||||
<li>boolean</li>
|
||||
<li>object</li>
|
||||
<li>string</li>
|
||||
<li>void</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>die</li>
|
||||
<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>__halt_compiler</li>
|
||||
<li>_header_accept</li>
|
||||
<li>_tempbody</li>
|
||||
<li>abstract</li>
|
||||
<li>and</li>
|
||||
<li>array</li>
|
||||
<li>as</li>
|
||||
<li>break</li>
|
||||
<li>callable</li>
|
||||
<li>declare</li>
|
||||
<li>isset</li>
|
||||
<li>use</li>
|
||||
<li>queryparams</li>
|
||||
<li>echo</li>
|
||||
<li>do</li>
|
||||
<li>while</li>
|
||||
<li>unset</li>
|
||||
<li>empty</li>
|
||||
<li>resourcepath</li>
|
||||
<li>endwhile</li>
|
||||
<li>protected</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>class</li>
|
||||
<li>clone</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>declare</li>
|
||||
<li>default</li>
|
||||
<li>die</li>
|
||||
<li>do</li>
|
||||
<li>echo</li>
|
||||
<li>else</li>
|
||||
<li>elseif</li>
|
||||
<li>function</li>
|
||||
<li>empty</li>
|
||||
<li>enddeclare</li>
|
||||
<li>endfor</li>
|
||||
<li>trait</li>
|
||||
<li>catch</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>new</li>
|
||||
<li>static</li>
|
||||
<li>var</li>
|
||||
<li>require</li>
|
||||
<li>require_once</li>
|
||||
<li>list</li>
|
||||
<li>formparams</li>
|
||||
<li>headerparams</li>
|
||||
<li>_header_accept</li>
|
||||
<li>include_once</li>
|
||||
<li>exit</li>
|
||||
<li>as</li>
|
||||
<li>endforeach</li>
|
||||
<li>endif</li>
|
||||
<li>endswitch</li>
|
||||
<li>endwhile</li>
|
||||
<li>eval</li>
|
||||
<li>exit</li>
|
||||
<li>extends</li>
|
||||
<li>final</li>
|
||||
<li>try</li>
|
||||
<li>httpbody</li>
|
||||
<li>implements</li>
|
||||
<li>private</li>
|
||||
<li>const</li>
|
||||
<li>for</li>
|
||||
<li>global</li>
|
||||
<li>interface</li>
|
||||
<li>__halt_compiler</li>
|
||||
<li>_tempbody</li>
|
||||
<li>switch</li>
|
||||
<li>foreach</li>
|
||||
<li>default</li>
|
||||
<li>formparams</li>
|
||||
<li>function</li>
|
||||
<li>global</li>
|
||||
<li>goto</li>
|
||||
<li>public</li>
|
||||
<li>array</li>
|
||||
<li>and</li>
|
||||
<li>xor</li>
|
||||
<li>class</li>
|
||||
<li>headerparams</li>
|
||||
<li>httpbody</li>
|
||||
<li>if</li>
|
||||
<li>implements</li>
|
||||
<li>include</li>
|
||||
<li>or</li>
|
||||
<li>endswitch</li>
|
||||
<li>break</li>
|
||||
<li>enddeclare</li>
|
||||
<li>abstract</li>
|
||||
<li>include_once</li>
|
||||
<li>instanceof</li>
|
||||
<li>print</li>
|
||||
<li>throw</li>
|
||||
<li>insteadof</li>
|
||||
<li>clone</li>
|
||||
<li>interface</li>
|
||||
<li>isset</li>
|
||||
<li>list</li>
|
||||
<li>namespace</li>
|
||||
<li>endif</li>
|
||||
<li>endforeach</li>
|
||||
<li>new</li>
|
||||
<li>or</li>
|
||||
<li>print</li>
|
||||
<li>private</li>
|
||||
<li>protected</li>
|
||||
<li>public</li>
|
||||
<li>queryparams</li>
|
||||
<li>require</li>
|
||||
<li>require_once</li>
|
||||
<li>resourcepath</li>
|
||||
<li>return</li>
|
||||
<li>static</li>
|
||||
<li>switch</li>
|
||||
<li>throw</li>
|
||||
<li>trait</li>
|
||||
<li>try</li>
|
||||
<li>unset</li>
|
||||
<li>use</li>
|
||||
<li>var</li>
|
||||
<li>while</li>
|
||||
<li>xor</li>
|
||||
</ul>
|
||||
|
||||
@ -5,39 +5,39 @@ sidebar_label: php-lumen
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|modelPackage|package for generated models| |null|
|
||||
|apiPackage|package for generated api classes| |null|
|
||||
|variableNamingConvention|naming convention of variable name, e.g. camelCase.| |snake_case|
|
||||
|invokerPackage|The main namespace to use for all classes. e.g. Yay\Pets| |null|
|
||||
|packageName|The main package name for classes. e.g. GeneratedPetstore| |null|
|
||||
|srcBasePath|The directory to serve as source root.| |null|
|
||||
|artifactVersion|The version to use in the composer package version field. e.g. 1.2.3| |null|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|invokerPackage|The main namespace to use for all classes. e.g. Yay\Pets| |null|
|
||||
|modelPackage|package for generated models| |null|
|
||||
|packageName|The main package name for classes. e.g. GeneratedPetstore| |null|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|srcBasePath|The directory to serve as source root.| |null|
|
||||
|variableNamingConvention|naming convention of variable name, e.g. camelCase.| |snake_case|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|Set|java.util.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|HashMap|java.util.HashMap|
|
||||
|Array|java.util.List|
|
||||
|ArrayList|java.util.ArrayList|
|
||||
|URI|java.net.URI|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|BigDecimal|java.math.BigDecimal|
|
||||
|Date|java.util.Date|
|
||||
|DateTime|org.joda.time.*|
|
||||
|Array|java.util.List|
|
||||
|List|java.util.*|
|
||||
|UUID|java.util.UUID|
|
||||
|File|java.io.File|
|
||||
|HashMap|java.util.HashMap|
|
||||
|List|java.util.*|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|Map|java.util.Map|
|
||||
|Set|java.util.*|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|URI|java.net.URI|
|
||||
|UUID|java.util.UUID|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
@ -50,93 +50,93 @@ sidebar_label: php-lumen
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>void</li>
|
||||
<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>DateTime</li>
|
||||
<li>bool</li>
|
||||
<li>string</li>
|
||||
<li>double</li>
|
||||
<li>boolean</li>
|
||||
<li>byte</li>
|
||||
<li>mixed</li>
|
||||
<li>integer</li>
|
||||
<li>double</li>
|
||||
<li>float</li>
|
||||
<li>int</li>
|
||||
<li>DateTime</li>
|
||||
<li>integer</li>
|
||||
<li>mixed</li>
|
||||
<li>number</li>
|
||||
<li>boolean</li>
|
||||
<li>object</li>
|
||||
<li>string</li>
|
||||
<li>void</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>die</li>
|
||||
<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>__halt_compiler</li>
|
||||
<li>_header_accept</li>
|
||||
<li>_tempbody</li>
|
||||
<li>abstract</li>
|
||||
<li>and</li>
|
||||
<li>array</li>
|
||||
<li>as</li>
|
||||
<li>break</li>
|
||||
<li>callable</li>
|
||||
<li>declare</li>
|
||||
<li>isset</li>
|
||||
<li>use</li>
|
||||
<li>queryparams</li>
|
||||
<li>echo</li>
|
||||
<li>do</li>
|
||||
<li>while</li>
|
||||
<li>unset</li>
|
||||
<li>empty</li>
|
||||
<li>resourcepath</li>
|
||||
<li>endwhile</li>
|
||||
<li>protected</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>class</li>
|
||||
<li>clone</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>declare</li>
|
||||
<li>default</li>
|
||||
<li>die</li>
|
||||
<li>do</li>
|
||||
<li>echo</li>
|
||||
<li>else</li>
|
||||
<li>elseif</li>
|
||||
<li>function</li>
|
||||
<li>empty</li>
|
||||
<li>enddeclare</li>
|
||||
<li>endfor</li>
|
||||
<li>trait</li>
|
||||
<li>catch</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>new</li>
|
||||
<li>static</li>
|
||||
<li>var</li>
|
||||
<li>require</li>
|
||||
<li>require_once</li>
|
||||
<li>list</li>
|
||||
<li>formparams</li>
|
||||
<li>headerparams</li>
|
||||
<li>_header_accept</li>
|
||||
<li>include_once</li>
|
||||
<li>exit</li>
|
||||
<li>as</li>
|
||||
<li>endforeach</li>
|
||||
<li>endif</li>
|
||||
<li>endswitch</li>
|
||||
<li>endwhile</li>
|
||||
<li>eval</li>
|
||||
<li>exit</li>
|
||||
<li>extends</li>
|
||||
<li>final</li>
|
||||
<li>try</li>
|
||||
<li>httpbody</li>
|
||||
<li>implements</li>
|
||||
<li>private</li>
|
||||
<li>const</li>
|
||||
<li>for</li>
|
||||
<li>global</li>
|
||||
<li>interface</li>
|
||||
<li>__halt_compiler</li>
|
||||
<li>_tempbody</li>
|
||||
<li>switch</li>
|
||||
<li>foreach</li>
|
||||
<li>default</li>
|
||||
<li>formparams</li>
|
||||
<li>function</li>
|
||||
<li>global</li>
|
||||
<li>goto</li>
|
||||
<li>public</li>
|
||||
<li>array</li>
|
||||
<li>and</li>
|
||||
<li>xor</li>
|
||||
<li>class</li>
|
||||
<li>headerparams</li>
|
||||
<li>httpbody</li>
|
||||
<li>if</li>
|
||||
<li>implements</li>
|
||||
<li>include</li>
|
||||
<li>or</li>
|
||||
<li>endswitch</li>
|
||||
<li>break</li>
|
||||
<li>enddeclare</li>
|
||||
<li>abstract</li>
|
||||
<li>include_once</li>
|
||||
<li>instanceof</li>
|
||||
<li>print</li>
|
||||
<li>throw</li>
|
||||
<li>insteadof</li>
|
||||
<li>clone</li>
|
||||
<li>interface</li>
|
||||
<li>isset</li>
|
||||
<li>list</li>
|
||||
<li>namespace</li>
|
||||
<li>endif</li>
|
||||
<li>endforeach</li>
|
||||
<li>new</li>
|
||||
<li>or</li>
|
||||
<li>print</li>
|
||||
<li>private</li>
|
||||
<li>protected</li>
|
||||
<li>public</li>
|
||||
<li>queryparams</li>
|
||||
<li>require</li>
|
||||
<li>require_once</li>
|
||||
<li>resourcepath</li>
|
||||
<li>return</li>
|
||||
<li>static</li>
|
||||
<li>switch</li>
|
||||
<li>throw</li>
|
||||
<li>trait</li>
|
||||
<li>try</li>
|
||||
<li>unset</li>
|
||||
<li>use</li>
|
||||
<li>var</li>
|
||||
<li>while</li>
|
||||
<li>xor</li>
|
||||
</ul>
|
||||
|
||||
@ -5,32 +5,32 @@ sidebar_label: php-silex
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|Set|java.util.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|HashMap|java.util.HashMap|
|
||||
|Array|java.util.List|
|
||||
|ArrayList|java.util.ArrayList|
|
||||
|URI|java.net.URI|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|BigDecimal|java.math.BigDecimal|
|
||||
|Date|java.util.Date|
|
||||
|DateTime|org.joda.time.*|
|
||||
|Array|java.util.List|
|
||||
|List|java.util.*|
|
||||
|UUID|java.util.UUID|
|
||||
|File|java.io.File|
|
||||
|HashMap|java.util.HashMap|
|
||||
|List|java.util.*|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|Map|java.util.Map|
|
||||
|Set|java.util.*|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|URI|java.net.URI|
|
||||
|UUID|java.util.UUID|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
@ -43,83 +43,83 @@ sidebar_label: php-silex
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>number</li>
|
||||
<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>DateTime</li>
|
||||
<li>boolean</li>
|
||||
<li>string</li>
|
||||
<li>double</li>
|
||||
<li>mixed</li>
|
||||
<li>integer</li>
|
||||
<li>float</li>
|
||||
<li>int</li>
|
||||
<li>DateTime</li>
|
||||
<li>integer</li>
|
||||
<li>mixed</li>
|
||||
<li>number</li>
|
||||
<li>object</li>
|
||||
<li>string</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>die</li>
|
||||
<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>__halt_compiler</li>
|
||||
<li>abstract</li>
|
||||
<li>and</li>
|
||||
<li>array</li>
|
||||
<li>as</li>
|
||||
<li>break</li>
|
||||
<li>callable</li>
|
||||
<li>declare</li>
|
||||
<li>isset</li>
|
||||
<li>use</li>
|
||||
<li>echo</li>
|
||||
<li>do</li>
|
||||
<li>while</li>
|
||||
<li>unset</li>
|
||||
<li>empty</li>
|
||||
<li>endwhile</li>
|
||||
<li>protected</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>class</li>
|
||||
<li>clone</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>declare</li>
|
||||
<li>default</li>
|
||||
<li>die</li>
|
||||
<li>do</li>
|
||||
<li>echo</li>
|
||||
<li>else</li>
|
||||
<li>elseif</li>
|
||||
<li>function</li>
|
||||
<li>empty</li>
|
||||
<li>enddeclare</li>
|
||||
<li>endfor</li>
|
||||
<li>trait</li>
|
||||
<li>catch</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>new</li>
|
||||
<li>static</li>
|
||||
<li>var</li>
|
||||
<li>require</li>
|
||||
<li>require_once</li>
|
||||
<li>list</li>
|
||||
<li>include_once</li>
|
||||
<li>exit</li>
|
||||
<li>as</li>
|
||||
<li>endforeach</li>
|
||||
<li>endif</li>
|
||||
<li>endswitch</li>
|
||||
<li>endwhile</li>
|
||||
<li>eval</li>
|
||||
<li>exit</li>
|
||||
<li>extends</li>
|
||||
<li>final</li>
|
||||
<li>try</li>
|
||||
<li>implements</li>
|
||||
<li>private</li>
|
||||
<li>const</li>
|
||||
<li>for</li>
|
||||
<li>global</li>
|
||||
<li>interface</li>
|
||||
<li>__halt_compiler</li>
|
||||
<li>switch</li>
|
||||
<li>foreach</li>
|
||||
<li>default</li>
|
||||
<li>function</li>
|
||||
<li>global</li>
|
||||
<li>goto</li>
|
||||
<li>public</li>
|
||||
<li>array</li>
|
||||
<li>and</li>
|
||||
<li>xor</li>
|
||||
<li>class</li>
|
||||
<li>if</li>
|
||||
<li>implements</li>
|
||||
<li>include</li>
|
||||
<li>or</li>
|
||||
<li>endswitch</li>
|
||||
<li>break</li>
|
||||
<li>enddeclare</li>
|
||||
<li>abstract</li>
|
||||
<li>include_once</li>
|
||||
<li>instanceof</li>
|
||||
<li>print</li>
|
||||
<li>throw</li>
|
||||
<li>insteadof</li>
|
||||
<li>clone</li>
|
||||
<li>interface</li>
|
||||
<li>isset</li>
|
||||
<li>list</li>
|
||||
<li>namespace</li>
|
||||
<li>endif</li>
|
||||
<li>endforeach</li>
|
||||
<li>new</li>
|
||||
<li>or</li>
|
||||
<li>print</li>
|
||||
<li>private</li>
|
||||
<li>protected</li>
|
||||
<li>public</li>
|
||||
<li>require</li>
|
||||
<li>require_once</li>
|
||||
<li>return</li>
|
||||
<li>static</li>
|
||||
<li>switch</li>
|
||||
<li>throw</li>
|
||||
<li>trait</li>
|
||||
<li>try</li>
|
||||
<li>unset</li>
|
||||
<li>use</li>
|
||||
<li>var</li>
|
||||
<li>while</li>
|
||||
<li>xor</li>
|
||||
</ul>
|
||||
|
||||
@ -5,18 +5,18 @@ sidebar_label: php-slim-deprecated
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|modelPackage|package for generated models| |null|
|
||||
|apiPackage|package for generated api classes| |null|
|
||||
|variableNamingConvention|naming convention of variable name, e.g. camelCase.| |camelCase|
|
||||
|invokerPackage|The main namespace to use for all classes. e.g. Yay\Pets| |null|
|
||||
|packageName|The main package name for classes. e.g. GeneratedPetstore| |null|
|
||||
|srcBasePath|The directory to serve as source root.| |null|
|
||||
|artifactVersion|The version to use in the composer package version field. e.g. 1.2.3| |null|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|invokerPackage|The main namespace to use for all classes. e.g. Yay\Pets| |null|
|
||||
|modelPackage|package for generated models| |null|
|
||||
|packageName|The main package name for classes. e.g. GeneratedPetstore| |null|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|srcBasePath|The directory to serve as source root.| |null|
|
||||
|variableNamingConvention|naming convention of variable name, e.g. camelCase.| |camelCase|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
@ -34,93 +34,93 @@ sidebar_label: php-slim-deprecated
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>void</li>
|
||||
<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>DateTime</li>
|
||||
<li>bool</li>
|
||||
<li>string</li>
|
||||
<li>double</li>
|
||||
<li>boolean</li>
|
||||
<li>byte</li>
|
||||
<li>mixed</li>
|
||||
<li>integer</li>
|
||||
<li>double</li>
|
||||
<li>float</li>
|
||||
<li>int</li>
|
||||
<li>DateTime</li>
|
||||
<li>integer</li>
|
||||
<li>mixed</li>
|
||||
<li>number</li>
|
||||
<li>boolean</li>
|
||||
<li>object</li>
|
||||
<li>string</li>
|
||||
<li>void</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>die</li>
|
||||
<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>__halt_compiler</li>
|
||||
<li>_header_accept</li>
|
||||
<li>_tempbody</li>
|
||||
<li>abstract</li>
|
||||
<li>and</li>
|
||||
<li>array</li>
|
||||
<li>as</li>
|
||||
<li>break</li>
|
||||
<li>callable</li>
|
||||
<li>declare</li>
|
||||
<li>isset</li>
|
||||
<li>use</li>
|
||||
<li>queryparams</li>
|
||||
<li>echo</li>
|
||||
<li>do</li>
|
||||
<li>while</li>
|
||||
<li>unset</li>
|
||||
<li>empty</li>
|
||||
<li>resourcepath</li>
|
||||
<li>endwhile</li>
|
||||
<li>protected</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>class</li>
|
||||
<li>clone</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>declare</li>
|
||||
<li>default</li>
|
||||
<li>die</li>
|
||||
<li>do</li>
|
||||
<li>echo</li>
|
||||
<li>else</li>
|
||||
<li>elseif</li>
|
||||
<li>function</li>
|
||||
<li>empty</li>
|
||||
<li>enddeclare</li>
|
||||
<li>endfor</li>
|
||||
<li>trait</li>
|
||||
<li>catch</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>new</li>
|
||||
<li>static</li>
|
||||
<li>var</li>
|
||||
<li>require</li>
|
||||
<li>require_once</li>
|
||||
<li>list</li>
|
||||
<li>formparams</li>
|
||||
<li>headerparams</li>
|
||||
<li>_header_accept</li>
|
||||
<li>include_once</li>
|
||||
<li>exit</li>
|
||||
<li>as</li>
|
||||
<li>endforeach</li>
|
||||
<li>endif</li>
|
||||
<li>endswitch</li>
|
||||
<li>endwhile</li>
|
||||
<li>eval</li>
|
||||
<li>exit</li>
|
||||
<li>extends</li>
|
||||
<li>final</li>
|
||||
<li>try</li>
|
||||
<li>httpbody</li>
|
||||
<li>implements</li>
|
||||
<li>private</li>
|
||||
<li>const</li>
|
||||
<li>for</li>
|
||||
<li>global</li>
|
||||
<li>interface</li>
|
||||
<li>__halt_compiler</li>
|
||||
<li>_tempbody</li>
|
||||
<li>switch</li>
|
||||
<li>foreach</li>
|
||||
<li>default</li>
|
||||
<li>formparams</li>
|
||||
<li>function</li>
|
||||
<li>global</li>
|
||||
<li>goto</li>
|
||||
<li>public</li>
|
||||
<li>array</li>
|
||||
<li>and</li>
|
||||
<li>xor</li>
|
||||
<li>class</li>
|
||||
<li>headerparams</li>
|
||||
<li>httpbody</li>
|
||||
<li>if</li>
|
||||
<li>implements</li>
|
||||
<li>include</li>
|
||||
<li>or</li>
|
||||
<li>endswitch</li>
|
||||
<li>break</li>
|
||||
<li>enddeclare</li>
|
||||
<li>abstract</li>
|
||||
<li>include_once</li>
|
||||
<li>instanceof</li>
|
||||
<li>print</li>
|
||||
<li>throw</li>
|
||||
<li>insteadof</li>
|
||||
<li>clone</li>
|
||||
<li>interface</li>
|
||||
<li>isset</li>
|
||||
<li>list</li>
|
||||
<li>namespace</li>
|
||||
<li>endif</li>
|
||||
<li>endforeach</li>
|
||||
<li>new</li>
|
||||
<li>or</li>
|
||||
<li>print</li>
|
||||
<li>private</li>
|
||||
<li>protected</li>
|
||||
<li>public</li>
|
||||
<li>queryparams</li>
|
||||
<li>require</li>
|
||||
<li>require_once</li>
|
||||
<li>resourcepath</li>
|
||||
<li>return</li>
|
||||
<li>static</li>
|
||||
<li>switch</li>
|
||||
<li>throw</li>
|
||||
<li>trait</li>
|
||||
<li>try</li>
|
||||
<li>unset</li>
|
||||
<li>use</li>
|
||||
<li>var</li>
|
||||
<li>while</li>
|
||||
<li>xor</li>
|
||||
</ul>
|
||||
|
||||
@ -1,18 +0,0 @@
|
||||
---
|
||||
title: Config Options for php-slim
|
||||
sidebar_label: php-slim
|
||||
---
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|modelPackage|package for generated models| |null|
|
||||
|apiPackage|package for generated api classes| |null|
|
||||
|variableNamingConvention|naming convention of variable name, e.g. camelCase.| |camelCase|
|
||||
|invokerPackage|The main namespace to use for all classes. e.g. Yay\Pets| |null|
|
||||
|packageName|The main package name for classes. e.g. GeneratedPetstore| |null|
|
||||
|srcBasePath|The directory to serve as source root.| |null|
|
||||
|artifactVersion|The version to use in the composer package version field. e.g. 1.2.3| |null|
|
||||
@ -5,19 +5,19 @@ sidebar_label: php-slim4
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|modelPackage|package for generated models| |null|
|
||||
|apiPackage|package for generated api classes| |null|
|
||||
|variableNamingConvention|naming convention of variable name, e.g. camelCase.| |camelCase|
|
||||
|invokerPackage|The main namespace to use for all classes. e.g. Yay\Pets| |null|
|
||||
|packageName|The main package name for classes. e.g. GeneratedPetstore| |null|
|
||||
|srcBasePath|The directory to serve as source root.| |null|
|
||||
|artifactVersion|The version to use in the composer package version field. e.g. 1.2.3| |null|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|invokerPackage|The main namespace to use for all classes. e.g. Yay\Pets| |null|
|
||||
|modelPackage|package for generated models| |null|
|
||||
|packageName|The main package name for classes. e.g. GeneratedPetstore| |null|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|psr7Implementation|Slim 4 provides its own PSR-7 implementation so that it works out of the box. However, you are free to replace Slim’s default PSR-7 objects with a third-party implementation. Ref: https://www.slimframework.com/docs/v4/concepts/value-objects.html|<dl><dt>**slim-psr7**</dt><dd>Slim PSR-7 Message implementation</dd><dt>**nyholm-psr7**</dt><dd>Nyholm PSR-7 Message implementation</dd><dt>**guzzle-psr7**</dt><dd>Guzzle PSR-7 Message implementation</dd><dt>**zend-diactoros**</dt><dd>Zend Diactoros PSR-7 Message implementation</dd><dl>|slim-psr7|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|srcBasePath|The directory to serve as source root.| |null|
|
||||
|variableNamingConvention|naming convention of variable name, e.g. camelCase.| |camelCase|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
@ -35,93 +35,93 @@ sidebar_label: php-slim4
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>void</li>
|
||||
<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>DateTime</li>
|
||||
<li>bool</li>
|
||||
<li>string</li>
|
||||
<li>double</li>
|
||||
<li>boolean</li>
|
||||
<li>byte</li>
|
||||
<li>mixed</li>
|
||||
<li>integer</li>
|
||||
<li>double</li>
|
||||
<li>float</li>
|
||||
<li>int</li>
|
||||
<li>DateTime</li>
|
||||
<li>integer</li>
|
||||
<li>mixed</li>
|
||||
<li>number</li>
|
||||
<li>boolean</li>
|
||||
<li>object</li>
|
||||
<li>string</li>
|
||||
<li>void</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>die</li>
|
||||
<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>__halt_compiler</li>
|
||||
<li>_header_accept</li>
|
||||
<li>_tempbody</li>
|
||||
<li>abstract</li>
|
||||
<li>and</li>
|
||||
<li>array</li>
|
||||
<li>as</li>
|
||||
<li>break</li>
|
||||
<li>callable</li>
|
||||
<li>declare</li>
|
||||
<li>isset</li>
|
||||
<li>use</li>
|
||||
<li>queryparams</li>
|
||||
<li>echo</li>
|
||||
<li>do</li>
|
||||
<li>while</li>
|
||||
<li>unset</li>
|
||||
<li>empty</li>
|
||||
<li>resourcepath</li>
|
||||
<li>endwhile</li>
|
||||
<li>protected</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>class</li>
|
||||
<li>clone</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>declare</li>
|
||||
<li>default</li>
|
||||
<li>die</li>
|
||||
<li>do</li>
|
||||
<li>echo</li>
|
||||
<li>else</li>
|
||||
<li>elseif</li>
|
||||
<li>function</li>
|
||||
<li>empty</li>
|
||||
<li>enddeclare</li>
|
||||
<li>endfor</li>
|
||||
<li>trait</li>
|
||||
<li>catch</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>new</li>
|
||||
<li>static</li>
|
||||
<li>var</li>
|
||||
<li>require</li>
|
||||
<li>require_once</li>
|
||||
<li>list</li>
|
||||
<li>formparams</li>
|
||||
<li>headerparams</li>
|
||||
<li>_header_accept</li>
|
||||
<li>include_once</li>
|
||||
<li>exit</li>
|
||||
<li>as</li>
|
||||
<li>endforeach</li>
|
||||
<li>endif</li>
|
||||
<li>endswitch</li>
|
||||
<li>endwhile</li>
|
||||
<li>eval</li>
|
||||
<li>exit</li>
|
||||
<li>extends</li>
|
||||
<li>final</li>
|
||||
<li>try</li>
|
||||
<li>httpbody</li>
|
||||
<li>implements</li>
|
||||
<li>private</li>
|
||||
<li>const</li>
|
||||
<li>for</li>
|
||||
<li>global</li>
|
||||
<li>interface</li>
|
||||
<li>__halt_compiler</li>
|
||||
<li>_tempbody</li>
|
||||
<li>switch</li>
|
||||
<li>foreach</li>
|
||||
<li>default</li>
|
||||
<li>formparams</li>
|
||||
<li>function</li>
|
||||
<li>global</li>
|
||||
<li>goto</li>
|
||||
<li>public</li>
|
||||
<li>array</li>
|
||||
<li>and</li>
|
||||
<li>xor</li>
|
||||
<li>class</li>
|
||||
<li>headerparams</li>
|
||||
<li>httpbody</li>
|
||||
<li>if</li>
|
||||
<li>implements</li>
|
||||
<li>include</li>
|
||||
<li>or</li>
|
||||
<li>endswitch</li>
|
||||
<li>break</li>
|
||||
<li>enddeclare</li>
|
||||
<li>abstract</li>
|
||||
<li>include_once</li>
|
||||
<li>instanceof</li>
|
||||
<li>print</li>
|
||||
<li>throw</li>
|
||||
<li>insteadof</li>
|
||||
<li>clone</li>
|
||||
<li>interface</li>
|
||||
<li>isset</li>
|
||||
<li>list</li>
|
||||
<li>namespace</li>
|
||||
<li>endif</li>
|
||||
<li>endforeach</li>
|
||||
<li>new</li>
|
||||
<li>or</li>
|
||||
<li>print</li>
|
||||
<li>private</li>
|
||||
<li>protected</li>
|
||||
<li>public</li>
|
||||
<li>queryparams</li>
|
||||
<li>require</li>
|
||||
<li>require_once</li>
|
||||
<li>resourcepath</li>
|
||||
<li>return</li>
|
||||
<li>static</li>
|
||||
<li>switch</li>
|
||||
<li>throw</li>
|
||||
<li>trait</li>
|
||||
<li>try</li>
|
||||
<li>unset</li>
|
||||
<li>use</li>
|
||||
<li>var</li>
|
||||
<li>while</li>
|
||||
<li>xor</li>
|
||||
</ul>
|
||||
|
||||
@ -5,24 +5,24 @@ sidebar_label: php-symfony
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|modelPackage|package for generated models| |null|
|
||||
|apiPackage|package for generated api classes| |null|
|
||||
|variableNamingConvention|naming convention of variable name, e.g. camelCase.| |snake_case|
|
||||
|invokerPackage|The main namespace to use for all classes. e.g. Yay\Pets| |null|
|
||||
|packageName|The main package name for classes. e.g. GeneratedPetstore| |null|
|
||||
|srcBasePath|The directory to serve as source root.| |null|
|
||||
|artifactVersion|The version to use in the composer package version field. e.g. 1.2.3| |null|
|
||||
|composerVendorName|The vendor name used in the composer package name. The template uses {{composerVendorName}}/{{composerProjectName}} for the composer package name. e.g. yaypets| |null|
|
||||
|bundleName|The name of the Symfony bundle. The template uses {{bundleName}}| |null|
|
||||
|bundleAlias|The alias of the Symfony bundle. The template uses {{aliasName}}| |null|
|
||||
|bundleName|The name of the Symfony bundle. The template uses {{bundleName}}| |null|
|
||||
|composerProjectName|The project name used in the composer package name. The template uses {{composerVendorName}}/{{composerProjectName}} for the composer package name. e.g. petstore-client| |null|
|
||||
|composerVendorName|The vendor name used in the composer package name. The template uses {{composerVendorName}}/{{composerProjectName}} for the composer package name. e.g. yaypets| |null|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true|
|
||||
|invokerPackage|The main namespace to use for all classes. e.g. Yay\Pets| |null|
|
||||
|modelPackage|package for generated models| |null|
|
||||
|packageName|The main package name for classes. e.g. GeneratedPetstore| |null|
|
||||
|phpLegacySupport|Should the generated code be compatible with PHP 5.x?| |true|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|srcBasePath|The directory to serve as source root.| |null|
|
||||
|variableNamingConvention|naming convention of variable name, e.g. camelCase.| |snake_case|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
@ -40,91 +40,91 @@ sidebar_label: php-symfony
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>number</li>
|
||||
<li>void</li>
|
||||
<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>array</li>
|
||||
<li>bool</li>
|
||||
<li>string</li>
|
||||
<li>array</li>
|
||||
<li>double</li>
|
||||
<li>byte</li>
|
||||
<li>mixed</li>
|
||||
<li>double</li>
|
||||
<li>float</li>
|
||||
<li>int</li>
|
||||
<li>mixed</li>
|
||||
<li>number</li>
|
||||
<li>object</li>
|
||||
<li>string</li>
|
||||
<li>void</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>die</li>
|
||||
<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>__halt_compiler</li>
|
||||
<li>_header_accept</li>
|
||||
<li>_tempbody</li>
|
||||
<li>abstract</li>
|
||||
<li>and</li>
|
||||
<li>array</li>
|
||||
<li>as</li>
|
||||
<li>break</li>
|
||||
<li>callable</li>
|
||||
<li>declare</li>
|
||||
<li>isset</li>
|
||||
<li>use</li>
|
||||
<li>queryparams</li>
|
||||
<li>echo</li>
|
||||
<li>do</li>
|
||||
<li>while</li>
|
||||
<li>unset</li>
|
||||
<li>empty</li>
|
||||
<li>resourcepath</li>
|
||||
<li>endwhile</li>
|
||||
<li>protected</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>class</li>
|
||||
<li>clone</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>declare</li>
|
||||
<li>default</li>
|
||||
<li>die</li>
|
||||
<li>do</li>
|
||||
<li>echo</li>
|
||||
<li>else</li>
|
||||
<li>elseif</li>
|
||||
<li>function</li>
|
||||
<li>empty</li>
|
||||
<li>enddeclare</li>
|
||||
<li>endfor</li>
|
||||
<li>trait</li>
|
||||
<li>catch</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>new</li>
|
||||
<li>static</li>
|
||||
<li>var</li>
|
||||
<li>require</li>
|
||||
<li>require_once</li>
|
||||
<li>list</li>
|
||||
<li>formparams</li>
|
||||
<li>headerparams</li>
|
||||
<li>_header_accept</li>
|
||||
<li>include_once</li>
|
||||
<li>exit</li>
|
||||
<li>as</li>
|
||||
<li>endforeach</li>
|
||||
<li>endif</li>
|
||||
<li>endswitch</li>
|
||||
<li>endwhile</li>
|
||||
<li>eval</li>
|
||||
<li>exit</li>
|
||||
<li>extends</li>
|
||||
<li>final</li>
|
||||
<li>try</li>
|
||||
<li>httpbody</li>
|
||||
<li>implements</li>
|
||||
<li>private</li>
|
||||
<li>const</li>
|
||||
<li>for</li>
|
||||
<li>global</li>
|
||||
<li>interface</li>
|
||||
<li>__halt_compiler</li>
|
||||
<li>_tempbody</li>
|
||||
<li>switch</li>
|
||||
<li>foreach</li>
|
||||
<li>default</li>
|
||||
<li>formparams</li>
|
||||
<li>function</li>
|
||||
<li>global</li>
|
||||
<li>goto</li>
|
||||
<li>public</li>
|
||||
<li>array</li>
|
||||
<li>and</li>
|
||||
<li>xor</li>
|
||||
<li>class</li>
|
||||
<li>headerparams</li>
|
||||
<li>httpbody</li>
|
||||
<li>if</li>
|
||||
<li>implements</li>
|
||||
<li>include</li>
|
||||
<li>or</li>
|
||||
<li>endswitch</li>
|
||||
<li>break</li>
|
||||
<li>enddeclare</li>
|
||||
<li>abstract</li>
|
||||
<li>include_once</li>
|
||||
<li>instanceof</li>
|
||||
<li>print</li>
|
||||
<li>throw</li>
|
||||
<li>insteadof</li>
|
||||
<li>clone</li>
|
||||
<li>interface</li>
|
||||
<li>isset</li>
|
||||
<li>list</li>
|
||||
<li>namespace</li>
|
||||
<li>endif</li>
|
||||
<li>endforeach</li>
|
||||
<li>new</li>
|
||||
<li>or</li>
|
||||
<li>print</li>
|
||||
<li>private</li>
|
||||
<li>protected</li>
|
||||
<li>public</li>
|
||||
<li>queryparams</li>
|
||||
<li>require</li>
|
||||
<li>require_once</li>
|
||||
<li>resourcepath</li>
|
||||
<li>return</li>
|
||||
<li>static</li>
|
||||
<li>switch</li>
|
||||
<li>throw</li>
|
||||
<li>trait</li>
|
||||
<li>try</li>
|
||||
<li>unset</li>
|
||||
<li>use</li>
|
||||
<li>var</li>
|
||||
<li>while</li>
|
||||
<li>xor</li>
|
||||
</ul>
|
||||
|
||||
@ -5,39 +5,39 @@ sidebar_label: php-ze-ph
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|modelPackage|package for generated models| |null|
|
||||
|apiPackage|package for generated api classes| |null|
|
||||
|variableNamingConvention|naming convention of variable name, e.g. camelCase.| |snake_case|
|
||||
|invokerPackage|The main namespace to use for all classes. e.g. Yay\Pets| |null|
|
||||
|packageName|The main package name for classes. e.g. GeneratedPetstore| |null|
|
||||
|srcBasePath|The directory to serve as source root.| |null|
|
||||
|artifactVersion|The version to use in the composer package version field. e.g. 1.2.3| |null|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|invokerPackage|The main namespace to use for all classes. e.g. Yay\Pets| |null|
|
||||
|modelPackage|package for generated models| |null|
|
||||
|packageName|The main package name for classes. e.g. GeneratedPetstore| |null|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|srcBasePath|The directory to serve as source root.| |null|
|
||||
|variableNamingConvention|naming convention of variable name, e.g. camelCase.| |snake_case|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|Set|java.util.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|HashMap|java.util.HashMap|
|
||||
|Array|java.util.List|
|
||||
|ArrayList|java.util.ArrayList|
|
||||
|URI|java.net.URI|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|BigDecimal|java.math.BigDecimal|
|
||||
|Date|java.util.Date|
|
||||
|DateTime|org.joda.time.*|
|
||||
|Array|java.util.List|
|
||||
|List|java.util.*|
|
||||
|UUID|java.util.UUID|
|
||||
|File|java.io.File|
|
||||
|HashMap|java.util.HashMap|
|
||||
|List|java.util.*|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|Map|java.util.Map|
|
||||
|Set|java.util.*|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|URI|java.net.URI|
|
||||
|UUID|java.util.UUID|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
@ -50,93 +50,93 @@ sidebar_label: php-ze-ph
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>void</li>
|
||||
<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>DateTime</li>
|
||||
<li>bool</li>
|
||||
<li>string</li>
|
||||
<li>double</li>
|
||||
<li>boolean</li>
|
||||
<li>byte</li>
|
||||
<li>mixed</li>
|
||||
<li>integer</li>
|
||||
<li>double</li>
|
||||
<li>float</li>
|
||||
<li>int</li>
|
||||
<li>DateTime</li>
|
||||
<li>integer</li>
|
||||
<li>mixed</li>
|
||||
<li>number</li>
|
||||
<li>boolean</li>
|
||||
<li>object</li>
|
||||
<li>string</li>
|
||||
<li>void</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>die</li>
|
||||
<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>__halt_compiler</li>
|
||||
<li>_header_accept</li>
|
||||
<li>_tempbody</li>
|
||||
<li>abstract</li>
|
||||
<li>and</li>
|
||||
<li>array</li>
|
||||
<li>as</li>
|
||||
<li>break</li>
|
||||
<li>callable</li>
|
||||
<li>declare</li>
|
||||
<li>isset</li>
|
||||
<li>use</li>
|
||||
<li>queryparams</li>
|
||||
<li>echo</li>
|
||||
<li>do</li>
|
||||
<li>while</li>
|
||||
<li>unset</li>
|
||||
<li>empty</li>
|
||||
<li>resourcepath</li>
|
||||
<li>endwhile</li>
|
||||
<li>protected</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>class</li>
|
||||
<li>clone</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>declare</li>
|
||||
<li>default</li>
|
||||
<li>die</li>
|
||||
<li>do</li>
|
||||
<li>echo</li>
|
||||
<li>else</li>
|
||||
<li>elseif</li>
|
||||
<li>function</li>
|
||||
<li>empty</li>
|
||||
<li>enddeclare</li>
|
||||
<li>endfor</li>
|
||||
<li>trait</li>
|
||||
<li>catch</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>new</li>
|
||||
<li>static</li>
|
||||
<li>var</li>
|
||||
<li>require</li>
|
||||
<li>require_once</li>
|
||||
<li>list</li>
|
||||
<li>formparams</li>
|
||||
<li>headerparams</li>
|
||||
<li>_header_accept</li>
|
||||
<li>include_once</li>
|
||||
<li>exit</li>
|
||||
<li>as</li>
|
||||
<li>endforeach</li>
|
||||
<li>endif</li>
|
||||
<li>endswitch</li>
|
||||
<li>endwhile</li>
|
||||
<li>eval</li>
|
||||
<li>exit</li>
|
||||
<li>extends</li>
|
||||
<li>final</li>
|
||||
<li>try</li>
|
||||
<li>httpbody</li>
|
||||
<li>implements</li>
|
||||
<li>private</li>
|
||||
<li>const</li>
|
||||
<li>for</li>
|
||||
<li>global</li>
|
||||
<li>interface</li>
|
||||
<li>__halt_compiler</li>
|
||||
<li>_tempbody</li>
|
||||
<li>switch</li>
|
||||
<li>foreach</li>
|
||||
<li>default</li>
|
||||
<li>formparams</li>
|
||||
<li>function</li>
|
||||
<li>global</li>
|
||||
<li>goto</li>
|
||||
<li>public</li>
|
||||
<li>array</li>
|
||||
<li>and</li>
|
||||
<li>xor</li>
|
||||
<li>class</li>
|
||||
<li>headerparams</li>
|
||||
<li>httpbody</li>
|
||||
<li>if</li>
|
||||
<li>implements</li>
|
||||
<li>include</li>
|
||||
<li>or</li>
|
||||
<li>endswitch</li>
|
||||
<li>break</li>
|
||||
<li>enddeclare</li>
|
||||
<li>abstract</li>
|
||||
<li>include_once</li>
|
||||
<li>instanceof</li>
|
||||
<li>print</li>
|
||||
<li>throw</li>
|
||||
<li>insteadof</li>
|
||||
<li>clone</li>
|
||||
<li>interface</li>
|
||||
<li>isset</li>
|
||||
<li>list</li>
|
||||
<li>namespace</li>
|
||||
<li>endif</li>
|
||||
<li>endforeach</li>
|
||||
<li>new</li>
|
||||
<li>or</li>
|
||||
<li>print</li>
|
||||
<li>private</li>
|
||||
<li>protected</li>
|
||||
<li>public</li>
|
||||
<li>queryparams</li>
|
||||
<li>require</li>
|
||||
<li>require_once</li>
|
||||
<li>resourcepath</li>
|
||||
<li>return</li>
|
||||
<li>static</li>
|
||||
<li>switch</li>
|
||||
<li>throw</li>
|
||||
<li>trait</li>
|
||||
<li>try</li>
|
||||
<li>unset</li>
|
||||
<li>use</li>
|
||||
<li>var</li>
|
||||
<li>while</li>
|
||||
<li>xor</li>
|
||||
</ul>
|
||||
|
||||
@ -5,19 +5,19 @@ sidebar_label: php
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|modelPackage|package for generated models| |null|
|
||||
|apiPackage|package for generated api classes| |null|
|
||||
|variableNamingConvention|naming convention of variable name, e.g. camelCase.| |snake_case|
|
||||
|invokerPackage|The main namespace to use for all classes. e.g. Yay\Pets| |null|
|
||||
|packageName|The main package name for classes. e.g. GeneratedPetstore| |null|
|
||||
|srcBasePath|The directory to serve as source root.| |null|
|
||||
|artifactVersion|The version to use in the composer package version field. e.g. 1.2.3| |null|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|hideGenerationTimestamp|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |true|
|
||||
|invokerPackage|The main namespace to use for all classes. e.g. Yay\Pets| |null|
|
||||
|modelPackage|package for generated models| |null|
|
||||
|packageName|The main package name for classes. e.g. GeneratedPetstore| |null|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|srcBasePath|The directory to serve as source root.| |null|
|
||||
|variableNamingConvention|naming convention of variable name, e.g. camelCase.| |snake_case|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
@ -35,93 +35,93 @@ sidebar_label: php
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>void</li>
|
||||
<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>DateTime</li>
|
||||
<li>bool</li>
|
||||
<li>string</li>
|
||||
<li>double</li>
|
||||
<li>boolean</li>
|
||||
<li>byte</li>
|
||||
<li>mixed</li>
|
||||
<li>integer</li>
|
||||
<li>double</li>
|
||||
<li>float</li>
|
||||
<li>int</li>
|
||||
<li>DateTime</li>
|
||||
<li>integer</li>
|
||||
<li>mixed</li>
|
||||
<li>number</li>
|
||||
<li>boolean</li>
|
||||
<li>object</li>
|
||||
<li>string</li>
|
||||
<li>void</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>die</li>
|
||||
<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>__halt_compiler</li>
|
||||
<li>_header_accept</li>
|
||||
<li>_tempbody</li>
|
||||
<li>abstract</li>
|
||||
<li>and</li>
|
||||
<li>array</li>
|
||||
<li>as</li>
|
||||
<li>break</li>
|
||||
<li>callable</li>
|
||||
<li>declare</li>
|
||||
<li>isset</li>
|
||||
<li>use</li>
|
||||
<li>queryparams</li>
|
||||
<li>echo</li>
|
||||
<li>do</li>
|
||||
<li>while</li>
|
||||
<li>unset</li>
|
||||
<li>empty</li>
|
||||
<li>resourcepath</li>
|
||||
<li>endwhile</li>
|
||||
<li>protected</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>class</li>
|
||||
<li>clone</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>declare</li>
|
||||
<li>default</li>
|
||||
<li>die</li>
|
||||
<li>do</li>
|
||||
<li>echo</li>
|
||||
<li>else</li>
|
||||
<li>elseif</li>
|
||||
<li>function</li>
|
||||
<li>empty</li>
|
||||
<li>enddeclare</li>
|
||||
<li>endfor</li>
|
||||
<li>trait</li>
|
||||
<li>catch</li>
|
||||
<li>if</li>
|
||||
<li>case</li>
|
||||
<li>new</li>
|
||||
<li>static</li>
|
||||
<li>var</li>
|
||||
<li>require</li>
|
||||
<li>require_once</li>
|
||||
<li>list</li>
|
||||
<li>formparams</li>
|
||||
<li>headerparams</li>
|
||||
<li>_header_accept</li>
|
||||
<li>include_once</li>
|
||||
<li>exit</li>
|
||||
<li>as</li>
|
||||
<li>endforeach</li>
|
||||
<li>endif</li>
|
||||
<li>endswitch</li>
|
||||
<li>endwhile</li>
|
||||
<li>eval</li>
|
||||
<li>exit</li>
|
||||
<li>extends</li>
|
||||
<li>final</li>
|
||||
<li>try</li>
|
||||
<li>httpbody</li>
|
||||
<li>implements</li>
|
||||
<li>private</li>
|
||||
<li>const</li>
|
||||
<li>for</li>
|
||||
<li>global</li>
|
||||
<li>interface</li>
|
||||
<li>__halt_compiler</li>
|
||||
<li>_tempbody</li>
|
||||
<li>switch</li>
|
||||
<li>foreach</li>
|
||||
<li>default</li>
|
||||
<li>formparams</li>
|
||||
<li>function</li>
|
||||
<li>global</li>
|
||||
<li>goto</li>
|
||||
<li>public</li>
|
||||
<li>array</li>
|
||||
<li>and</li>
|
||||
<li>xor</li>
|
||||
<li>class</li>
|
||||
<li>headerparams</li>
|
||||
<li>httpbody</li>
|
||||
<li>if</li>
|
||||
<li>implements</li>
|
||||
<li>include</li>
|
||||
<li>or</li>
|
||||
<li>endswitch</li>
|
||||
<li>break</li>
|
||||
<li>enddeclare</li>
|
||||
<li>abstract</li>
|
||||
<li>include_once</li>
|
||||
<li>instanceof</li>
|
||||
<li>print</li>
|
||||
<li>throw</li>
|
||||
<li>insteadof</li>
|
||||
<li>clone</li>
|
||||
<li>interface</li>
|
||||
<li>isset</li>
|
||||
<li>list</li>
|
||||
<li>namespace</li>
|
||||
<li>endif</li>
|
||||
<li>endforeach</li>
|
||||
<li>new</li>
|
||||
<li>or</li>
|
||||
<li>print</li>
|
||||
<li>private</li>
|
||||
<li>protected</li>
|
||||
<li>public</li>
|
||||
<li>queryparams</li>
|
||||
<li>require</li>
|
||||
<li>require_once</li>
|
||||
<li>resourcepath</li>
|
||||
<li>return</li>
|
||||
<li>static</li>
|
||||
<li>switch</li>
|
||||
<li>throw</li>
|
||||
<li>trait</li>
|
||||
<li>try</li>
|
||||
<li>unset</li>
|
||||
<li>use</li>
|
||||
<li>var</li>
|
||||
<li>while</li>
|
||||
<li>xor</li>
|
||||
</ul>
|
||||
|
||||
@ -5,30 +5,30 @@ sidebar_label: powershell
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|packageName|Client package name (e.g. org.openapitools.client).| |Org.OpenAPITools|
|
||||
|packageGuid|GUID for PowerShell module (e.g. a27b908d-2a20-467f-bc32-af6f3a654ac5). A random GUID will be generated by default.| |null|
|
||||
|csharpClientPath|Path to the C# API client generated by OpenAPI Generator, e.g. $ScriptDir\..\csharp\OpenAPIClient where $ScriptDir is the current directory. NOTE: you will need to generate the C# API client separately.| |$ScriptDir\csharp\OpenAPIClient|
|
||||
|packageGuid|GUID for PowerShell module (e.g. a27b908d-2a20-467f-bc32-af6f3a654ac5). A random GUID will be generated by default.| |null|
|
||||
|packageName|Client package name (e.g. org.openapitools.client).| |Org.OpenAPITools|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|Set|java.util.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|HashMap|java.util.HashMap|
|
||||
|Array|java.util.List|
|
||||
|ArrayList|java.util.ArrayList|
|
||||
|URI|java.net.URI|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|BigDecimal|java.math.BigDecimal|
|
||||
|Date|java.util.Date|
|
||||
|DateTime|org.joda.time.*|
|
||||
|Array|java.util.List|
|
||||
|List|java.util.*|
|
||||
|UUID|java.util.UUID|
|
||||
|File|java.io.File|
|
||||
|HashMap|java.util.HashMap|
|
||||
|List|java.util.*|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|Map|java.util.Map|
|
||||
|Set|java.util.*|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|URI|java.net.URI|
|
||||
|UUID|java.util.UUID|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
@ -39,62 +39,62 @@ sidebar_label: powershell
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>System.DateTime</li>
|
||||
<li>SByte</li>
|
||||
<li>XmlDocument</li>
|
||||
<li>String</li>
|
||||
<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>Boolean</li>
|
||||
<li>Byte</li>
|
||||
<li>Byte[]</li>
|
||||
<li>Char</li>
|
||||
<li>Decimal</li>
|
||||
<li>Double</li>
|
||||
<li>Guid</li>
|
||||
<li>Int16</li>
|
||||
<li>Double</li>
|
||||
<li>Uri</li>
|
||||
<li>TimeSpan</li>
|
||||
<li>Decimal</li>
|
||||
<li>Byte[]</li>
|
||||
<li>Int64</li>
|
||||
<li>Single</li>
|
||||
<li>Version</li>
|
||||
<li>Int32</li>
|
||||
<li>Char</li>
|
||||
<li>Byte</li>
|
||||
<li>UInt16</li>
|
||||
<li>Int64</li>
|
||||
<li>ProgressRecord</li>
|
||||
<li>UInt64</li>
|
||||
<li>Boolean</li>
|
||||
<li>UInt32</li>
|
||||
<li>SByte</li>
|
||||
<li>SecureString</li>
|
||||
<li>Single</li>
|
||||
<li>String</li>
|
||||
<li>System.DateTime</li>
|
||||
<li>TimeSpan</li>
|
||||
<li>UInt16</li>
|
||||
<li>UInt32</li>
|
||||
<li>UInt64</li>
|
||||
<li>Uri</li>
|
||||
<li>Version</li>
|
||||
<li>XmlDocument</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>In</li>
|
||||
<li>Catch</li>
|
||||
<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>Begin</li>
|
||||
<li>Break</li>
|
||||
<li>Process</li>
|
||||
<li>Catch</li>
|
||||
<li>Continue</li>
|
||||
<li>Elseif</li>
|
||||
<li>Function</li>
|
||||
<li>Dynamicparam</li>
|
||||
<li>Throw</li>
|
||||
<li>Begin</li>
|
||||
<li>Try</li>
|
||||
<li>Private</li>
|
||||
<li>Exit</li>
|
||||
<li>Until</li>
|
||||
<li>Return</li>
|
||||
<li>For</li>
|
||||
<li>Local</li>
|
||||
<li>Data</li>
|
||||
<li>Trap</li>
|
||||
<li>Do</li>
|
||||
<li>From</li>
|
||||
<li>While</li>
|
||||
<li>Switch</li>
|
||||
<li>Filter</li>
|
||||
<li>Dynamicparam</li>
|
||||
<li>Else</li>
|
||||
<li>Param</li>
|
||||
<li>Foreach</li>
|
||||
<li>Elseif</li>
|
||||
<li>End</li>
|
||||
<li>If</li>
|
||||
<li>Where</li>
|
||||
<li>Exit</li>
|
||||
<li>Filter</li>
|
||||
<li>Finally</li>
|
||||
<li>For</li>
|
||||
<li>Foreach</li>
|
||||
<li>From</li>
|
||||
<li>Function</li>
|
||||
<li>If</li>
|
||||
<li>In</li>
|
||||
<li>Local</li>
|
||||
<li>Param</li>
|
||||
<li>Private</li>
|
||||
<li>Process</li>
|
||||
<li>Return</li>
|
||||
<li>Switch</li>
|
||||
<li>Throw</li>
|
||||
<li>Trap</li>
|
||||
<li>Try</li>
|
||||
<li>Until</li>
|
||||
<li>Where</li>
|
||||
<li>While</li>
|
||||
</ul>
|
||||
|
||||
@ -21,23 +21,23 @@ sidebar_label: protobuf-schema
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>fixed64</li>
|
||||
<li>fixed32</li>
|
||||
<li>sint64</li>
|
||||
<li>sint32</li>
|
||||
<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>array</li>
|
||||
<li>bool</li>
|
||||
<li>string</li>
|
||||
<li>sfixed64</li>
|
||||
<li>double</li>
|
||||
<li>float</li>
|
||||
<li>array</li>
|
||||
<li>int32</li>
|
||||
<li>bytes</li>
|
||||
<li>double</li>
|
||||
<li>fixed32</li>
|
||||
<li>fixed64</li>
|
||||
<li>float</li>
|
||||
<li>int32</li>
|
||||
<li>int64</li>
|
||||
<li>uint64</li>
|
||||
<li>sfixed32</li>
|
||||
<li>uint32</li>
|
||||
<li>map</li>
|
||||
<li>sfixed32</li>
|
||||
<li>sfixed64</li>
|
||||
<li>sint32</li>
|
||||
<li>sint64</li>
|
||||
<li>string</li>
|
||||
<li>uint32</li>
|
||||
<li>uint64</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
@ -5,39 +5,39 @@ sidebar_label: python-aiohttp
|
||||
|
||||
| Option | Description | Values | Default |
|
||||
| ------ | ----------- | ------ | ------- |
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|packageName|python package name (convention: snake_case).| |openapi_server|
|
||||
|packageVersion|python package version.| |1.0.0|
|
||||
|controllerPackage|controller package| |controllers|
|
||||
|defaultController|default controller| |default_controller|
|
||||
|supportPython2|support python2| |false|
|
||||
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
||||
|packageName|python package name (convention: snake_case).| |openapi_server|
|
||||
|packageVersion|python package version.| |1.0.0|
|
||||
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
||||
|serverPort|TCP port to listen to in app.run| |8080|
|
||||
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
||||
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
||||
|supportPython2|support python2| |false|
|
||||
|useNose|use the nose test framework| |false|
|
||||
|
||||
## IMPORT MAPPING
|
||||
|
||||
| Type/Alias | Imports |
|
||||
| ---------- | ------- |
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|Set|java.util.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|HashMap|java.util.HashMap|
|
||||
|Array|java.util.List|
|
||||
|ArrayList|java.util.ArrayList|
|
||||
|URI|java.net.URI|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|BigDecimal|java.math.BigDecimal|
|
||||
|Date|java.util.Date|
|
||||
|DateTime|org.joda.time.*|
|
||||
|Array|java.util.List|
|
||||
|List|java.util.*|
|
||||
|UUID|java.util.UUID|
|
||||
|File|java.io.File|
|
||||
|HashMap|java.util.HashMap|
|
||||
|List|java.util.*|
|
||||
|LocalDate|org.joda.time.*|
|
||||
|LocalDateTime|org.joda.time.*|
|
||||
|LocalTime|org.joda.time.*|
|
||||
|Map|java.util.Map|
|
||||
|Set|java.util.*|
|
||||
|Timestamp|java.sql.Timestamp|
|
||||
|URI|java.net.URI|
|
||||
|UUID|java.util.UUID|
|
||||
|
||||
|
||||
## INSTANTIATION TYPES
|
||||
@ -48,57 +48,57 @@ sidebar_label: python-aiohttp
|
||||
|
||||
## LANGUAGE PRIMITIVES
|
||||
|
||||
<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>str</li>
|
||||
<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>Dict</li>
|
||||
<li>List</li>
|
||||
<li>bool</li>
|
||||
<li>byte</li>
|
||||
<li>bytearray</li>
|
||||
<li>date</li>
|
||||
<li>datetime</li>
|
||||
<li>file</li>
|
||||
<li>bool</li>
|
||||
<li>Dict</li>
|
||||
<li>byte</li>
|
||||
<li>bytearray</li>
|
||||
<li>List</li>
|
||||
<li>float</li>
|
||||
<li>int</li>
|
||||
<li>object</li>
|
||||
<li>str</li>
|
||||
</ul>
|
||||
|
||||
## RESERVED WORDS
|
||||
|
||||
<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>import</li>
|
||||
<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>and</li>
|
||||
<li>as</li>
|
||||
<li>assert</li>
|
||||
<li>break</li>
|
||||
<li>class</li>
|
||||
<li>continue</li>
|
||||
<li>def</li>
|
||||
<li>for</li>
|
||||
<li>del</li>
|
||||
<li>elif</li>
|
||||
<li>else</li>
|
||||
<li>except</li>
|
||||
<li>exec</li>
|
||||
<li>false</li>
|
||||
<li>finally</li>
|
||||
<li>for</li>
|
||||
<li>from</li>
|
||||
<li>global</li>
|
||||
<li>if</li>
|
||||
<li>import</li>
|
||||
<li>in</li>
|
||||
<li>is</li>
|
||||
<li>lambda</li>
|
||||
<li>none</li>
|
||||
<li>while</li>
|
||||
<li>nonlocal</li>
|
||||
<li>not</li>
|
||||
<li>lambda</li>
|
||||
<li>and</li>
|
||||
<li>assert</li>
|
||||
<li>else</li>
|
||||
<li>continue</li>
|
||||
<li>yield</li>
|
||||
<li>property</li>
|
||||
<li>raise</li>
|
||||
<li>from</li>
|
||||
<li>if</li>
|
||||
<li>class</li>
|
||||
<li>or</li>
|
||||
<li>pass</li>
|
||||
<li>break</li>
|
||||
<li>in</li>
|
||||
<li>finally</li>
|
||||
<li>false</li>
|
||||
<li>is</li>
|
||||
<li>elif</li>
|
||||
<li>with</li>
|
||||
<li>as</li>
|
||||
<li>print</li>
|
||||
<li>true</li>
|
||||
<li>self</li>
|
||||
<li>except</li>
|
||||
<li>try</li>
|
||||
<li>exec</li>
|
||||
<li>property</li>
|
||||
<li>raise</li>
|
||||
<li>return</li>
|
||||
<li>self</li>
|
||||
<li>true</li>
|
||||
<li>try</li>
|
||||
<li>while</li>
|
||||
<li>with</li>
|
||||
<li>yield</li>
|
||||
</ul>
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user