loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity

Publish documentation for the generators (#932)

Browse Source
This commit is contained in:
Jérémie Bresson 2018-08-31 16:00:27 +02:00 committed by GitHub
parent 6bc3c70115
commit 31149a5a69
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
99 changed files with 4633 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
bin/utils/ensure-up-to-date
View File

@ -33,6 +33,7 @@ sleep 5
./bin/openapi3/haskell-http-client-petstore.sh > /dev/null 2>&1
./bin/csharp-petstore.sh > /dev/null 2>&1
./bin/meta-codegen.sh > /dev/null 2>&1
./bin/utils/export_docs_generators.sh > /dev/null 2>&1
# Check:
if [ -n "$(git status --porcelain)" ]; then

11
bin/utils/export_docs_generators.sh Executable file
View File

@ -0,0 +1,11 @@
#!/bin/sh
SCRIPT="$0"
echo "# START SCRIPT: $SCRIPT"
executable="./modules/openapi-generator-cli/target/openapi-generator-cli.jar"
for GENERATOR in $(java -jar $executable list --short | sed -e 's/,/\'$'\n''/g')
do
./bin/utils/export_generator.sh $GENERATOR
done

17
bin/utils/export_generator.sh Executable file
View File

@ -0,0 +1,17 @@
#!/bin/sh
SCRIPT="$0"
echo "# START SCRIPT: $SCRIPT"
if [[ "$1" != "" ]]; then
NAME="$1"
else
echo "Missing argument. Usage e.g.: ./bin/utils/export-generator.sh jaxrs-jersey"
exit 1;
fi
executable="./modules/openapi-generator-cli/target/openapi-generator-cli.jar"
java -jar $executable config-help -g $NAME | sed -e 's/CONFIG OPTIONS/CONFIG OPTIONS for \'$NAME'\'$'\n''/g' > docs/generators/$NAME.md
echo "Back to the [generators list](README.md)" >> docs/generators/$NAME.md

8
bin/utils/export_generators_readme.sh Executable file
View File

@ -0,0 +1,8 @@
#!/bin/sh
SCRIPT="$0"
echo "# START SCRIPT: $SCRIPT"
executable="./modules/openapi-generator-cli/target/openapi-generator-cli.jar"
java -jar $executable list | sed -e 's/\([A-Z]*\) generators:/* \1 generators:/g' -e 's/- \([a-z0-9\-]*\)/- [\1]\(\1.md\)/g' > docs/generators/README.md

109
docs/generators/README.md Normal file
View File

@ -0,0 +1,109 @@
The following generators are available:
* CLIENT generators:
- [ada](ada.md)
- [android](android.md)
- [apex](apex.md)
- [bash](bash.md)
- [clojure](clojure.md)
- [cpp-qt5](cpp-qt5.md)
- [cpp-restsdk](cpp-restsdk.md)
- [cpp-tizen](cpp-tizen.md)
- [csharp](csharp.md)
- [csharp-dotnet2](csharp-dotnet2.md)
- [dart](dart.md)
- [eiffel](eiffel.md)
- [elixir](elixir.md)
- [elm](elm.md)
- [erlang-client](erlang-client.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](swift3.md)
- [swift4](swift4.md)
- [typescript-angular](typescript-angular.md)
- [typescript-angularjs](typescript-angularjs.md)
- [typescript-aurelia](typescript-aurelia.md)
- [typescript-fetch](typescript-fetch.md)
- [typescript-inversify](typescript-inversify.md)
- [typescript-jquery](typescript-jquery.md)
- [typescript-node](typescript-node.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-server](go-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)
* DOCUMENTATION generators:
- [cwiki](cwiki.md)
- [dynamic-html](dynamic-html.md)
- [html](html.md)
- [html2](html2.md)
- [openapi](openapi.md)
- [openapi-yaml](openapi-yaml.md)
* CONFIG generators:
- [apache2](apache2.md)

19
docs/generators/ada-server.md Normal file
View File

@ -0,0 +1,19 @@
CONFIG OPTIONS for ada-server
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
projectName
GNAT project name (Default: defaultProject)
Back to the [generators list](README.md)

19
docs/generators/ada.md Normal file
View File

@ -0,0 +1,19 @@
CONFIG OPTIONS for ada
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
projectName
GNAT project name (Default: defaultProject)
Back to the [generators list](README.md)

57
docs/generators/android.md Normal file
View File

@ -0,0 +1,57 @@
CONFIG OPTIONS for android
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
modelPackage
package for generated models
apiPackage
package for generated api classes
invokerPackage
root package for generated code
groupId
groupId for use in the generated build.gradle and pom.xml
artifactId
artifactId for use in the generated build.gradle and pom.xml
artifactVersion
artifact version for use in the generated build.gradle and pom.xml
sourceFolder
source folder for generated code
useAndroidMavenGradlePlugin
A flag to toggle android-maven gradle plugin. (Default: true)
androidGradleVersion
gradleVersion version for use in the generated build.gradle
androidSdkVersion
compileSdkVersion version for use in the generated build.gradle
androidBuildToolsVersion
buildToolsVersion version for use in the generated build.gradle
serializableModel
boolean - toggle "implements Serializable" for generated models (Default: false)
library
library template (sub-template) to use
volley - HTTP client: Volley 1.0.19 (default)
httpclient - 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.
Back to the [generators list](README.md)

19
docs/generators/apache2.md Normal file
View File

@ -0,0 +1,19 @@
CONFIG OPTIONS for apache2
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
userInfoPath
Path to the user and group files
Back to the [generators list](README.md)

28
docs/generators/apex.md Normal file
View File

@ -0,0 +1,28 @@
CONFIG OPTIONS for apex
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
classPrefix
Prefix for generated classes. Set this to avoid overwriting existing classes in your org.
apiVersion
The Metadata API version number to use for components in this package.
buildMethod
The build method for this package.
namedCredential
The named credential name for the HTTP callouts
Back to the [generators list](README.md)

31
docs/generators/aspnetcore.md Normal file
View File

@ -0,0 +1,31 @@
CONFIG OPTIONS for aspnetcore
packageName
C# package name (convention: Title.Case). (Default: Org.OpenAPITools)
packageVersion
C# package version. (Default: 1.0.0)
packageGuid
The GUID that will be associated with the C# project
sourceFolder
source folder for generated code (Default: src)
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
useDateTimeOffset
Use DateTimeOffset to model date-time properties (Default: false)
useCollection
Deserialize array types to Collection<T> instead of List<T>. (Default: false)
returnICollection
Return ICollection<T> instead of the concrete type. (Default: false)
useSwashbuckle
Uses the Swashbuckle.AspNetCore NuGet package for documentation. (Default: true)
Back to the [generators list](README.md)

40
docs/generators/bash.md Normal file
View File

@ -0,0 +1,40 @@
CONFIG OPTIONS for bash
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
curlOptions
Default cURL options
processMarkdown
Convert all Markdown Markup into terminal formatting (Default: false)
scriptName
The name of the script that will be generated (e.g. petstore-cli)
generateBashCompletion
Whether to generate the Bash completion script (Default: false)
generateZshCompletion
Whether to generate the Zsh completion script (Default: false)
hostEnvironmentVariable
Name of environment variable where host can be defined (e.g. PETSTORE_HOST='http://api.openapitools.org:8080')
basicAuthEnvironmentVariable
Name of environment variable where username and password can be defined (e.g. PETSTORE_CREDS='username:password')
apiKeyAuthEnvironmentVariable
Name of environment variable where API key can be defined (e.g. PETSTORE_APIKEY='kjhasdGASDa5asdASD') (Default: false)
Back to the [generators list](README.md)

37
docs/generators/clojure.md Normal file
View File

@ -0,0 +1,37 @@
CONFIG OPTIONS for clojure
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
projectName
name of the project (Default: generated from info.title or "openapi-clj-client")
projectDescription
description of the project (Default: using info.description or "Client library of <projectNname>")
projectVersion
version of the project (Default: using info.version or "1.0.0")
projectUrl
URL of the project (Default: using info.contact.url or not included in project.clj)
projectLicenseName
name of the license the project uses (Default: using info.license.name or not included in project.clj)
projectLicenseUrl
URL of the license the project uses (Default: using info.license.url or not included in project.clj)
baseNamespace
the base/top namespace (Default: generated from projectName)
Back to the [generators list](README.md)

7
docs/generators/cpp-pistache-server.md Normal file
View File

@ -0,0 +1,7 @@
CONFIG OPTIONS for cpp-pistache-server
addExternalLibs
Add the Possibility to fetch and compile external Libraries needed by this Framework. (Default: true)
Back to the [generators list](README.md)

19
docs/generators/cpp-qt5-qhttpengine-server.md Normal file
View File

@ -0,0 +1,19 @@
CONFIG OPTIONS for cpp-qt5-qhttpengine-server
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
cppNamespace
C++ namespace (convention: name::space::for::api). (Default: OpenAPI)
Back to the [generators list](README.md)

22
docs/generators/cpp-qt5.md Normal file
View File

@ -0,0 +1,22 @@
CONFIG OPTIONS for cpp-qt5
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
cppNamespace
C++ namespace (convention: name::space::for::api). (Default: OpenAPI)
optionalProjectFile
Generate client.pri. (Default: true)
Back to the [generators list](README.md)

19
docs/generators/cpp-restbed-server.md Normal file
View File

@ -0,0 +1,19 @@
CONFIG OPTIONS for cpp-restbed-server
modelPackage
C++ namespace for models (convention: name.space.model). (Default: org.openapitools.server.model)
apiPackage
C++ namespace for apis (convention: name.space.api). (Default: org.openapitools.server.api)
packageVersion
C++ package version. (Default: 1.0.0)
declspec
C++ preprocessor to place before the class name for handling dllexport/dllimport. (Default: )
defaultInclude
The default include statement that should be placed in all headers for including things like the declspec (convention: #include "Commons.h" (Default: )
Back to the [generators list](README.md)

22
docs/generators/cpp-restsdk.md Normal file
View File

@ -0,0 +1,22 @@
CONFIG OPTIONS for cpp-restsdk
modelPackage
C++ namespace for models (convention: name.space.model). (Default: org.openapitools.client.model)
apiPackage
C++ namespace for apis (convention: name.space.api). (Default: org.openapitools.client.api)
packageVersion
C++ package version. (Default: 1.0.0)
declspec
C++ preprocessor to place before the class name for handling dllexport/dllimport. (Default: )
defaultInclude
The default include statement that should be placed in all headers for including things like the declspec (convention: #include "Commons.h" (Default: )
generateGMocksForApis
Generate Google Mock classes for APIs.
Back to the [generators list](README.md)

16
docs/generators/cpp-tizen.md Normal file
View File

@ -0,0 +1,16 @@
CONFIG OPTIONS for cpp-tizen
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
Back to the [generators list](README.md)

13
docs/generators/csharp-dotnet2.md Normal file
View File

@ -0,0 +1,13 @@
CONFIG OPTIONS for csharp-dotnet2
packageName
C# package name (convention: Camel.Case). (Default: Org.OpenAPITools)
packageVersion
C# package version. (Default: 1.0.0)
clientPackage
C# client package name (convention: Camel.Case). (Default: Org.OpenAPITools.Client)
Back to the [generators list](README.md)

46
docs/generators/csharp-nancyfx.md Normal file
View File

@ -0,0 +1,46 @@
CONFIG OPTIONS for csharp-nancyfx
packageName
C# package name (convention: Title.Case). (Default: Org.OpenAPITools)
packageVersion
C# package version. (Default: 1.0.0)
sourceFolder
source folder for generated code (Default: src)
interfacePrefix
Prefix interfaces with a community standard or widely accepted prefix. (Default: )
packageGuid
The GUID that will be associated with the C# project
packageContext
Optionally overrides the PackageContext which determines the namespace (namespace=packageName.packageContext). If not set, packageContext will default to basePath.
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
optionalProjectFile
Generate {PackageName}.csproj. (Default: true)
useDateTimeOffset
Use DateTimeOffset to model date-time properties (Default: false)
useCollection
Deserialize array types to Collection<T> instead of List<T>. (Default: false)
returnICollection
Return ICollection<T> instead of the concrete type. (Default: false)
immutable
Enabled by default. If disabled generates model classes with setters (Default: true)
writeModulePath
Enabled by default. If disabled, module paths will not mirror api base path (Default: true)
asyncServer
Set to true to enable the generation of async routes/endpoints. (Default: false)
Back to the [generators list](README.md)

72
docs/generators/csharp.md Normal file
View File

@ -0,0 +1,72 @@
CONFIG OPTIONS for csharp
packageName
C# package name (convention: Title.Case). (Default: Org.OpenAPITools)
packageVersion
C# package version. (Default: 1.0.0)
sourceFolder
source folder for generated code (Default: src)
packageGuid
The GUID that will be associated with the C# project
interfacePrefix
Prefix interfaces with a community standard or widely accepted prefix. (Default: I)
targetFramework
The target .NET framework version. (Default: v4.5)
v3.5 - .NET Framework 3.5 compatible
v4.0 - .NET Framework 4.0 compatible
v4.5 - .NET Framework 4.5+ compatible
v5.0 - .NET Standard 1.3 compatible
uwp - Universal Windows Platform (IMPORTANT: this will be decommissioned and replaced by v5.0)
modelPropertyNaming
Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name (Default: PascalCase)
hideGenerationTimestamp
Hides the generation timestamp when files are generated. (Default: true)
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
useDateTimeOffset
Use DateTimeOffset to model date-time properties (Default: false)
useCollection
Deserialize array types to Collection<T> instead of List<T>. (Default: false)
returnICollection
Return ICollection<T> instead of the concrete type. (Default: false)
optionalMethodArgument
C# Optional method argument, e.g. void square(int x=10) (.net 4.0+ only). (Default: true)
optionalAssemblyInfo
Generate AssemblyInfo.cs. (Default: true)
optionalProjectFile
Generate {PackageName}.csproj. (Default: true)
optionalEmitDefaultValues
Set DataMember's EmitDefaultValue. (Default: false)
generatePropertyChanged
Specifies a AssemblyDescription for the .NET Framework global assembly attributes stored in the AssemblyInfo file. (Default: false)
nonPublicApi
Generates code with reduced access modifiers; allows embedding elsewhere without exposing non-public API calls to consumers. (Default: false)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
netCoreProjectFile
Use the new format (.NET Core) for .NET project files (.csproj). (Default: false)
validatable
Generates self-validatable models. (Default: true)
Back to the [generators list](README.md)

46
docs/generators/cwiki.md Normal file
View File

@ -0,0 +1,46 @@
CONFIG OPTIONS for cwiki
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
appName
short name of the application
appDescription
description of the application
infoUrl
a URL where users can get more information about the application
infoEmail
an email address to contact for inquiries about the application
licenseInfo
a short description of the license
licenseUrl
a URL pointing to the full license
invokerPackage
root package for generated code
groupId
groupId in generated pom.xml
artifactId
artifactId in generated pom.xml
artifactVersion
artifact version in generated pom.xml
Back to the [generators list](README.md)

34
docs/generators/dart.md Normal file
View File

@ -0,0 +1,34 @@
CONFIG OPTIONS for dart
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
browserClient
Is the client browser based
pubName
Name in generated pubspec
pubVersion
Version in generated pubspec
pubDescription
Description in generated pubspec
useEnumExtension
Allow the 'x-enum-values' extension for enums
sourceFolder
source folder for generated code
Back to the [generators list](README.md)

28
docs/generators/dynamic-html.md Normal file
View File

@ -0,0 +1,28 @@
CONFIG OPTIONS for dynamic-html
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
invokerPackage
root package for generated code
groupId
groupId in generated pom.xml
artifactId
artifactId in generated pom.xml
artifactVersion
artifact version in generated pom.xml
Back to the [generators list](README.md)

13
docs/generators/eiffel.md Normal file
View File

@ -0,0 +1,13 @@
CONFIG OPTIONS for eiffel
packageName
Eiffel Cluster name (convention: lowercase). (Default: openapi)
packageVersion
Eiffel package version. (Default: 1.0.0)
hideGenerationTimestamp
Hides the generation timestamp when files are generated. (Default: true)
Back to the [generators list](README.md)

25
docs/generators/elixir.md Normal file
View File

@ -0,0 +1,25 @@
CONFIG OPTIONS for elixir
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
invokerPackage
The main namespace to use for all classes. e.g. Yay.Pets
licenseHeader
The license header to prepend to the top of all source files.
packageName
Elixir package name (convention: lowercase).
Back to the [generators list](README.md)

4
docs/generators/elm.md Normal file
View File

@ -0,0 +1,4 @@
CONFIG OPTIONS for elm
Back to the [generators list](README.md)

10
docs/generators/erlang-client.md Normal file
View File

@ -0,0 +1,10 @@
CONFIG OPTIONS for erlang-client
packageName
Erlang application name (convention: lowercase). (Default: openapi)
packageName
Erlang application version (Default: 1.0.0)
Back to the [generators list](README.md)

7
docs/generators/erlang-server.md Normal file
View File

@ -0,0 +1,7 @@
CONFIG OPTIONS for erlang-server
packageName
Erlang package name (convention: lowercase). (Default: openapi)
Back to the [generators list](README.md)

16
docs/generators/flash.md Normal file
View File

@ -0,0 +1,16 @@
CONFIG OPTIONS for flash
packageName
flash package name (convention: package.name) (Default: org.openapitools)
packageVersion
flash package version (Default: 1.0.0)
invokerPackage
root package for generated code
sourceFolder
source folder for generated code. e.g. flash
Back to the [generators list](README.md)

10
docs/generators/go-server.md Normal file
View File

@ -0,0 +1,10 @@
CONFIG OPTIONS for go-server
packageName
Go package name (convention: lowercase). (Default: openapi)
hideGenerationTimestamp
Hides the generation timestamp when files are generated. (Default: true)
Back to the [generators list](README.md)

22
docs/generators/go.md Normal file
View File

@ -0,0 +1,22 @@
CONFIG OPTIONS for go
packageName
Go package name (convention: lowercase). (Default: openapi)
hideGenerationTimestamp
Hides the generation timestamp when files are generated. (Default: true)
packageVersion
Go package version. (Default: 1.0.0)
withGoCodegenComment
whether to include Go codegen comment to disable Go Lint and collapse by default GitHub in PRs and diffs (Default: 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) (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
Back to the [generators list](README.md)

110
docs/generators/groovy.md Normal file
View File

@ -0,0 +1,110 @@
CONFIG OPTIONS for groovy
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
modelPackage
package for generated models
apiPackage
package for generated api classes
invokerPackage
root package for generated code
groupId
groupId in generated pom.xml
artifactId
artifactId in generated pom.xml
artifactVersion
artifact version in generated pom.xml
artifactUrl
artifact URL in generated pom.xml
artifactDescription
artifact description in generated pom.xml
scmConnection
SCM connection in generated pom.xml
scmDeveloperConnection
SCM developer connection in generated pom.xml
scmUrl
SCM URL in generated pom.xml
developerName
developer name in generated pom.xml
developerEmail
developer email in generated pom.xml
developerOrganization
developer organization in generated pom.xml
developerOrganizationUrl
developer organization URL in generated pom.xml
licenseName
The name of the license
licenseUrl
The URL of the license
sourceFolder
source folder for generated code
localVariablePrefix
prefix for generated code members and local variables
serializableModel
boolean - toggle "implements Serializable" for generated models (Default: false)
bigDecimalAsString
Treat BigDecimal values as Strings to avoid precision loss. (Default: false)
fullJavaUtil
whether to use fully qualified name for classes under java.util. This option only works for Java API client (Default: false)
hideGenerationTimestamp
hides the timestamp when files were generated
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) (Default: false)
dateLibrary
Option. Date library to use
joda - Joda (for legacy app only)
legacy - Legacy java.util.Date (if you really have a good reason not to use threetenbp
java8-localdatetime - Java 8 using LocalDateTime (for legacy app only)
java8 - Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true
threetenbp - Backport of JSR310 (preferred for jdk < 1.8)
java8
Option. Use Java8 classes instead of third party equivalents
true - Use Java 8 classes such as Base64
false - Various third party libraries as needed
disableHtmlEscaping
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields) (Default: false)
booleanGetterPrefix
Set booleanGetterPrefix (default value 'get')
configPackage
configuration package for generated code
Back to the [generators list](README.md)

73
docs/generators/haskell-http-client.md Normal file
View File

@ -0,0 +1,73 @@
CONFIG OPTIONS for haskell-http-client
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
cabalPackage
Set the cabal package name, which consists of one or more alphanumeric words separated by hyphens
cabalVersion
Set the cabal version number, consisting of a sequence of one or more integers separated by dots
baseModule
Set the base module namespace
requestType
Set the name of the type used to generate requests
configType
Set the name of the type used for configuration
allowFromJsonNulls
allow JSON Null during model decoding from JSON (Default: true)
allowToJsonNulls
allow emitting JSON Null during model encoding to JSON (Default: false)
allowNonUniqueOperationIds
allow different API modules to contain the same operationId. Each API must be imported qualified (Default: false)
generateLenses
Generate Lens optics for Models (Default: true)
generateModelConstructors
Generate smart constructors (only supply required fields) for models (Default: true)
generateEnums
Generate specific datatypes for OpenAPI enums (Default: true)
generateFormUrlEncodedInstances
Generate FromForm/ToForm instances for models that are used by operations that produce or consume application/x-www-form-urlencoded (Default: true)
inlineMimeTypes
Inline (hardcode) the content-type and accept parameters on operations, when there is only 1 option (Default: true)
modelDeriving
Additional classes to include in the deriving() clause of Models
strictFields
Add strictness annotations to all model fields (Default: true)
useMonadLogger
Use the monad-logger package to provide logging (if false, use the katip logging package) (Default: false)
dateTimeFormat
format string used to parse/render a datetime
dateFormat
format string used to parse/render a date (Default: %Y-%m-%d)
hideGenerationTimestamp
Hides the generation timestamp when files are generated. (Default: true)
Back to the [generators list](README.md)

22
docs/generators/haskell.md Normal file
View File

@ -0,0 +1,22 @@
CONFIG OPTIONS for haskell
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
modelPackage
package for generated models
apiPackage
package for generated api classes
Back to the [generators list](README.md)

46
docs/generators/html.md Normal file
View File

@ -0,0 +1,46 @@
CONFIG OPTIONS for html
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
appName
short name of the application
appDescription
description of the application
infoUrl
a URL where users can get more information about the application
infoEmail
an email address to contact for inquiries about the application
licenseInfo
a short description of the license
licenseUrl
a URL pointing to the full license
invokerPackage
root package for generated code
groupId
groupId in generated pom.xml
artifactId
artifactId in generated pom.xml
artifactVersion
artifact version in generated pom.xml
Back to the [generators list](README.md)

58
docs/generators/html2.md Normal file
View File

@ -0,0 +1,58 @@
CONFIG OPTIONS for html2
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
appName
short name of the application
appDescription
description of the application
infoUrl
a URL where users can get more information about the application
infoEmail
an email address to contact for inquiries about the application
licenseInfo
a short description of the license
licenseUrl
a URL pointing to the full license
invokerPackage
root package for generated code
phpInvokerPackage
root package for generated php code
perlModuleName
root module name for generated perl code
pythonPackageName
package name for generated python code
packageName
C# package name
groupId
groupId in generated pom.xml
artifactId
artifactId in generated pom.xml
artifactVersion
artifact version in generated pom.xml
Back to the [generators list](README.md)

107
docs/generators/java-inflector.md Normal file
View File

@ -0,0 +1,107 @@
CONFIG OPTIONS for java-inflector
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
modelPackage
package for generated models
apiPackage
package for generated api classes
invokerPackage
root package for generated code
groupId
groupId in generated pom.xml
artifactId
artifactId in generated pom.xml
artifactVersion
artifact version in generated pom.xml
artifactUrl
artifact URL in generated pom.xml
artifactDescription
artifact description in generated pom.xml
scmConnection
SCM connection in generated pom.xml
scmDeveloperConnection
SCM developer connection in generated pom.xml
scmUrl
SCM URL in generated pom.xml
developerName
developer name in generated pom.xml
developerEmail
developer email in generated pom.xml
developerOrganization
developer organization in generated pom.xml
developerOrganizationUrl
developer organization URL in generated pom.xml
licenseName
The name of the license
licenseUrl
The URL of the license
sourceFolder
source folder for generated code
localVariablePrefix
prefix for generated code members and local variables
serializableModel
boolean - toggle "implements Serializable" for generated models (Default: false)
bigDecimalAsString
Treat BigDecimal values as Strings to avoid precision loss. (Default: false)
fullJavaUtil
whether to use fully qualified name for classes under java.util. This option only works for Java API client (Default: false)
hideGenerationTimestamp
hides the timestamp when files were generated
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) (Default: false)
dateLibrary
Option. Date library to use
joda - Joda (for legacy app only)
legacy - Legacy java.util.Date (if you really have a good reason not to use threetenbp
java8-localdatetime - Java 8 using LocalDateTime (for legacy app only)
java8 - Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true
threetenbp - Backport of JSR310 (preferred for jdk < 1.8)
java8
Option. Use Java8 classes instead of third party equivalents
true - Use Java 8 classes such as Base64
false - Various third party libraries as needed
disableHtmlEscaping
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields) (Default: false)
booleanGetterPrefix
Set booleanGetterPrefix (default value 'get')
Back to the [generators list](README.md)

124
docs/generators/java-msf4j.md Normal file
View File

@ -0,0 +1,124 @@
CONFIG OPTIONS for java-msf4j
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
modelPackage
package for generated models
apiPackage
package for generated api classes
invokerPackage
root package for generated code
groupId
groupId in generated pom.xml
artifactId
artifactId in generated pom.xml
artifactVersion
artifact version in generated pom.xml
artifactUrl
artifact URL in generated pom.xml
artifactDescription
artifact description in generated pom.xml
scmConnection
SCM connection in generated pom.xml
scmDeveloperConnection
SCM developer connection in generated pom.xml
scmUrl
SCM URL in generated pom.xml
developerName
developer name in generated pom.xml
developerEmail
developer email in generated pom.xml
developerOrganization
developer organization in generated pom.xml
developerOrganizationUrl
developer organization URL in generated pom.xml
licenseName
The name of the license
licenseUrl
The URL of the license
sourceFolder
source folder for generated code
localVariablePrefix
prefix for generated code members and local variables
serializableModel
boolean - toggle "implements Serializable" for generated models (Default: false)
bigDecimalAsString
Treat BigDecimal values as Strings to avoid precision loss. (Default: false)
fullJavaUtil
whether to use fully qualified name for classes under java.util. This option only works for Java API client (Default: false)
hideGenerationTimestamp
hides the timestamp when files were generated
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) (Default: false)
dateLibrary
Option. Date library to use
joda - Joda (for legacy app only)
legacy - Legacy java.util.Date (if you really have a good reason not to use threetenbp
java8-localdatetime - Java 8 using LocalDateTime (for legacy app only)
java8 - Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true
threetenbp - Backport of JSR310 (preferred for jdk < 1.8)
java8
Option. Use Java8 classes instead of third party equivalents
true - Use Java 8 classes such as Base64
false - Various third party libraries as needed
disableHtmlEscaping
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields) (Default: false)
booleanGetterPrefix
Set booleanGetterPrefix (default value 'get')
implFolder
folder for generated implementation code
title
a title describing the application
useBeanValidation
Use BeanValidation API annotations (Default: true)
serverPort
The port on which the server should be started
library
library template (sub-template) to use (Default: jersey2)
jersey1 - Jersey core 1.x
jersey2 - Jersey core 2.x
Back to the [generators list](README.md)

137
docs/generators/java-pkmst.md Normal file
View File

@ -0,0 +1,137 @@
CONFIG OPTIONS for java-pkmst
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
modelPackage
package for generated models
apiPackage
package for generated api classes
invokerPackage
root package for generated code
groupId
groupId in generated pom.xml
artifactId
artifactId in generated pom.xml
artifactVersion
artifact version in generated pom.xml
artifactUrl
artifact URL in generated pom.xml
artifactDescription
artifact description in generated pom.xml
scmConnection
SCM connection in generated pom.xml
scmDeveloperConnection
SCM developer connection in generated pom.xml
scmUrl
SCM URL in generated pom.xml
developerName
developer name in generated pom.xml
developerEmail
developer email in generated pom.xml
developerOrganization
developer organization in generated pom.xml
developerOrganizationUrl
developer organization URL in generated pom.xml
licenseName
The name of the license
licenseUrl
The URL of the license
sourceFolder
source folder for generated code
localVariablePrefix
prefix for generated code members and local variables
serializableModel
boolean - toggle "implements Serializable" for generated models (Default: false)
bigDecimalAsString
Treat BigDecimal values as Strings to avoid precision loss. (Default: false)
fullJavaUtil
whether to use fully qualified name for classes under java.util. This option only works for Java API client (Default: false)
hideGenerationTimestamp
hides the timestamp when files were generated
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) (Default: false)
dateLibrary
Option. Date library to use
joda - Joda (for legacy app only)
legacy - Legacy java.util.Date (if you really have a good reason not to use threetenbp
java8-localdatetime - Java 8 using LocalDateTime (for legacy app only)
java8 - Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true
threetenbp - Backport of JSR310 (preferred for jdk < 1.8)
java8
Option. Use Java8 classes instead of third party equivalents
true - Use Java 8 classes such as Base64
false - Various third party libraries as needed
disableHtmlEscaping
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields) (Default: false)
booleanGetterPrefix
Set booleanGetterPrefix (default value 'get')
groupId
groupId in generated pom.xml
artifactId
artifactId in generated pom.xml
artifactVersion
artifact version in generated pom.xml
basePackage
base package for java source code
serviceName
Service Name
title
server title name or client service name
eurekaUri
Eureka URI
zipkinUri
Zipkin URI
springBootAdminUri
Spring-Boot URI
pkmstInterceptor
PKMST Interceptor
Back to the [generators list](README.md)

134
docs/generators/java-play-framework.md Normal file
View File

@ -0,0 +1,134 @@
CONFIG OPTIONS for java-play-framework
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
modelPackage
package for generated models
apiPackage
package for generated api classes
invokerPackage
root package for generated code
groupId
groupId in generated pom.xml
artifactId
artifactId in generated pom.xml
artifactVersion
artifact version in generated pom.xml
artifactUrl
artifact URL in generated pom.xml
artifactDescription
artifact description in generated pom.xml
scmConnection
SCM connection in generated pom.xml
scmDeveloperConnection
SCM developer connection in generated pom.xml
scmUrl
SCM URL in generated pom.xml
developerName
developer name in generated pom.xml
developerEmail
developer email in generated pom.xml
developerOrganization
developer organization in generated pom.xml
developerOrganizationUrl
developer organization URL in generated pom.xml
licenseName
The name of the license
licenseUrl
The URL of the license
sourceFolder
source folder for generated code
localVariablePrefix
prefix for generated code members and local variables
serializableModel
boolean - toggle "implements Serializable" for generated models (Default: false)
bigDecimalAsString
Treat BigDecimal values as Strings to avoid precision loss. (Default: false)
fullJavaUtil
whether to use fully qualified name for classes under java.util. This option only works for Java API client (Default: false)
hideGenerationTimestamp
hides the timestamp when files were generated
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) (Default: false)
dateLibrary
Option. Date library to use
joda - Joda (for legacy app only)
legacy - Legacy java.util.Date (if you really have a good reason not to use threetenbp
java8-localdatetime - Java 8 using LocalDateTime (for legacy app only)
java8 - Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true
threetenbp - Backport of JSR310 (preferred for jdk < 1.8)
java8
Option. Use Java8 classes instead of third party equivalents
true - Use Java 8 classes such as Base64
false - Various third party libraries as needed
disableHtmlEscaping
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields) (Default: false)
booleanGetterPrefix
Set booleanGetterPrefix (default value 'get')
title
server title name or client service name
configPackage
configuration package for generated code
basePackage
base package for generated code
controllerOnly
Whether to generate only API interface stubs without the server files. (Default: false)
useBeanValidation
Use BeanValidation API annotations (Default: true)
useInterfaces
Makes the controllerImp implements an interface to facilitate automatic completion when updating from version x to y of your spec (Default: true)
handleExceptions
Add a 'throw exception' to each controller function. Add also a custom error handler where you can put your custom logic (Default: true)
wrapCalls
Add a wrapper to each controller function to handle things like metrics, response modification, etc.. (Default: true)
useSwaggerUI
Add a route to /api which show your documentation in swagger-ui. Will also import needed dependencies (Default: true)
Back to the [generators list](README.md)

107
docs/generators/java-undertow-server.md Normal file
View File

@ -0,0 +1,107 @@
CONFIG OPTIONS for java-undertow-server
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
modelPackage
package for generated models
apiPackage
package for generated api classes
invokerPackage
root package for generated code
groupId
groupId in generated pom.xml
artifactId
artifactId in generated pom.xml
artifactVersion
artifact version in generated pom.xml
artifactUrl
artifact URL in generated pom.xml
artifactDescription
artifact description in generated pom.xml
scmConnection
SCM connection in generated pom.xml
scmDeveloperConnection
SCM developer connection in generated pom.xml
scmUrl
SCM URL in generated pom.xml
developerName
developer name in generated pom.xml
developerEmail
developer email in generated pom.xml
developerOrganization
developer organization in generated pom.xml
developerOrganizationUrl
developer organization URL in generated pom.xml
licenseName
The name of the license
licenseUrl
The URL of the license
sourceFolder
source folder for generated code
localVariablePrefix
prefix for generated code members and local variables
serializableModel
boolean - toggle "implements Serializable" for generated models (Default: false)
bigDecimalAsString
Treat BigDecimal values as Strings to avoid precision loss. (Default: false)
fullJavaUtil
whether to use fully qualified name for classes under java.util. This option only works for Java API client (Default: false)
hideGenerationTimestamp
hides the timestamp when files were generated
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) (Default: false)
dateLibrary
Option. Date library to use
joda - Joda (for legacy app only)
legacy - Legacy java.util.Date (if you really have a good reason not to use threetenbp
java8-localdatetime - Java 8 using LocalDateTime (for legacy app only)
java8 - Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true
threetenbp - Backport of JSR310 (preferred for jdk < 1.8)
java8
Option. Use Java8 classes instead of third party equivalents
true - Use Java 8 classes such as Base64
false - Various third party libraries as needed
disableHtmlEscaping
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields) (Default: false)
booleanGetterPrefix
Set booleanGetterPrefix (default value 'get')
Back to the [generators list](README.md)

113
docs/generators/java-vertx.md Normal file
View File

@ -0,0 +1,113 @@
CONFIG OPTIONS for java-vertx
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
modelPackage
package for generated models
apiPackage
package for generated api classes
invokerPackage
root package for generated code
groupId
groupId in generated pom.xml
artifactId
artifactId in generated pom.xml
artifactVersion
artifact version in generated pom.xml
artifactUrl
artifact URL in generated pom.xml
artifactDescription
artifact description in generated pom.xml
scmConnection
SCM connection in generated pom.xml
scmDeveloperConnection
SCM developer connection in generated pom.xml
scmUrl
SCM URL in generated pom.xml
developerName
developer name in generated pom.xml
developerEmail
developer email in generated pom.xml
developerOrganization
developer organization in generated pom.xml
developerOrganizationUrl
developer organization URL in generated pom.xml
licenseName
The name of the license
licenseUrl
The URL of the license
sourceFolder
source folder for generated code
localVariablePrefix
prefix for generated code members and local variables
serializableModel
boolean - toggle "implements Serializable" for generated models (Default: false)
bigDecimalAsString
Treat BigDecimal values as Strings to avoid precision loss. (Default: false)
fullJavaUtil
whether to use fully qualified name for classes under java.util. This option only works for Java API client (Default: false)
hideGenerationTimestamp
hides the timestamp when files were generated
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) (Default: false)
dateLibrary
Option. Date library to use
joda - Joda (for legacy app only)
legacy - Legacy java.util.Date (if you really have a good reason not to use threetenbp
java8-localdatetime - Java 8 using LocalDateTime (for legacy app only)
java8 - Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true
threetenbp - Backport of JSR310 (preferred for jdk < 1.8)
java8
Option. Use Java8 classes instead of third party equivalents
true - Use Java 8 classes such as Base64
false - Various third party libraries as needed
disableHtmlEscaping
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields) (Default: false)
booleanGetterPrefix
Set booleanGetterPrefix (default value 'get')
rxInterface
When specified, API interfaces are generated with RX and methods return Single<> and Comparable. (Default: false)
vertxSwaggerRouterVersion
Specify the version of the swagger router library
Back to the [generators list](README.md)

152
docs/generators/java.md Normal file
View File

@ -0,0 +1,152 @@
CONFIG OPTIONS for java
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
modelPackage
package for generated models
apiPackage
package for generated api classes
invokerPackage
root package for generated code
groupId
groupId in generated pom.xml
artifactId
artifactId in generated pom.xml
artifactVersion
artifact version in generated pom.xml
artifactUrl
artifact URL in generated pom.xml
artifactDescription
artifact description in generated pom.xml
scmConnection
SCM connection in generated pom.xml
scmDeveloperConnection
SCM developer connection in generated pom.xml
scmUrl
SCM URL in generated pom.xml
developerName
developer name in generated pom.xml
developerEmail
developer email in generated pom.xml
developerOrganization
developer organization in generated pom.xml
developerOrganizationUrl
developer organization URL in generated pom.xml
licenseName
The name of the license
licenseUrl
The URL of the license
sourceFolder
source folder for generated code
localVariablePrefix
prefix for generated code members and local variables
serializableModel
boolean - toggle "implements Serializable" for generated models (Default: false)
bigDecimalAsString
Treat BigDecimal values as Strings to avoid precision loss. (Default: false)
fullJavaUtil
whether to use fully qualified name for classes under java.util. This option only works for Java API client (Default: false)
hideGenerationTimestamp
hides the timestamp when files were generated
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) (Default: false)
dateLibrary
Option. Date library to use
joda - Joda (for legacy app only)
legacy - Legacy java.util.Date (if you really have a good reason not to use threetenbp
java8-localdatetime - Java 8 using LocalDateTime (for legacy app only)
java8 - Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true
threetenbp - Backport of JSR310 (preferred for jdk < 1.8)
java8
Option. Use Java8 classes instead of third party equivalents
true - Use Java 8 classes such as Base64
false - Various third party libraries as needed
disableHtmlEscaping
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields) (Default: false)
booleanGetterPrefix
Set booleanGetterPrefix (default value 'get')
useRxJava
Whether to use the RxJava adapter with the retrofit2 library. (Default: false)
useRxJava2
Whether to use the RxJava2 adapter with the retrofit2 library. (Default: false)
parcelableModel
Whether to generate models for Android that implement Parcelable with the okhttp-gson library. (Default: false)
usePlayWS
Use Play! Async HTTP client (Play WS API) (Default: false)
playVersion
Version of Play! Framework (possible values "play24", "play25")
supportJava6
Whether to support Java6 with the Jersey1 library. (Default: false)
useBeanValidation
Use BeanValidation API annotations (Default: false)
performBeanValidation
Perform BeanValidation (Default: false)
useGzipFeature
Send gzip-encoded requests (Default: false)
useRuntimeException
Use RuntimeException instead of Exception (Default: false)
library
library template (sub-template) to use (Default: okhttp-gson)
jersey1 - HTTP client: Jersey client 1.19.4. JSON processing: Jackson 2.8.9. Enable Java6 support using '-DsupportJava6=true'. Enable gzip request encoding using '-DuseGzipFeature=true'.
feign - HTTP client: OpenFeign 9.4.0. JSON processing: Jackson 2.8.9
jersey2 - HTTP client: Jersey client 2.25.1. JSON processing: Jackson 2.8.9
okhttp-gson - HTTP client: OkHttp 2.7.5. JSON processing: Gson 2.8.1. Enable Parcelable models on Android using '-DparcelableModel=true'. Enable gzip request encoding using '-DuseGzipFeature=true'.
retrofit - HTTP client: OkHttp 2.7.5. JSON processing: Gson 2.3.1 (Retrofit 1.9.0). IMPORTANT NOTE: retrofit1.x is no longer actively maintained so please upgrade to 'retrofit2' instead.
retrofit2 - HTTP client: OkHttp 3.8.0. JSON processing: Gson 2.6.1 (Retrofit 2.3.0). Enable the RxJava adapter using '-DuseRxJava[2]=true'. (RxJava 1.x or 2.x)
resttemplate - HTTP client: Spring RestTemplate 4.3.9-RELEASE. JSON processing: Jackson 2.8.9
webclient - HTTP client: Spring WebClient 5.0.7-RELEASE. JSON processing: Jackson 2.9.5
resteasy - HTTP client: Resteasy client 3.1.3.Final. JSON processing: Jackson 2.8.9
vertx - HTTP client: VertX client 3.2.4. JSON processing: Jackson 2.8.9
google-api-client - HTTP client: Google API client 1.23.0. JSON processing: Jackson 2.8.9
rest-assured - HTTP client: rest-assured : 3.1.0. JSON processing: Gson 2.6.1. Only for Java8
Back to the [generators list](README.md)

22
docs/generators/javascript-closure-angular.md Normal file
View File

@ -0,0 +1,22 @@
CONFIG OPTIONS for javascript-closure-angular
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
hideGenerationTimestamp
Hides the generation timestamp when files are generated. (Default: true)
useEs6
use ES6 templates (Default: false)
Back to the [generators list](README.md)

34
docs/generators/javascript-flowtyped.md Normal file
View File

@ -0,0 +1,34 @@
CONFIG OPTIONS for javascript-flowtyped
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
modelPropertyNaming
Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name (Default: camelCase)
supportsES6
Generate code that conforms to ES6. (Default: false)
npmName
The name under which you want to publish generated npm package
npmVersion
The version of your npm package
npmRepository
Use this property to set an url your private npmRepo in the package.json
snapshot
When setting this property to true the version will be suffixed with -SNAPSHOT.yyyyMMddHHmm (Default: false)
Back to the [generators list](README.md)

67
docs/generators/javascript.md Normal file
View File

@ -0,0 +1,67 @@
CONFIG OPTIONS for javascript
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
sourceFolder
source folder for generated code (Default: src)
localVariablePrefix
prefix for generated code members and local variables
invokerPackage
root package for generated code
apiPackage
package for generated api classes
modelPackage
package for generated models
projectName
name of the project (Default: generated from info.title or "openapi-js-client")
moduleName
module name for AMD, Node or globals (Default: generated from <projectName>)
projectDescription
description of the project (Default: using info.description or "Client library of <projectName>")
projectVersion
version of the project (Default: using info.version or "1.0.0")
licenseName
name of the license the project uses (Default: using info.license.name)
usePromises
use Promises as return values from the client API, instead of superagent callbacks (Default: false)
emitModelMethods
generate getters and setters for model properties (Default: false)
emitJSDoc
generate JSDoc comments (Default: true)
useInheritance
use JavaScript prototype chains & delegation for inheritance (Default: true)
hideGenerationTimestamp
Hides the generation timestamp when files are generated. (Default: true)
useES6
use JavaScript ES6 (ECMAScript 6) (beta). Default is ES5. (Default: false)
modelPropertyNaming
Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name (Default: camelCase)
Back to the [generators list](README.md)

138
docs/generators/jaxrs-cxf-cdi.md Normal file
View File

@ -0,0 +1,138 @@
CONFIG OPTIONS for jaxrs-cxf-cdi
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
modelPackage
package for generated models
apiPackage
package for generated api classes
invokerPackage
root package for generated code
groupId
groupId in generated pom.xml
artifactId
artifactId in generated pom.xml
artifactVersion
artifact version in generated pom.xml
artifactUrl
artifact URL in generated pom.xml
artifactDescription
artifact description in generated pom.xml
scmConnection
SCM connection in generated pom.xml
scmDeveloperConnection
SCM developer connection in generated pom.xml
scmUrl
SCM URL in generated pom.xml
developerName
developer name in generated pom.xml
developerEmail
developer email in generated pom.xml
developerOrganization
developer organization in generated pom.xml
developerOrganizationUrl
developer organization URL in generated pom.xml
licenseName
The name of the license
licenseUrl
The URL of the license
sourceFolder
source folder for generated code
localVariablePrefix
prefix for generated code members and local variables
serializableModel
boolean - toggle "implements Serializable" for generated models (Default: false)
bigDecimalAsString
Treat BigDecimal values as Strings to avoid precision loss. (Default: false)
fullJavaUtil
whether to use fully qualified name for classes under java.util. This option only works for Java API client (Default: false)
hideGenerationTimestamp
hides the timestamp when files were generated
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) (Default: false)
dateLibrary
Option. Date library to use
joda - Joda (for legacy app only)
legacy - Legacy java.util.Date (if you really have a good reason not to use threetenbp
java8-localdatetime - Java 8 using LocalDateTime (for legacy app only)
java8 - Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true
threetenbp - Backport of JSR310 (preferred for jdk < 1.8)
java8
Option. Use Java8 classes instead of third party equivalents
true - Use Java 8 classes such as Base64
false - Various third party libraries as needed
disableHtmlEscaping
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields) (Default: false)
booleanGetterPrefix
Set booleanGetterPrefix (default value 'get')
implFolder
folder for generated implementation code
title
a title describing the application
useBeanValidation
Use BeanValidation API annotations (Default: true)
serverPort
The port on which the server should be started
library
library template (sub-template) to use (Default: <default>)
<default> - JAXRS
generatePom
Whether to generate pom.xml if the file does not already exist. (Default: true)
interfaceOnly
Whether to generate only API interface stubs without the server files. (Default: false)
returnResponse
Whether generate API interface should return javax.ws.rs.core.Response instead of a deserialized entity. Only useful if interfaceOnly is true. (Default: false)
useSwaggerAnnotations
Whether to generate Swagger annotations. (Default: true)
useBeanValidation
Use BeanValidation API annotations (Default: true)
Back to the [generators list](README.md)

119
docs/generators/jaxrs-cxf-client.md Normal file
View File

@ -0,0 +1,119 @@
CONFIG OPTIONS for jaxrs-cxf-client
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
modelPackage
package for generated models
apiPackage
package for generated api classes
invokerPackage
root package for generated code
groupId
groupId in generated pom.xml
artifactId
artifactId in generated pom.xml
artifactVersion
artifact version in generated pom.xml
artifactUrl
artifact URL in generated pom.xml
artifactDescription
artifact description in generated pom.xml
scmConnection
SCM connection in generated pom.xml
scmDeveloperConnection
SCM developer connection in generated pom.xml
scmUrl
SCM URL in generated pom.xml
developerName
developer name in generated pom.xml
developerEmail
developer email in generated pom.xml
developerOrganization
developer organization in generated pom.xml
developerOrganizationUrl
developer organization URL in generated pom.xml
licenseName
The name of the license
licenseUrl
The URL of the license
sourceFolder
source folder for generated code
localVariablePrefix
prefix for generated code members and local variables
serializableModel
boolean - toggle "implements Serializable" for generated models (Default: false)
bigDecimalAsString
Treat BigDecimal values as Strings to avoid precision loss. (Default: false)
fullJavaUtil
whether to use fully qualified name for classes under java.util. This option only works for Java API client (Default: false)
hideGenerationTimestamp
hides the timestamp when files were generated
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) (Default: false)
dateLibrary
Option. Date library to use
joda - Joda (for legacy app only)
legacy - Legacy java.util.Date (if you really have a good reason not to use threetenbp
java8-localdatetime - Java 8 using LocalDateTime (for legacy app only)
java8 - Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true
threetenbp - Backport of JSR310 (preferred for jdk < 1.8)
java8
Option. Use Java8 classes instead of third party equivalents
true - Use Java 8 classes such as Base64
false - Various third party libraries as needed
disableHtmlEscaping
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields) (Default: false)
booleanGetterPrefix
Set booleanGetterPrefix (default value 'get')
useBeanValidation
Use BeanValidation API annotations (Default: false)
useGzipFeatureForTests
Use Gzip Feature for tests (Default: false)
useLoggingFeatureForTests
Use Logging Feature for tests (Default: false)
useGenericResponse
Use generic response (Default: false)
Back to the [generators list](README.md)

170
docs/generators/jaxrs-cxf.md Normal file
View File

@ -0,0 +1,170 @@
CONFIG OPTIONS for jaxrs-cxf
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
modelPackage
package for generated models
apiPackage
package for generated api classes
invokerPackage
root package for generated code
groupId
groupId in generated pom.xml
artifactId
artifactId in generated pom.xml
artifactVersion
artifact version in generated pom.xml
artifactUrl
artifact URL in generated pom.xml
artifactDescription
artifact description in generated pom.xml
scmConnection
SCM connection in generated pom.xml
scmDeveloperConnection
SCM developer connection in generated pom.xml
scmUrl
SCM URL in generated pom.xml
developerName
developer name in generated pom.xml
developerEmail
developer email in generated pom.xml
developerOrganization
developer organization in generated pom.xml
developerOrganizationUrl
developer organization URL in generated pom.xml
licenseName
The name of the license
licenseUrl
The URL of the license
sourceFolder
source folder for generated code
localVariablePrefix
prefix for generated code members and local variables
serializableModel
boolean - toggle "implements Serializable" for generated models (Default: false)
bigDecimalAsString
Treat BigDecimal values as Strings to avoid precision loss. (Default: false)
fullJavaUtil
whether to use fully qualified name for classes under java.util. This option only works for Java API client (Default: false)
hideGenerationTimestamp
hides the timestamp when files were generated
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) (Default: false)
dateLibrary
Option. Date library to use
joda - Joda (for legacy app only)
legacy - Legacy java.util.Date (if you really have a good reason not to use threetenbp
java8-localdatetime - Java 8 using LocalDateTime (for legacy app only)
java8 - Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true
threetenbp - Backport of JSR310 (preferred for jdk < 1.8)
java8
Option. Use Java8 classes instead of third party equivalents
true - Use Java 8 classes such as Base64
false - Various third party libraries as needed
disableHtmlEscaping
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields) (Default: false)
booleanGetterPrefix
Set booleanGetterPrefix (default value 'get')
implFolder
folder for generated implementation code
title
a title describing the application
useBeanValidation
Use BeanValidation API annotations (Default: true)
serverPort
The port on which the server should be started
generateSpringApplication
Generate Spring application (Default: false)
useSpringAnnotationConfig
Use Spring Annotation Config (Default: false)
useSwaggerFeature
Use Swagger Feature (Default: false)
useSwaggerUI
Use Swagger UI (Default: false)
useWadlFeature
Use WADL Feature (Default: false)
useMultipartFeature
Use Multipart Feature (Default: false)
useGzipFeature
Use Gzip Feature (Default: false)
useGzipFeatureForTests
Use Gzip Feature for tests (Default: false)
useBeanValidationFeature
Use BeanValidation Feature (Default: false)
useLoggingFeature
Use Logging Feature (Default: false)
useLoggingFeatureForTests
Use Logging Feature for tests (Default: false)
generateSpringBootApplication
Generate Spring Boot application (Default: false)
generateJbossDeploymentDescriptor
Generate Jboss Deployment Descriptor (Default: false)
addConsumesProducesJson
Add @Consumes/@Produces Json to API interface (Default: false)
useAnnotatedBasePath
Use @Path annotations for basePath (Default: false)
generateNonSpringApplication
Generate non-Spring application (Default: false)
useGenericResponse
Use generic response (Default: false)
Back to the [generators list](README.md)

130
docs/generators/jaxrs-jersey.md Normal file
View File

@ -0,0 +1,130 @@
CONFIG OPTIONS for jaxrs-jersey
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
modelPackage
package for generated models
apiPackage
package for generated api classes
invokerPackage
root package for generated code
groupId
groupId in generated pom.xml
artifactId
artifactId in generated pom.xml
artifactVersion
artifact version in generated pom.xml
artifactUrl
artifact URL in generated pom.xml
artifactDescription
artifact description in generated pom.xml
scmConnection
SCM connection in generated pom.xml
scmDeveloperConnection
SCM developer connection in generated pom.xml
scmUrl
SCM URL in generated pom.xml
developerName
developer name in generated pom.xml
developerEmail
developer email in generated pom.xml
developerOrganization
developer organization in generated pom.xml
developerOrganizationUrl
developer organization URL in generated pom.xml
licenseName
The name of the license
licenseUrl
The URL of the license
sourceFolder
source folder for generated code
localVariablePrefix
prefix for generated code members and local variables
serializableModel
boolean - toggle "implements Serializable" for generated models (Default: false)
bigDecimalAsString
Treat BigDecimal values as Strings to avoid precision loss. (Default: false)
fullJavaUtil
whether to use fully qualified name for classes under java.util. This option only works for Java API client (Default: false)
hideGenerationTimestamp
hides the timestamp when files were generated
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) (Default: false)
dateLibrary
Option. Date library to use
joda - Joda (for legacy app only)
legacy - Legacy java.util.Date (if you really have a good reason not to use threetenbp
java8-localdatetime - Java 8 using LocalDateTime (for legacy app only)
java8 - Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true
threetenbp - Backport of JSR310 (preferred for jdk < 1.8)
java8
Option. Use Java8 classes instead of third party equivalents
true - Use Java 8 classes such as Base64
false - Various third party libraries as needed
disableHtmlEscaping
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields) (Default: false)
booleanGetterPrefix
Set booleanGetterPrefix (default value 'get')
implFolder
folder for generated implementation code
title
a title describing the application
useBeanValidation
Use BeanValidation API annotations (Default: true)
serverPort
The port on which the server should be started
library
library template (sub-template) to use (Default: jersey2)
jersey1 - Jersey core 1.x
jersey2 - Jersey core 2.x
supportJava6
Whether to support Java6 with the Jersey1/2 library. (Default: false)
useTags
use tags for creating interface and controller classnames (Default: false)
Back to the [generators list](README.md)

128
docs/generators/jaxrs-resteasy-eap.md Normal file
View File

@ -0,0 +1,128 @@
CONFIG OPTIONS for jaxrs-resteasy-eap
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
modelPackage
package for generated models
apiPackage
package for generated api classes
invokerPackage
root package for generated code
groupId
groupId in generated pom.xml
artifactId
artifactId in generated pom.xml
artifactVersion
artifact version in generated pom.xml
artifactUrl
artifact URL in generated pom.xml
artifactDescription
artifact description in generated pom.xml
scmConnection
SCM connection in generated pom.xml
scmDeveloperConnection
SCM developer connection in generated pom.xml
scmUrl
SCM URL in generated pom.xml
developerName
developer name in generated pom.xml
developerEmail
developer email in generated pom.xml
developerOrganization
developer organization in generated pom.xml
developerOrganizationUrl
developer organization URL in generated pom.xml
licenseName
The name of the license
licenseUrl
The URL of the license
sourceFolder
source folder for generated code
localVariablePrefix
prefix for generated code members and local variables
serializableModel
boolean - toggle "implements Serializable" for generated models (Default: false)
bigDecimalAsString
Treat BigDecimal values as Strings to avoid precision loss. (Default: false)
fullJavaUtil
whether to use fully qualified name for classes under java.util. This option only works for Java API client (Default: false)
hideGenerationTimestamp
hides the timestamp when files were generated
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) (Default: false)
dateLibrary
Option. Date library to use
joda - Joda (for legacy app only)
legacy - Legacy java.util.Date (if you really have a good reason not to use threetenbp
java8-localdatetime - Java 8 using LocalDateTime (for legacy app only)
java8 - Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true
threetenbp - Backport of JSR310 (preferred for jdk < 1.8)
java8
Option. Use Java8 classes instead of third party equivalents
true - Use Java 8 classes such as Base64
false - Various third party libraries as needed
disableHtmlEscaping
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields) (Default: false)
booleanGetterPrefix
Set booleanGetterPrefix (default value 'get')
implFolder
folder for generated implementation code
title
a title describing the application
useBeanValidation
Use BeanValidation API annotations (Default: true)
serverPort
The port on which the server should be started
useBeanValidation
Use BeanValidation API annotations (Default: true)
generateJbossDeploymentDescriptor
Generate Jboss Deployment Descriptor (Default: true)
useSwaggerFeature
Use dynamic Swagger generator (Default: false)
Back to the [generators list](README.md)

122
docs/generators/jaxrs-resteasy.md Normal file
View File

@ -0,0 +1,122 @@
CONFIG OPTIONS for jaxrs-resteasy
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
modelPackage
package for generated models
apiPackage
package for generated api classes
invokerPackage
root package for generated code
groupId
groupId in generated pom.xml
artifactId
artifactId in generated pom.xml
artifactVersion
artifact version in generated pom.xml
artifactUrl
artifact URL in generated pom.xml
artifactDescription
artifact description in generated pom.xml
scmConnection
SCM connection in generated pom.xml
scmDeveloperConnection
SCM developer connection in generated pom.xml
scmUrl
SCM URL in generated pom.xml
developerName
developer name in generated pom.xml
developerEmail
developer email in generated pom.xml
developerOrganization
developer organization in generated pom.xml
developerOrganizationUrl
developer organization URL in generated pom.xml
licenseName
The name of the license
licenseUrl
The URL of the license
sourceFolder
source folder for generated code
localVariablePrefix
prefix for generated code members and local variables
serializableModel
boolean - toggle "implements Serializable" for generated models (Default: false)
bigDecimalAsString
Treat BigDecimal values as Strings to avoid precision loss. (Default: false)
fullJavaUtil
whether to use fully qualified name for classes under java.util. This option only works for Java API client (Default: false)
hideGenerationTimestamp
hides the timestamp when files were generated
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) (Default: false)
dateLibrary
Option. Date library to use
joda - Joda (for legacy app only)
legacy - Legacy java.util.Date (if you really have a good reason not to use threetenbp
java8-localdatetime - Java 8 using LocalDateTime (for legacy app only)
java8 - Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true
threetenbp - Backport of JSR310 (preferred for jdk < 1.8)
java8
Option. Use Java8 classes instead of third party equivalents
true - Use Java 8 classes such as Base64
false - Various third party libraries as needed
disableHtmlEscaping
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields) (Default: false)
booleanGetterPrefix
Set booleanGetterPrefix (default value 'get')
implFolder
folder for generated implementation code
title
a title describing the application
useBeanValidation
Use BeanValidation API annotations (Default: true)
serverPort
The port on which the server should be started
generateJbossDeploymentDescriptor
Generate Jboss Deployment Descriptor (Default: false)
Back to the [generators list](README.md)

135
docs/generators/jaxrs-spec.md Normal file
View File

@ -0,0 +1,135 @@
CONFIG OPTIONS for jaxrs-spec
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
modelPackage
package for generated models
apiPackage
package for generated api classes
invokerPackage
root package for generated code
groupId
groupId in generated pom.xml
artifactId
artifactId in generated pom.xml
artifactVersion
artifact version in generated pom.xml
artifactUrl
artifact URL in generated pom.xml
artifactDescription
artifact description in generated pom.xml
scmConnection
SCM connection in generated pom.xml
scmDeveloperConnection
SCM developer connection in generated pom.xml
scmUrl
SCM URL in generated pom.xml
developerName
developer name in generated pom.xml
developerEmail
developer email in generated pom.xml
developerOrganization
developer organization in generated pom.xml
developerOrganizationUrl
developer organization URL in generated pom.xml
licenseName
The name of the license
licenseUrl
The URL of the license
sourceFolder
source folder for generated code
localVariablePrefix
prefix for generated code members and local variables
serializableModel
boolean - toggle "implements Serializable" for generated models (Default: false)
bigDecimalAsString
Treat BigDecimal values as Strings to avoid precision loss. (Default: false)
fullJavaUtil
whether to use fully qualified name for classes under java.util. This option only works for Java API client (Default: false)
hideGenerationTimestamp
hides the timestamp when files were generated
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) (Default: false)
dateLibrary
Option. Date library to use
joda - Joda (for legacy app only)
legacy - Legacy java.util.Date (if you really have a good reason not to use threetenbp
java8-localdatetime - Java 8 using LocalDateTime (for legacy app only)
java8 - Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true
threetenbp - Backport of JSR310 (preferred for jdk < 1.8)
java8
Option. Use Java8 classes instead of third party equivalents
true - Use Java 8 classes such as Base64
false - Various third party libraries as needed
disableHtmlEscaping
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields) (Default: false)
booleanGetterPrefix
Set booleanGetterPrefix (default value 'get')
implFolder
folder for generated implementation code
title
a title describing the application
useBeanValidation
Use BeanValidation API annotations (Default: true)
serverPort
The port on which the server should be started
library
library template (sub-template) to use (Default: <default>)
<default> - JAXRS
generatePom
Whether to generate pom.xml if the file does not already exist. (Default: true)
interfaceOnly
Whether to generate only API interface stubs without the server files. (Default: false)
returnResponse
Whether generate API interface should return javax.ws.rs.core.Response instead of a deserialized entity. Only useful if interfaceOnly is true. (Default: false)
useSwaggerAnnotations
Whether to generate Swagger annotations. (Default: true)
Back to the [generators list](README.md)

16
docs/generators/jmeter.md Normal file
View File

@ -0,0 +1,16 @@
CONFIG OPTIONS for jmeter
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
Back to the [generators list](README.md)

41
docs/generators/kotlin-server.md Normal file
View File

@ -0,0 +1,41 @@
CONFIG OPTIONS for kotlin-server
sourceFolder
source folder for generated code (Default: src/main/kotlin)
packageName
Generated artifact package name (e.g. io.swagger).
groupId
Generated artifact package's organization (i.e. maven groupId). (Default: org.openapitools)
artifactId
Generated artifact id (name of jar).
artifactVersion
Generated artifact's package version. (Default: 1.0.0)
enumPropertyNaming
Naming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original' (Default: camelCase)
library
library template (sub-template) to use (Default: ktor)
ktor - ktor framework
featureAutoHead
Automatically provide responses to HEAD requests for existing routes that have the GET verb defined. (Default: true)
featureConditionalHeaders
Avoid sending content if client already has same content, by checking ETag or LastModified properties. (Default: false)
featureHSTS
Avoid sending content if client already has same content, by checking ETag or LastModified properties. (Default: true)
featureCORS
Ktor by default provides an interceptor for implementing proper support for Cross-Origin Resource Sharing (CORS). See enable-cors.org. (Default: false)
featureCompression
Adds ability to compress outgoing content using gzip, deflate or custom encoder and thus reduce size of the response. (Default: true)
Back to the [generators list](README.md)

59
docs/generators/kotlin-spring.md Normal file
View File

@ -0,0 +1,59 @@
CONFIG OPTIONS for kotlin-spring
sourceFolder
source folder for generated code (Default: src/main/kotlin)
packageName
Generated artifact package name (e.g. io.swagger).
groupId
Generated artifact package's organization (i.e. maven groupId). (Default: org.openapitools)
artifactId
Generated artifact id (name of jar).
artifactVersion
Generated artifact's package version. (Default: 1.0.0)
enumPropertyNaming
Naming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original' (Default: camelCase)
title
server title name or client service name (Default: OpenAPI Kotlin Spring)
basePackage
base package for generated code (Default: org.openapitools)
serverPort
configuration the port in which the sever is to run on (Default: 8080)
modelPackage
model package for generated code (Default: org.openapitools.model)
apiPackage
api package for generated code (Default: org.openapitools.api)
exceptionHandler
generate default global exception handlers (Default: true)
gradleBuildFile
generate a gradle build file using the Kotlin DSL (Default: true)
swaggerAnnotations
generate swagger annotations to go alongside controllers and models (Default: 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 (Default: false)
serviceImplementation
generate stub service implementations that extends service interfaces. If this is set to true service interfaces will also be generated (Default: false)
useBeanValidation
Use BeanValidation API annotations to validate data types (Default: true)
library
library template (sub-template) to use (Default: spring-boot)
spring-boot - Spring-boot Server application.
Back to the [generators list](README.md)

28
docs/generators/kotlin.md Normal file
View File

@ -0,0 +1,28 @@
CONFIG OPTIONS for kotlin
sourceFolder
source folder for generated code (Default: src/main/kotlin)
packageName
Generated artifact package name (e.g. io.swagger).
groupId
Generated artifact package's organization (i.e. maven groupId). (Default: org.openapitools)
artifactId
Generated artifact id (name of jar).
artifactVersion
Generated artifact's package version. (Default: 1.0.0)
enumPropertyNaming
Naming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original' (Default: camelCase)
dateLibrary
Option. Date library to use
string - String
java8 - Java 8 native JSR310
threetenbp - Threetenbp
Back to the [generators list](README.md)

13
docs/generators/lua.md Normal file
View File

@ -0,0 +1,13 @@
CONFIG OPTIONS for lua
packageName
Lua package name (convention: lowercase). (Default: swagger-client)
packageVersion
Lua package version. (Default: 1.0.0-1)
hideGenerationTimestamp
Hides the generation timestamp when files are generated. (Default: true)
Back to the [generators list](README.md)

25
docs/generators/nodejs-server.md Normal file
View File

@ -0,0 +1,25 @@
CONFIG OPTIONS for nodejs-server
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: 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. (Default: 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.
serverPort
TCP port to listen on.
Back to the [generators list](README.md)

28
docs/generators/objc.md Normal file
View File

@ -0,0 +1,28 @@
CONFIG OPTIONS for objc
coreData
Should generate core data models (Default: false)
classPrefix
prefix for generated classes (convention: Abbreviation of pod name e.g. `HN` for `HackerNews`).` (Default: OAI)
podName
cocoapods package name (convention: CameCase). (Default: OpenAPIClient)
podVersion
cocoapods package version. (Default: 1.0.0)
authorName
Name to use in the podspec file. (Default: OpenAPI)
authorEmail
Email to use in the podspec file. (Default: team@openapitools.org)
gitRepoURL
URL for the git repo where this podspec should point to. (Default: https://github.com/openapitools/openapi-generator)
hideGenerationTimestamp
Hides the generation timestamp when files are generated. (Default: true)
Back to the [generators list](README.md)

19
docs/generators/openapi-yaml.md Normal file
View File

@ -0,0 +1,19 @@
CONFIG OPTIONS for openapi-yaml
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
outputFile
output filename
Back to the [generators list](README.md)

16
docs/generators/openapi.md Normal file
View File

@ -0,0 +1,16 @@
CONFIG OPTIONS for openapi
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
Back to the [generators list](README.md)

22
docs/generators/perl.md Normal file
View File

@ -0,0 +1,22 @@
CONFIG OPTIONS for perl
moduleName
Perl module name (convention: CamelCase or Long::Module). (Default: OpenAPIClient)
moduleVersion
Perl module version. (Default: 1.0.0)
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
hideGenerationTimestamp
Hides the generation timestamp when files are generated. (Default: true)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
Back to the [generators list](README.md)

43
docs/generators/php-laravel.md Normal file
View File

@ -0,0 +1,43 @@
CONFIG OPTIONS for php-laravel
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
modelPackage
package for generated models
apiPackage
package for generated api classes
variableNamingConvention
naming convention of variable name, e.g. camelCase. (Default: snake_case)
invokerPackage
The main namespace to use for all classes. e.g. Yay\Pets
packageName
The main package name for classes. e.g. GeneratedPetstore
srcBasePath
The directory to serve as source root.
gitUserId
Git user ID, e.g. openapitools.
gitRepoId
Git repo ID, e.g. openapi-generator.
artifactVersion
The version to use in the composer package version field. e.g. 1.2.3
Back to the [generators list](README.md)

43
docs/generators/php-lumen.md Normal file
View File

@ -0,0 +1,43 @@
CONFIG OPTIONS for php-lumen
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
modelPackage
package for generated models
apiPackage
package for generated api classes
variableNamingConvention
naming convention of variable name, e.g. camelCase. (Default: snake_case)
invokerPackage
The main namespace to use for all classes. e.g. Yay\Pets
packageName
The main package name for classes. e.g. GeneratedPetstore
srcBasePath
The directory to serve as source root.
gitUserId
Git user ID, e.g. openapitools.
gitRepoId
Git repo ID, e.g. openapi-generator.
artifactVersion
The version to use in the composer package version field. e.g. 1.2.3
Back to the [generators list](README.md)

16
docs/generators/php-silex.md Normal file
View File

@ -0,0 +1,16 @@
CONFIG OPTIONS for php-silex
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
Back to the [generators list](README.md)

46
docs/generators/php-slim.md Normal file
View File

@ -0,0 +1,46 @@
CONFIG OPTIONS for php-slim
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
modelPackage
package for generated models
apiPackage
package for generated api classes
variableNamingConvention
naming convention of variable name, e.g. camelCase. (Default: camelCase)
invokerPackage
The main namespace to use for all classes. e.g. Yay\Pets
packageName
The main package name for classes. e.g. GeneratedPetstore
srcBasePath
The directory to serve as source root.
gitUserId
Git user ID, e.g. openapitools.
gitRepoId
Git repo ID, e.g. openapi-generator.
artifactVersion
The version to use in the composer package version field. e.g. 1.2.3
phpcsStandard
PHP CodeSniffer <standard> option. Accepts name or path of the coding standard to use. (Default: PSR12)
Back to the [generators list](README.md)

58
docs/generators/php-symfony.md Normal file
View File

@ -0,0 +1,58 @@
CONFIG OPTIONS for php-symfony
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
modelPackage
package for generated models
apiPackage
package for generated api classes
variableNamingConvention
naming convention of variable name, e.g. camelCase. (Default: snake_case)
invokerPackage
The main namespace to use for all classes. e.g. Yay\Pets
packageName
The main package name for classes. e.g. GeneratedPetstore
srcBasePath
The directory to serve as source root.
gitUserId
Git user ID, e.g. openapitools.
gitRepoId
Git repo ID, e.g. openapi-generator.
artifactVersion
The version to use in the composer package version field. e.g. 1.2.3
composerVendorName
The vendor name used in the composer package name. The template uses {{composerVendorName}}/{{composerProjectName}} for the composer package name. e.g. yaypets
bundleName
The name of the Symfony bundle. The template uses {{bundleName}}
composerProjectName
The project name used in the composer package name. The template uses {{composerVendorName}}/{{composerProjectName}} for the composer package name. e.g. petstore-client
hideGenerationTimestamp
Hides the generation timestamp when files are generated. (Default: true)
phpLegacySupport
Should the generated code be compatible with PHP 5.x? (Default: true)
Back to the [generators list](README.md)

43
docs/generators/php-ze-ph.md Normal file
View File

@ -0,0 +1,43 @@
CONFIG OPTIONS for php-ze-ph
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
modelPackage
package for generated models
apiPackage
package for generated api classes
variableNamingConvention
naming convention of variable name, e.g. camelCase. (Default: snake_case)
invokerPackage
The main namespace to use for all classes. e.g. Yay\Pets
packageName
The main package name for classes. e.g. GeneratedPetstore
srcBasePath
The directory to serve as source root.
gitUserId
Git user ID, e.g. openapitools.
gitRepoId
Git repo ID, e.g. openapi-generator.
artifactVersion
The version to use in the composer package version field. e.g. 1.2.3
Back to the [generators list](README.md)

52
docs/generators/php.md Normal file
View File

@ -0,0 +1,52 @@
CONFIG OPTIONS for php
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
modelPackage
package for generated models
apiPackage
package for generated api classes
variableNamingConvention
naming convention of variable name, e.g. camelCase. (Default: snake_case)
invokerPackage
The main namespace to use for all classes. e.g. Yay\Pets
packageName
The main package name for classes. e.g. GeneratedPetstore
srcBasePath
The directory to serve as source root.
gitUserId
Git user ID, e.g. openapitools.
gitRepoId
Git repo ID, e.g. openapi-generator.
artifactVersion
The version to use in the composer package version field. e.g. 1.2.3
composerVendorName
The vendor name used in the composer package name. The template uses {{composerVendorName}}/{{composerProjectName}} for the composer package name. e.g. yaypets. IMPORTANT NOTE (2016/03): composerVendorName will be deprecated and replaced by gitUserId in the next openapi-generator release
composerProjectName
The project name used in the composer package name. The template uses {{composerVendorName}}/{{composerProjectName}} for the composer package name. e.g. petstore-client. IMPORTANT NOTE (2016/03): composerProjectName will be deprecated and replaced by gitRepoId in the next openapi-generator release
hideGenerationTimestamp
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: true)
Back to the [generators list](README.md)

13
docs/generators/powershell.md Normal file
View File

@ -0,0 +1,13 @@
CONFIG OPTIONS for powershell
packageName
Client package name (e.g. org.openapitools.client). (Default: Org.OpenAPITools)
packageGuid
GUID for PowerShell module (e.g. a27b908d-2a20-467f-bc32-af6f3a654ac5). A random GUID will be generated by default.
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. (Default: $ScriptDir\csharp\OpenAPIClient)
Back to the [generators list](README.md)

34
docs/generators/python-flask.md Normal file
View File

@ -0,0 +1,34 @@
CONFIG OPTIONS for python-flask
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
packageName
python package name (convention: snake_case). (Default: openapi_server)
packageVersion
python package version. (Default: 1.0.0)
controllerPackage
controller package (Default: controllers)
defaultController
default controller (Default: default_controller)
supportPython2
support python2 (Default: false)
serverPort
TCP port to listen to in app.run (Default: 8080)
Back to the [generators list](README.md)

28
docs/generators/python.md Normal file
View File

@ -0,0 +1,28 @@
CONFIG OPTIONS for python
packageName
python package name (convention: snake_case). (Default: openapi_client)
projectName
python project name in setup.py (e.g. petstore-api).
packageVersion
python package version. (Default: 1.0.0)
packageUrl
python package URL.
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
hideGenerationTimestamp
Hides the generation timestamp when files are generated. (Default: true)
generateSourceCodeOnly
Specifies that only a library source code is to be generated. (Default: false)
library
library template (sub-template) to use: asyncio, tornado, urllib3 (Default: urllib3)
Back to the [generators list](README.md)

13
docs/generators/r.md Normal file
View File

@ -0,0 +1,13 @@
CONFIG OPTIONS for r
packageName
R package name (convention: lowercase). (Default: openapi)
packageVersion
R package version. (Default: 1.0.0)
hideGenerationTimestamp
Hides the generation timestamp when files are generated. (Default: true)
Back to the [generators list](README.md)

7
docs/generators/ruby-on-rails.md Normal file
View File

@ -0,0 +1,7 @@
CONFIG OPTIONS for ruby-on-rails
databaseAdapter
The adapter for database (e.g. mysql, sqlite). Default: sqlite (Default: sqlite)
Back to the [generators list](README.md)

4
docs/generators/ruby-sinatra.md Normal file
View File

@ -0,0 +1,4 @@
CONFIG OPTIONS for ruby-sinatra
Back to the [generators list](README.md)

49
docs/generators/ruby.md Normal file
View File

@ -0,0 +1,49 @@
CONFIG OPTIONS for ruby
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
gemName
gem name (convention: underscore_case). (Default: openapi_client)
moduleName
top module name (convention: CamelCase, usually corresponding to gem name). (Default: OpenAPIClient)
gemVersion
gem version. (Default: 1.0.0)
gemLicense
gem license. (Default: proprietary)
gemRequiredRubyVersion
gem required Ruby version. (Default: >= 1.9)
gemHomepage
gem homepage. (Default: http://org.openapitools)
gemSummary
gem summary. (Default: A ruby wrapper for the REST APIs)
gemDescription
gem description. (Default: This gem maps to a REST API)
gemAuthor
gem author (only one is supported).
gemAuthorEmail
gem author email (only one is supported).
hideGenerationTimestamp
Hides the generation timestamp when files are generated. (Default: true)
Back to the [generators list](README.md)

10
docs/generators/rust-server.md Normal file
View File

@ -0,0 +1,10 @@
CONFIG OPTIONS for rust-server
packageName
Rust crate name (convention: snake_case). (Default: swagger_client)
packageVersion
Rust crate version. (Default: 1.0.0)
Back to the [generators list](README.md)

13
docs/generators/rust.md Normal file
View File

@ -0,0 +1,13 @@
CONFIG OPTIONS for rust
packageName
Rust package name (convention: lowercase). (Default: openapi)
packageVersion
Rust package version. (Default: 1.0.0)
hideGenerationTimestamp
Hides the generation timestamp when files are generated. (Default: true)
Back to the [generators list](README.md)

28
docs/generators/scala-akka.md Normal file
View File

@ -0,0 +1,28 @@
CONFIG OPTIONS for scala-akka
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
modelPackage
package for generated models
apiPackage
package for generated api classes
sourceFolder
source folder for generated code
mainPackage
Top-level package name, which defines 'apiPackage', 'modelPackage', 'invokerPackage' (Default: org.openapitools.client)
Back to the [generators list](README.md)

13
docs/generators/scala-finch.md Normal file
View File

@ -0,0 +1,13 @@
CONFIG OPTIONS for scala-finch
packageName
Finch package name (e.g. org.openapitools). (Default: org.openapitools)
modelPackage
package for generated models
apiPackage
package for generated api classes
Back to the [generators list](README.md)

25
docs/generators/scala-gatling.md Normal file
View File

@ -0,0 +1,25 @@
CONFIG OPTIONS for scala-gatling
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
modelPackage
package for generated models
apiPackage
package for generated api classes
sourceFolder
source folder for generated code
Back to the [generators list](README.md)

28
docs/generators/scala-httpclient.md Normal file
View File

@ -0,0 +1,28 @@
CONFIG OPTIONS for scala-httpclient
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
modelPackage
package for generated models
apiPackage
package for generated api classes
sourceFolder
source folder for generated code
modelPropertyNaming
Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name (Default: camelCase)
Back to the [generators list](README.md)

28
docs/generators/scala-lagom-server.md Normal file
View File

@ -0,0 +1,28 @@
CONFIG OPTIONS for scala-lagom-server
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
modelPackage
package for generated models
apiPackage
package for generated api classes
sourceFolder
source folder for generated code
modelPropertyNaming
Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name (Default: camelCase)
Back to the [generators list](README.md)

25
docs/generators/scalatra.md Normal file
View File

@ -0,0 +1,25 @@
CONFIG OPTIONS for scalatra
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
modelPackage
package for generated models
apiPackage
package for generated api classes
sourceFolder
source folder for generated code
Back to the [generators list](README.md)

28
docs/generators/scalaz.md Normal file
View File

@ -0,0 +1,28 @@
CONFIG OPTIONS for scalaz
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
modelPackage
package for generated models
apiPackage
package for generated api classes
sourceFolder
source folder for generated code
modelPropertyNaming
Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name (Default: camelCase)
Back to the [generators list](README.md)

161
docs/generators/spring.md Normal file
View File

@ -0,0 +1,161 @@
CONFIG OPTIONS for spring
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
modelPackage
package for generated models
apiPackage
package for generated api classes
invokerPackage
root package for generated code
groupId
groupId in generated pom.xml
artifactId
artifactId in generated pom.xml
artifactVersion
artifact version in generated pom.xml
artifactUrl
artifact URL in generated pom.xml
artifactDescription
artifact description in generated pom.xml
scmConnection
SCM connection in generated pom.xml
scmDeveloperConnection
SCM developer connection in generated pom.xml
scmUrl
SCM URL in generated pom.xml
developerName
developer name in generated pom.xml
developerEmail
developer email in generated pom.xml
developerOrganization
developer organization in generated pom.xml
developerOrganizationUrl
developer organization URL in generated pom.xml
licenseName
The name of the license
licenseUrl
The URL of the license
sourceFolder
source folder for generated code
localVariablePrefix
prefix for generated code members and local variables
serializableModel
boolean - toggle "implements Serializable" for generated models (Default: false)
bigDecimalAsString
Treat BigDecimal values as Strings to avoid precision loss. (Default: false)
fullJavaUtil
whether to use fully qualified name for classes under java.util. This option only works for Java API client (Default: false)
hideGenerationTimestamp
hides the timestamp when files were generated
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) (Default: false)
dateLibrary
Option. Date library to use
joda - Joda (for legacy app only)
legacy - Legacy java.util.Date (if you really have a good reason not to use threetenbp
java8-localdatetime - Java 8 using LocalDateTime (for legacy app only)
java8 - Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true
threetenbp - Backport of JSR310 (preferred for jdk < 1.8)
java8
Option. Use Java8 classes instead of third party equivalents
true - Use Java 8 classes such as Base64
false - Various third party libraries as needed
disableHtmlEscaping
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields) (Default: false)
booleanGetterPrefix
Set booleanGetterPrefix (default value 'get')
title
server title name or client service name
configPackage
configuration package for generated code
basePackage
base package (invokerPackage) for generated code
interfaceOnly
Whether to generate only API interface stubs without the server files. (Default: false)
delegatePattern
Whether to generate the server files using the delegate pattern (Default: false)
singleContentTypes
Whether to select only one produces/consumes content-type by operation. (Default: false)
java8
use java8 default interface (Default: true)
async
use async Callable controllers (Default: false)
reactive
wrap responses in Mono/Flux Reactor types (spring-boot only) (Default: false)
responseWrapper
wrap the responses in given type (Future,Callable,CompletableFuture,ListenableFuture,DeferredResult,HystrixCommand,RxObservable,RxSingle or fully qualified type)
useTags
use tags for creating interface and controller classnames (Default: false)
useBeanValidation
Use BeanValidation API annotations (Default: true)
implicitHeaders
Use of @ApiImplicitParams for headers. (Default: false)
swaggerDocketConfig
Generate Spring OpenAPI Docket configuration class. (Default: false)
apiFirst
Generate the API from the OAI spec at server compile time (API first approach) (Default: false)
useOptional
Use Optional container for optional parameters (Default: false)
library
library template (sub-template) to use (Default: spring-boot)
spring-boot - Spring-boot Server application using the SpringFox integration.
spring-mvc - Spring-MVC Server application using the SpringFox integration.
spring-cloud - Spring-Cloud-Feign client with Spring-Boot auto-configured settings.
Back to the [generators list](README.md)

64
docs/generators/swift2-deprecated.md Normal file
View File

@ -0,0 +1,64 @@
CONFIG OPTIONS for swift2-deprecated
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
projectName
Project name in Xcode
responseAs
Optionally use libraries to manage response. Currently PromiseKit, RxSwift are available.
unwrapRequired
Treat 'required' properties in response as non-optional (which would crash the app if api returns null as opposed to required option specified in json schema
podSource
Source information used for Podspec
podVersion
Version used for Podspec
podAuthors
Authors used for Podspec
podSocialMediaURL
Social Media URL used for Podspec
podDocsetURL
Docset URL used for Podspec
podLicense
License used for Podspec
podHomepage
Homepage used for Podspec
podSummary
Summary used for Podspec
podDescription
Description used for Podspec
podScreenshots
Screenshots used for Podspec
podDocumentationURL
Documentation URL used for Podspec
swiftUseApiNamespace
Flag to make all the API classes inner-class of {{projectName}}API
hideGenerationTimestamp
Hides the generation timestamp when files are generated. (Default: true)
Back to the [generators list](README.md)

70
docs/generators/swift3.md Normal file
View File

@ -0,0 +1,70 @@
CONFIG OPTIONS for swift3
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
projectName
Project name in Xcode
responseAs
Optionally use libraries to manage response. Currently PromiseKit, RxSwift are available.
unwrapRequired
Treat 'required' properties in response as non-optional (which would crash the app if api returns null as opposed to required option specified in json schema
objcCompatible
Add additional properties and methods for Objective-C compatibility (default: false)
podSource
Source information used for Podspec
podVersion
Version used for Podspec
podAuthors
Authors used for Podspec
podSocialMediaURL
Social Media URL used for Podspec
podDocsetURL
Docset URL used for Podspec
podLicense
License used for Podspec
podHomepage
Homepage used for Podspec
podSummary
Summary used for Podspec
podDescription
Description used for Podspec
podScreenshots
Screenshots used for Podspec
podDocumentationURL
Documentation URL used for Podspec
swiftUseApiNamespace
Flag to make all the API classes inner-class of {{projectName}}API
hideGenerationTimestamp
Hides the generation timestamp when files are generated. (Default: true)
lenientTypeCast
Accept and cast values for simple types (string->bool, string->int, int->string) (Default: false)
Back to the [generators list](README.md)

70
docs/generators/swift4.md Normal file
View File

@ -0,0 +1,70 @@
CONFIG OPTIONS for swift4
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
projectName
Project name in Xcode
responseAs
Optionally use libraries to manage response. Currently PromiseKit, RxSwift are available.
unwrapRequired
Treat 'required' properties in response as non-optional (which would crash the app if api returns null as opposed to required option specified in json schema
objcCompatible
Add additional properties and methods for Objective-C compatibility (default: false)
podSource
Source information used for Podspec
podVersion
Version used for Podspec
podAuthors
Authors used for Podspec
podSocialMediaURL
Social Media URL used for Podspec
podDocsetURL
Docset URL used for Podspec
podLicense
License used for Podspec
podHomepage
Homepage used for Podspec
podSummary
Summary used for Podspec
podDescription
Description used for Podspec
podScreenshots
Screenshots used for Podspec
podDocumentationURL
Documentation URL used for Podspec
swiftUseApiNamespace
Flag to make all the API classes inner-class of {{projectName}}API
hideGenerationTimestamp
Hides the generation timestamp when files are generated. (Default: true)
lenientTypeCast
Accept and cast values for simple types (string->bool, string->int, int->string) (Default: false)
Back to the [generators list](README.md)

58
docs/generators/typescript-angular.md Normal file
View File

@ -0,0 +1,58 @@
CONFIG OPTIONS for typescript-angular
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
modelPropertyNaming
Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name (Default: camelCase)
supportsES6
Generate code that conforms to ES6. (Default: false)
npmName
The name under which you want to publish generated npm package. Required to generate a full angular package
npmVersion
The version of your npm package. Default is '1.0.0'
npmRepository
Use this property to set an url your private npmRepo in the package.json
snapshot
When setting this property to true the version will be suffixed with -SNAPSHOT.yyyyMMddHHmm (Default: false)
withInterfaces
Setting this property to true will generate interfaces next to the default class implementations. (Default: false)
taggedUnions
Use discriminators to create tagged unions instead of extending interfaces. (Default: false)
providedInRoot
Use this property to provide Injectables in root (it is only valid in angular version greater or equal to 6.0.0). (Default: false)
ngVersion
The version of Angular. Default is '4.3'
serviceSuffix
The suffix of the generated service. Default is 'Service'.
serviceFileSuffix
The suffix of the file of the generated service (service<suffix>.ts). Default is '.service'.
modelSuffix
The suffix of the generated model. Default is ''.
modelFileSuffix
The suffix of the file of the generated model (model<suffix>.ts). Default is ''.
Back to the [generators list](README.md)

22
docs/generators/typescript-angularjs.md Normal file
View File

@ -0,0 +1,22 @@
CONFIG OPTIONS for typescript-angularjs
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
modelPropertyNaming
Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name (Default: camelCase)
supportsES6
Generate code that conforms to ES6. (Default: false)
Back to the [generators list](README.md)

28
docs/generators/typescript-aurelia.md Normal file
View File

@ -0,0 +1,28 @@
CONFIG OPTIONS for typescript-aurelia
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
modelPropertyNaming
Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name (Default: camelCase)
supportsES6
Generate code that conforms to ES6. (Default: false)
npmName
The name under which you want to publish generated npm package
npmVersion
The version of your npm package
Back to the [generators list](README.md)

37
docs/generators/typescript-fetch.md Normal file
View File

@ -0,0 +1,37 @@
CONFIG OPTIONS for typescript-fetch
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
modelPropertyNaming
Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name (Default: camelCase)
supportsES6
Generate code that conforms to ES6. (Default: false)
npmName
The name under which you want to publish generated npm package
npmVersion
The version of your npm package
npmRepository
Use this property to set an url your private npmRepo in the package.json
snapshot
When setting this property to true the version will be suffixed with -SNAPSHOT.yyyyMMddHHmm (Default: false)
withInterfaces
Setting this property to true will generate interfaces next to the default class implementations. (Default: false)
Back to the [generators list](README.md)

43
docs/generators/typescript-inversify.md Normal file
View File

@ -0,0 +1,43 @@
CONFIG OPTIONS for typescript-inversify
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
modelPropertyNaming
Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name (Default: camelCase)
supportsES6
Generate code that conforms to ES6. (Default: false)
npmName
The name under which you want to publish generated npm package
npmVersion
The version of your npm package
npmRepository
Use this property to set an url your private npmRepo in the package.json
snapshot
When setting this property to true the version will be suffixed with -SNAPSHOT.yyyyMMddHHmm (Default: false)
withInterfaces
Setting this property to true will generate interfaces next to the default class implementations. (Default: false)
usePromise
Setting this property to use promise instead of observable inside every service. (Default: false)
taggedUnions
Use discriminators to create tagged unions instead of extending interfaces. (Default: false)
Back to the [generators list](README.md)

37
docs/generators/typescript-jquery.md Normal file
View File

@ -0,0 +1,37 @@
CONFIG OPTIONS for typescript-jquery
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
modelPropertyNaming
Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name (Default: camelCase)
supportsES6
Generate code that conforms to ES6. (Default: false)
npmName
The name under which you want to publish generated npm package
npmVersion
The version of your npm package
npmRepository
Use this property to set an url your private npmRepo in the package.json
snapshot
When setting this property to true the version will be suffixed with -SNAPSHOT.yyyyMMddHHmm (Default: false)
jqueryAlreadyImported
When using this in legacy app using mix of typescript and javascript, this will only declare jquery and not import it (Default: false)
Back to the [generators list](README.md)

34
docs/generators/typescript-node.md Normal file
View File

@ -0,0 +1,34 @@
CONFIG OPTIONS for typescript-node
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters. (Default: true)
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list. (Default: false)
modelPropertyNaming
Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name (Default: camelCase)
supportsES6
Generate code that conforms to ES6. (Default: false)
npmName
The name under which you want to publish generated npm package
npmVersion
The version of your npm package
npmRepository
Use this property to set an url your private npmRepo in the package.json
snapshot
When setting this property to true the version will be suffixed with -SNAPSHOT.yyyyMMddHHmm (Default: false)
Back to the [generators list](README.md)