forked from loafle/openapi-generator-original
Merge remote-tracking branch 'origin/master' into 4.0.x
This commit is contained in:
commit
94eb1c3c63
5
.gitignore
vendored
5
.gitignore
vendored
@ -6,6 +6,7 @@ out/
|
|||||||
*.gpg
|
*.gpg
|
||||||
classpath.txt
|
classpath.txt
|
||||||
version.properties
|
version.properties
|
||||||
|
modules/openapi-generator-gradle-plugin/bin/
|
||||||
!modules/openapi-generator-cli/src/main/resources/version.properties
|
!modules/openapi-generator-cli/src/main/resources/version.properties
|
||||||
.project
|
.project
|
||||||
.classpath
|
.classpath
|
||||||
@ -115,14 +116,14 @@ samples/client/petstore/swift/**/SwaggerClientTests/SwaggerClient.xcworkspace/xc
|
|||||||
samples/client/petstore/swift/**/SwaggerClientTests/Pods/
|
samples/client/petstore/swift/**/SwaggerClientTests/Pods/
|
||||||
#samples/client/petstore/swift/**/SwaggerClientTests/Pods/Pods.xcodeproj/xcuserdata
|
#samples/client/petstore/swift/**/SwaggerClientTests/Pods/Pods.xcodeproj/xcuserdata
|
||||||
#samples/client/petstore/swift/**/SwaggerClientTests/Pods/Pods.xcodeproj/xcshareddata/xcschemes
|
#samples/client/petstore/swift/**/SwaggerClientTests/Pods/Pods.xcodeproj/xcshareddata/xcschemes
|
||||||
samples/client/petstore/swift/**/SwaggerClientTests/Podfile.lock
|
samples/client/petstore/swift/**/SwaggerClientTests/Podfile.lock
|
||||||
# Swift3
|
# Swift3
|
||||||
samples/client/petstore/swift3/**/SwaggerClientTests/SwaggerClient.xcodeproj/xcuserdata
|
samples/client/petstore/swift3/**/SwaggerClientTests/SwaggerClient.xcodeproj/xcuserdata
|
||||||
samples/client/petstore/swift3/**/SwaggerClientTests/SwaggerClient.xcworkspace/xcuserdata
|
samples/client/petstore/swift3/**/SwaggerClientTests/SwaggerClient.xcworkspace/xcuserdata
|
||||||
#samples/client/petstore/swift3/**/SwaggerClientTests/Pods/
|
#samples/client/petstore/swift3/**/SwaggerClientTests/Pods/
|
||||||
#samples/client/petstore/swift3/**/SwaggerClientTests/Pods/Pods.xcodeproj/xcuserdata
|
#samples/client/petstore/swift3/**/SwaggerClientTests/Pods/Pods.xcodeproj/xcuserdata
|
||||||
#samples/client/petstore/swift3/**/SwaggerClientTests/Pods/Pods.xcodeproj/xcshareddata/xcschemes
|
#samples/client/petstore/swift3/**/SwaggerClientTests/Pods/Pods.xcodeproj/xcshareddata/xcschemes
|
||||||
samples/client/petstore/swift3/**/SwaggerClientTests/Podfile.lock
|
samples/client/petstore/swift3/**/SwaggerClientTests/Podfile.lock
|
||||||
|
|
||||||
# C#
|
# C#
|
||||||
*.csproj.user
|
*.csproj.user
|
||||||
|
@ -26,7 +26,7 @@ RUN mkdir -p ${TARGET_DIR}
|
|||||||
|
|
||||||
WORKDIR ${TARGET_DIR}
|
WORKDIR ${TARGET_DIR}
|
||||||
|
|
||||||
COPY --from=builder ${GEN_DIR}/modules/openapi-generator-online/target/openapi-generator.jar ${TARGET_DIR}/openapi-generator-online.jar
|
COPY --from=builder ${GEN_DIR}/modules/openapi-generator-online/target/openapi-generator-online.jar ${TARGET_DIR}/openapi-generator-online.jar
|
||||||
|
|
||||||
ENV GENERATOR_HOST=http://localhost
|
ENV GENERATOR_HOST=http://localhost
|
||||||
|
|
||||||
|
12
.travis.yml
12
.travis.yml
@ -30,6 +30,7 @@ cache:
|
|||||||
- $HOME/perl5
|
- $HOME/perl5
|
||||||
- $HOME/.cargo
|
- $HOME/.cargo
|
||||||
- $HOME/.stack
|
- $HOME/.stack
|
||||||
|
- $HOME/.pub-cache
|
||||||
- $HOME/samples/server/petstore/cpp-pistache/pistache
|
- $HOME/samples/server/petstore/cpp-pistache/pistache
|
||||||
- $HOME/.npm
|
- $HOME/.npm
|
||||||
- $HOME/.rvm/gems/ruby-2.4.1
|
- $HOME/.rvm/gems/ruby-2.4.1
|
||||||
@ -72,6 +73,13 @@ before_install:
|
|||||||
- sudo apt-get update -qq
|
- sudo apt-get update -qq
|
||||||
- sudo apt-get install -qq bats
|
- sudo apt-get install -qq bats
|
||||||
- sudo apt-get install -qq curl
|
- sudo apt-get install -qq curl
|
||||||
|
# install dart
|
||||||
|
#- sudo apt-get update
|
||||||
|
- sudo apt-get install apt-transport-https
|
||||||
|
- sudo sh -c 'curl https://dl-ssl.google.com/linux/linux_signing_key.pub | apt-key add -'
|
||||||
|
- sudo sh -c 'curl https://storage.googleapis.com/download.dartlang.org/linux/debian/dart_stable.list > /etc/apt/sources.list.d/dart_stable.list'
|
||||||
|
- sudo apt-get update
|
||||||
|
- sudo apt-get install dart
|
||||||
# install perl module
|
# install perl module
|
||||||
#- cpanm --local-lib=~/perl5 local::lib && eval $(perl -I ~/perl5/lib/perl5/ -Mlocal::lib)
|
#- cpanm --local-lib=~/perl5 local::lib && eval $(perl -I ~/perl5/lib/perl5/ -Mlocal::lib)
|
||||||
#- cpanm Test::Exception Test::More Log::Any LWP::UserAgent JSON URI:Query Module::Runtime DateTime Module::Find Moose::Role
|
#- cpanm Test::Exception Test::More Log::Any LWP::UserAgent JSON URI:Query Module::Runtime DateTime Module::Find Moose::Role
|
||||||
@ -96,11 +104,13 @@ install:
|
|||||||
# Add Godeps dependencies to GOPATH and PATH
|
# Add Godeps dependencies to GOPATH and PATH
|
||||||
#- eval "$(curl -sL https://raw.githubusercontent.com/travis-ci/gimme/master/gimme | GIMME_GO_VERSION=1.4 bash)"
|
#- eval "$(curl -sL https://raw.githubusercontent.com/travis-ci/gimme/master/gimme | GIMME_GO_VERSION=1.4 bash)"
|
||||||
#- export GOPATH="${TRAVIS_BUILD_DIR}/Godeps/_workspace"
|
#- export GOPATH="${TRAVIS_BUILD_DIR}/Godeps/_workspace"
|
||||||
- export PATH="${TRAVIS_BUILD_DIR}/Godeps/_workspace/bin:$HOME/.cargo/bin:$PATH"
|
- export PATH="${TRAVIS_BUILD_DIR}/Godeps/_workspace/bin:$HOME/.cargo/bin:$PATH:/usr/lib/dart/bin"
|
||||||
#- go version
|
#- go version
|
||||||
- gcc -v
|
- gcc -v
|
||||||
- echo $CC
|
- echo $CC
|
||||||
- echo $CXX
|
- echo $CXX
|
||||||
|
- pub version
|
||||||
|
- dart --version
|
||||||
|
|
||||||
script:
|
script:
|
||||||
# fail fast
|
# fail fast
|
||||||
|
@ -8,6 +8,10 @@ if [ "$NODE_INDEX" = "1" ]; then
|
|||||||
cp CI/pom.xml.circleci pom.xml
|
cp CI/pom.xml.circleci pom.xml
|
||||||
java -version
|
java -version
|
||||||
mvn --quiet verify -Psamples
|
mvn --quiet verify -Psamples
|
||||||
|
elif [ "$NODE_INDEX" = "2" ]; then
|
||||||
|
echo "Running node $NODE_INDEX to test ensure-up-to-date"
|
||||||
|
export GO_FMT_PATH=`which gofmt`
|
||||||
|
./bin/utils/ensure-up-to-date
|
||||||
else
|
else
|
||||||
echo "Running node $NODE_INDEX to test CI/pom.xml.circleci.java7 ..."
|
echo "Running node $NODE_INDEX to test CI/pom.xml.circleci.java7 ..."
|
||||||
sudo update-java-alternatives -s java-1.7.0-openjdk-amd64
|
sudo update-java-alternatives -s java-1.7.0-openjdk-amd64
|
||||||
|
@ -920,8 +920,8 @@
|
|||||||
</repository>
|
</repository>
|
||||||
</repositories>
|
</repositories>
|
||||||
<properties>
|
<properties>
|
||||||
<swagger-parser-version>2.0.2-OpenAPITools.org-1</swagger-parser-version>
|
<swagger-parser-version>2.0.4</swagger-parser-version>
|
||||||
<swagger-core-version>2.0.1</swagger-core-version>
|
<swagger-core-version>2.0.4</swagger-core-version>
|
||||||
<scala-version>2.11.1</scala-version>
|
<scala-version>2.11.1</scala-version>
|
||||||
<felix-version>3.3.0</felix-version>
|
<felix-version>3.3.0</felix-version>
|
||||||
<commons-io-version>2.4</commons-io-version>
|
<commons-io-version>2.4</commons-io-version>
|
||||||
|
@ -891,6 +891,7 @@
|
|||||||
<module>samples/client/petstore/scalaz</module>
|
<module>samples/client/petstore/scalaz</module>
|
||||||
<module>samples/client/petstore/clojure</module>
|
<module>samples/client/petstore/clojure</module>
|
||||||
<module>samples/client/petstore/java/feign</module>
|
<module>samples/client/petstore/java/feign</module>
|
||||||
|
<module>samples/client/petstore/java/feign10x</module>
|
||||||
<module>samples/client/petstore/java/jersey1</module>
|
<module>samples/client/petstore/java/jersey1</module>
|
||||||
<module>samples/client/petstore/java/jersey2</module>
|
<module>samples/client/petstore/java/jersey2</module>
|
||||||
<module>samples/client/petstore/java/jersey2-java8</module>
|
<module>samples/client/petstore/java/jersey2-java8</module>
|
||||||
@ -899,6 +900,7 @@
|
|||||||
<module>samples/client/petstore/java/retrofit2</module>
|
<module>samples/client/petstore/java/retrofit2</module>
|
||||||
<module>samples/client/petstore/java/retrofit2rx</module>
|
<module>samples/client/petstore/java/retrofit2rx</module>
|
||||||
<module>samples/client/petstore/java/retrofit2-play25</module>
|
<module>samples/client/petstore/java/retrofit2-play25</module>
|
||||||
|
<module>samples/client/petstore/java/retrofit2-play26</module>
|
||||||
<module>samples/client/petstore/jaxrs-cxf-client</module>
|
<module>samples/client/petstore/jaxrs-cxf-client</module>
|
||||||
<module>samples/client/petstore/java/resttemplate</module>
|
<module>samples/client/petstore/java/resttemplate</module>
|
||||||
<module>samples/client/petstore/java/resttemplate-withXml</module>
|
<module>samples/client/petstore/java/resttemplate-withXml</module>
|
||||||
@ -957,6 +959,7 @@
|
|||||||
<module>samples/server/petstore/scala-lagom-server</module>
|
<module>samples/server/petstore/scala-lagom-server</module>
|
||||||
<module>samples/server/petstore/scalatra</module>
|
<module>samples/server/petstore/scalatra</module>
|
||||||
<module>samples/server/petstore/finch</module>
|
<module>samples/server/petstore/finch</module>
|
||||||
|
<module>samples/server/petstore/kotlin-springboot</module>
|
||||||
</modules>
|
</modules>
|
||||||
</profile>
|
</profile>
|
||||||
</profiles>
|
</profiles>
|
||||||
@ -1028,8 +1031,8 @@
|
|||||||
</repository>
|
</repository>
|
||||||
</repositories>
|
</repositories>
|
||||||
<properties>
|
<properties>
|
||||||
<swagger-parser-version>2.0.2-OpenAPITools.org-1</swagger-parser-version>
|
<swagger-parser-version>2.0.4</swagger-parser-version>
|
||||||
<swagger-core-version>2.0.1</swagger-core-version>
|
<swagger-core-version>2.0.4</swagger-core-version>
|
||||||
<scala-version>2.11.1</scala-version>
|
<scala-version>2.11.1</scala-version>
|
||||||
<felix-version>3.3.0</felix-version>
|
<felix-version>3.3.0</felix-version>
|
||||||
<commons-io-version>2.4</commons-io-version>
|
<commons-io-version>2.4</commons-io-version>
|
||||||
|
@ -999,8 +999,8 @@
|
|||||||
</repository>
|
</repository>
|
||||||
</repositories>
|
</repositories>
|
||||||
<properties>
|
<properties>
|
||||||
<swagger-parser-version>2.0.2-OpenAPITools.org-1</swagger-parser-version>
|
<swagger-parser-version>2.0.4</swagger-parser-version>
|
||||||
<swagger-core-version>2.0.1</swagger-core-version>
|
<swagger-core-version>2.0.4</swagger-core-version>
|
||||||
<scala-version>2.11.1</scala-version>
|
<scala-version>2.11.1</scala-version>
|
||||||
<felix-version>3.3.0</felix-version>
|
<felix-version>3.3.0</felix-version>
|
||||||
<commons-io-version>2.4</commons-io-version>
|
<commons-io-version>2.4</commons-io-version>
|
||||||
|
@ -928,8 +928,8 @@
|
|||||||
</repository>
|
</repository>
|
||||||
</repositories>
|
</repositories>
|
||||||
<properties>
|
<properties>
|
||||||
<swagger-parser-version>2.0.2-OpenAPITools.org-1</swagger-parser-version>
|
<swagger-parser-version>2.0.4</swagger-parser-version>
|
||||||
<swagger-core-version>2.0.1</swagger-core-version>
|
<swagger-core-version>2.0.4</swagger-core-version>
|
||||||
<scala-version>2.11.1</scala-version>
|
<scala-version>2.11.1</scala-version>
|
||||||
<felix-version>3.3.0</felix-version>
|
<felix-version>3.3.0</felix-version>
|
||||||
<commons-io-version>2.4</commons-io-version>
|
<commons-io-version>2.4</commons-io-version>
|
||||||
|
30
README.md
30
README.md
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
<div align="center">
|
<div align="center">
|
||||||
|
|
||||||
[Master](https://github.com/OpenAPITools/openapi-generator/tree/master) (`3.2.3`): [](https://travis-ci.org/OpenAPITools/openapi-generator)
|
[Master](https://github.com/OpenAPITools/openapi-generator/tree/master) (`3.3.0`): [](https://travis-ci.org/OpenAPITools/openapi-generator)
|
||||||
[](https://circleci.com/gh/OpenAPITools/openapi-generator)
|
[](https://circleci.com/gh/OpenAPITools/openapi-generator)
|
||||||
[](https://app.shippable.com/github/OpenAPITools/openapi-generator)
|
[](https://app.shippable.com/github/OpenAPITools/openapi-generator)
|
||||||
[](https://ci.appveyor.com/project/WilliamCheng/openapi-generator-wh2wu)
|
[](https://ci.appveyor.com/project/WilliamCheng/openapi-generator-wh2wu)
|
||||||
@ -42,8 +42,8 @@ OpenAPI Generator allows generation of API client libraries (SDK generation), se
|
|||||||
|
|
||||||
| | Languages/Frameworks |
|
| | Languages/Frameworks |
|
||||||
|-|-|
|
|-|-|
|
||||||
**API clients** | **ActionScript**, **Ada**, **Apex**, **Bash**, **C#** (.net 2.0, 3.5 or later), **C++** (cpprest, Qt5, Tizen), **Clojure**, **Dart**, **Elixir**, **Elm**, **Eiffel**, **Erlang**, **Go**, **Groovy**, **Haskell** (http-client, Servant), **Java** (Jersey1.x, Jersey2.x, OkHttp, Retrofit1.x, Retrofit2.x, Feign, RestTemplate, RESTEasy, Vertx, Google API Client Library for Java, Rest-assured), **Kotlin**, **Lua**, **Node.js** (ES5, ES6, AngularJS with Google Closure Compiler annotations, Flow types) **Objective-C**, **Perl**, **PHP**, **PowerShell**, **Python**, **R**, **Ruby**, **Rust** (rust, rust-server), **Scala** (akka, http4s, scalaz, swagger-async-httpclient), **Swift** (2.x, 3.x, 4.x), **Typescript** (AngularJS, Angular (2.x - 6.x), Aurelia, Fetch, Inversify, jQuery, Node)
|
**API clients** | **ActionScript**, **Ada**, **Apex**, **Bash**, **C#** (.net 2.0, 3.5 or later), **C++** (cpprest, Qt5, Tizen), **Clojure**, **Dart (1.x, 2.x)**, **Elixir**, **Elm**, **Eiffel**, **Erlang**, **Go**, **Groovy**, **Haskell** (http-client, Servant), **Java** (Jersey1.x, Jersey2.x, OkHttp, Retrofit1.x, Retrofit2.x, Feign, RestTemplate, RESTEasy, Vertx, Google API Client Library for Java, Rest-assured, Spring 5 Web Client), **Kotlin**, **Lua**, **Node.js** (ES5, ES6, AngularJS with Google Closure Compiler annotations, Flow types) **Objective-C**, **Perl**, **PHP**, **PowerShell**, **Python**, **R**, **Ruby**, **Rust** (rust, rust-server), **Scala** (akka, http4s, scalaz, swagger-async-httpclient), **Swift** (2.x, 3.x, 4.x), **Typescript** (AngularJS, Angular (2.x - 6.x), Aurelia, Fetch, Inversify, jQuery, Node)
|
||||||
**Server stubs** | **Ada**, **C#** (ASP.NET Core, NancyFx), **C++** (Pistache, Restbed), **Erlang**, **Go**, **Haskell** (Servant), **Java** (MSF4J, Spring, Undertow, JAX-RS: CDI, CXF, Inflector, RestEasy, Play Framework, [PKMST](https://github.com/ProKarma-Inc/pkmst-getting-started-examples)), **Kotlin**, **PHP** (Lumen, Slim, Silex, [Symfony](https://symfony.com/), [Zend Expressive](https://github.com/zendframework/zend-expressive)), **Python** (Flask), **NodeJS**, **Ruby** (Sinatra, Rails5), **Rust** (rust-server), **Scala** ([Finch](https://github.com/finagle/finch), [Lagom](https://github.com/lagom/lagom), Scalatra)
|
**Server stubs** | **Ada**, **C#** (ASP.NET Core, NancyFx), **C++** (Pistache, Restbed), **Erlang**, **Go**, **Haskell** (Servant), **Java** (MSF4J, Spring, Undertow, JAX-RS: CDI, CXF, Inflector, RestEasy, Play Framework, [PKMST](https://github.com/ProKarma-Inc/pkmst-getting-started-examples)), **Kotlin** (Spring Boot), **PHP** (Laravel, Lumen, Slim, Silex, [Symfony](https://symfony.com/), [Zend Expressive](https://github.com/zendframework/zend-expressive)), **Python** (Flask), **NodeJS**, **Ruby** (Sinatra, Rails5), **Rust** (rust-server), **Scala** ([Finch](https://github.com/finagle/finch), [Lagom](https://github.com/lagom/lagom), Scalatra)
|
||||||
**API documentation generators** | **HTML**, **Confluence Wiki**
|
**API documentation generators** | **HTML**, **Confluence Wiki**
|
||||||
**Configuration files** | [**Apache2**](https://httpd.apache.org/)
|
**Configuration files** | [**Apache2**](https://httpd.apache.org/)
|
||||||
**Others** | **JMeter**
|
**Others** | **JMeter**
|
||||||
@ -83,9 +83,8 @@ The OpenAPI Specification has undergone 3 revisions since initial creation in 20
|
|||||||
OpenAPI Generator Version | Release Date | Notes
|
OpenAPI Generator Version | Release Date | Notes
|
||||||
---------------------------- | ------------ | -----
|
---------------------------- | ------------ | -----
|
||||||
4.0.0 (upcoming major release) [SNAPSHOT](https://oss.sonatype.org/content/repositories/snapshots/org/openapitools/openapi-generator-cli/4.0.0-SNAPSHOT/)| TBD | Major release with breaking changes (no fallback)
|
4.0.0 (upcoming major release) [SNAPSHOT](https://oss.sonatype.org/content/repositories/snapshots/org/openapitools/openapi-generator-cli/4.0.0-SNAPSHOT/)| TBD | Major release with breaking changes (no fallback)
|
||||||
3.3.0 (upcoming minor release)| TBD | Minor release (breaking changes with fallbacks)
|
3.3.0 (current master, upcoming minor release) [SNAPSHOT](https://oss.sonatype.org/content/repositories/snapshots/org/openapitools/openapi-generator-cli/3.3.0-SNAPSHOT/) | 07.09.2018 | Minor release (breaking changes with fallbacks)
|
||||||
3.2.3 (current master, upcoming patch release) [SNAPSHOT](https://oss.sonatype.org/content/repositories/snapshots/org/openapitools/openapi-generator-cli/3.2.3-SNAPSHOT/)| TBD | Bugfix release
|
[3.2.3](https://github.com/OpenAPITools/openapi-generator/releases/tag/v3.2.3) (latest stable release) | 30.08.2018 | Bugfix release
|
||||||
[3.2.2](https://github.com/OpenAPITools/openapi-generator/releases/tag/v3.2.2) (latest stable release) | 22.08.2018 | Bugfix release
|
|
||||||
|
|
||||||
OpenAPI Spec compatibility: 1.0, 1.1, 1.2, 2.0, 3.0
|
OpenAPI Spec compatibility: 1.0, 1.1, 1.2, 2.0, 3.0
|
||||||
|
|
||||||
@ -141,16 +140,16 @@ See the different versions of the [openapi-generator-cli](https://mvnrepository.
|
|||||||
|
|
||||||
If you're looking for the latest stable version, you can grab it directly from Maven.org (Java 8 runtime at a minimum):
|
If you're looking for the latest stable version, you can grab it directly from Maven.org (Java 8 runtime at a minimum):
|
||||||
|
|
||||||
JAR location: `http://central.maven.org/maven2/org/openapitools/openapi-generator-cli/3.2.2/openapi-generator-cli-3.2.2.jar`
|
JAR location: `http://central.maven.org/maven2/org/openapitools/openapi-generator-cli/3.2.3/openapi-generator-cli-3.2.3.jar`
|
||||||
|
|
||||||
For **Mac/Linux** users:
|
For **Mac/Linux** users:
|
||||||
```sh
|
```sh
|
||||||
wget http://central.maven.org/maven2/org/openapitools/openapi-generator-cli/3.2.2/openapi-generator-cli-3.2.2.jar -O openapi-generator-cli.jar
|
wget http://central.maven.org/maven2/org/openapitools/openapi-generator-cli/3.2.3/openapi-generator-cli-3.2.3.jar -O openapi-generator-cli.jar
|
||||||
```
|
```
|
||||||
|
|
||||||
For **Windows** users, you will need to install [wget](http://gnuwin32.sourceforge.net/packages/wget.htm) or you can use Invoke-WebRequest in PowerShell (3.0+), e.g.
|
For **Windows** users, you will need to install [wget](http://gnuwin32.sourceforge.net/packages/wget.htm) or you can use Invoke-WebRequest in PowerShell (3.0+), e.g.
|
||||||
```
|
```
|
||||||
Invoke-WebRequest -OutFile openapi-generator-cli.jar http://central.maven.org/maven2/org/openapitools/openapi-generator-cli/3.2.2/openapi-generator-cli-3.2.2.jar
|
Invoke-WebRequest -OutFile openapi-generator-cli.jar http://central.maven.org/maven2/org/openapitools/openapi-generator-cli/3.2.3/openapi-generator-cli-3.2.3.jar
|
||||||
```
|
```
|
||||||
|
|
||||||
After downloading the JAR, run `java -jar openapi-generator-cli.jar help` to show the usage.
|
After downloading the JAR, run `java -jar openapi-generator-cli.jar help` to show the usage.
|
||||||
@ -469,13 +468,16 @@ Here are some companies/projects (alphabetical order) using OpenAPI Generator in
|
|||||||
|
|
||||||
- [Angular.Schule](https://angular.schule/)
|
- [Angular.Schule](https://angular.schule/)
|
||||||
- [Bithost GmbH](https://www.bithost.ch)
|
- [Bithost GmbH](https://www.bithost.ch)
|
||||||
|
- [Boxever](https://www.boxever.com/)
|
||||||
- [GMO Pepabo](https://pepabo.com/en/)
|
- [GMO Pepabo](https://pepabo.com/en/)
|
||||||
|
- [JustStar](https://www.juststarinfo.com)
|
||||||
- [Raiffeisen Schweiz Genossenschaft](https://www.raiffeisen.ch)
|
- [Raiffeisen Schweiz Genossenschaft](https://www.raiffeisen.ch)
|
||||||
- [RepreZen API Studio](https://www.reprezen.com/swagger-openapi-code-generation-api-first-microservices-enterprise-development)
|
- [RepreZen API Studio](https://www.reprezen.com/swagger-openapi-code-generation-api-first-microservices-enterprise-development)
|
||||||
- [REST United](https://restunited.com)
|
- [REST United](https://restunited.com)
|
||||||
- [Suva](https://www.suva.ch/)
|
- [Suva](https://www.suva.ch/)
|
||||||
- [Telstra](https://dev.telstra.com)
|
- [Telstra](https://dev.telstra.com)
|
||||||
- [unblu inc.](https://www.unblu.com/)
|
- [unblu inc.](https://www.unblu.com/)
|
||||||
|
- [Zalando](https://www.zalando.com)
|
||||||
|
|
||||||
## [5 - Presentations/Videos/Tutorials/Books](#table-of-contents)
|
## [5 - Presentations/Videos/Tutorials/Books](#table-of-contents)
|
||||||
|
|
||||||
@ -515,7 +517,8 @@ Here is a list of template creators:
|
|||||||
* C# (.NET 4.5 refactored): @jimschubert
|
* C# (.NET 4.5 refactored): @jimschubert
|
||||||
* Clojure: @xhh
|
* Clojure: @xhh
|
||||||
* Dart: @yissachar
|
* Dart: @yissachar
|
||||||
* Dart (refactored in 2.4.0): @joernahrens
|
* Dart (refactor): @joernahrens
|
||||||
|
* Dart 2: @swipesight
|
||||||
* Elixir: @niku
|
* Elixir: @niku
|
||||||
* Elm: @trenneman
|
* Elm: @trenneman
|
||||||
* Eiffel: @jvelilla
|
* Eiffel: @jvelilla
|
||||||
@ -576,6 +579,7 @@ Here is a list of template creators:
|
|||||||
* JAX-RS CXF (CDI): @nickcmaynard
|
* JAX-RS CXF (CDI): @nickcmaynard
|
||||||
* JAX-RS RestEasy (JBoss EAP): @jfiala
|
* JAX-RS RestEasy (JBoss EAP): @jfiala
|
||||||
* Kotlin: @jimschubert
|
* Kotlin: @jimschubert
|
||||||
|
* Kotlin (Spring Boot): @dr4ke616
|
||||||
* PHP Laravel: @renepardon
|
* PHP Laravel: @renepardon
|
||||||
* PHP Lumen: @abcsun
|
* PHP Lumen: @abcsun
|
||||||
* PHP Slim: @jfastnacht
|
* PHP Slim: @jfastnacht
|
||||||
@ -630,16 +634,16 @@ If you want to join the committee, please kindly apply by sending an email to te
|
|||||||
| C++ | @ravinikam (2017/07) @stkrwork (2017/07) @fvarose (2017/11) @etherealjoy (2018/02) @martindelille (2018/03) |
|
| C++ | @ravinikam (2017/07) @stkrwork (2017/07) @fvarose (2017/11) @etherealjoy (2018/02) @martindelille (2018/03) |
|
||||||
| C# | @mandrean (2017/08) @jimschubert (2017/09) |
|
| C# | @mandrean (2017/08) @jimschubert (2017/09) |
|
||||||
| Clojure | |
|
| Clojure | |
|
||||||
| Dart | @ircecho (2017/07) |
|
| Dart | @ircecho (2017/07) @swipesight (2018/09) |
|
||||||
| Eiffel | @jvelilla (2017/09) |
|
| Eiffel | @jvelilla (2017/09) |
|
||||||
| Elixir | |
|
| Elixir | |
|
||||||
| Elm | |
|
| Elm | @trenneman (2018/09) |
|
||||||
| Erlang | @tsloughter (2017/11) |
|
| Erlang | @tsloughter (2017/11) |
|
||||||
| Go | @antihax (2017/11) @bvwells (2017/12) @grokify (2018/07) |
|
| Go | @antihax (2017/11) @bvwells (2017/12) @grokify (2018/07) |
|
||||||
| Groovy | |
|
| Groovy | |
|
||||||
| Haskell | |
|
| Haskell | |
|
||||||
| Java | @bbdouglas (2017/07) @JFCote (2017/08) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) |
|
| Java | @bbdouglas (2017/07) @JFCote (2017/08) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) |
|
||||||
| Kotlin | @jimschubert (2017/09) |
|
| Kotlin | @jimschubert (2017/09) @dr4ke616 (2018/08) |
|
||||||
| Lua | @daurnimator (2017/08) |
|
| Lua | @daurnimator (2017/08) |
|
||||||
| NodeJS/Javascript | @CodeNinjai (2017/07) @frol (2017/07) @cliffano (2017/07) |
|
| NodeJS/Javascript | @CodeNinjai (2017/07) @frol (2017/07) @cliffano (2017/07) |
|
||||||
| ObjC | |
|
| ObjC | |
|
||||||
|
42
bin/dart-jaguar-petstore.sh
Executable file
42
bin/dart-jaguar-petstore.sh
Executable file
@ -0,0 +1,42 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
|
||||||
|
SCRIPT="$0"
|
||||||
|
|
||||||
|
while [ -h "$SCRIPT" ] ; do
|
||||||
|
ls=`ls -ld "$SCRIPT"`
|
||||||
|
link=`expr "$ls" : '.*-> \(.*\)$'`
|
||||||
|
if expr "$link" : '/.*' > /dev/null; then
|
||||||
|
SCRIPT="$link"
|
||||||
|
else
|
||||||
|
SCRIPT=`dirname "$SCRIPT"`/"$link"
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
|
||||||
|
if [ ! -d "${APP_DIR}" ]; then
|
||||||
|
APP_DIR=`dirname "$SCRIPT"`/..
|
||||||
|
APP_DIR=`cd "${APP_DIR}"; pwd`
|
||||||
|
fi
|
||||||
|
|
||||||
|
executable="./modules/openapi-generator-cli/target/openapi-generator-cli.jar"
|
||||||
|
|
||||||
|
if [ ! -f "$executable" ]
|
||||||
|
then
|
||||||
|
mvn clean package
|
||||||
|
fi
|
||||||
|
|
||||||
|
# if you've executed sbt assembly previously it will use that instead.
|
||||||
|
export JAVA_OPTS="${JAVA_OPTS} -XX:MaxPermSize=256M -Xmx1024M -DloggerPath=conf/log4j.properties"
|
||||||
|
|
||||||
|
# Generate client
|
||||||
|
ags="$@ generate -t modules/openapi-generator/src/main/resources/dart-jaguar -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -l dart-jaguar -o samples/client/petstore/dart-jaguar/openapi -DhideGenerationTimestamp=true -DpubName=openapi"
|
||||||
|
java $JAVA_OPTS -jar $executable $ags
|
||||||
|
|
||||||
|
# Generate non-browserClient and put it to the flutter sample app
|
||||||
|
ags="$@ generate -t modules/openapi-generator/src/main/resources/dart-jaguar -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -l dart-jaguar -o samples/client/petstore/dart-jaguar/flutter_petstore/openapi -DhideGenerationTimestamp=true -DpubName=openapi"
|
||||||
|
java $JAVA_OPTS -jar $executable $ags
|
||||||
|
|
||||||
|
# There is a proposal to allow importing different libraries depending on the environment:
|
||||||
|
# https://github.com/munificent/dep-interface-libraries
|
||||||
|
# When this is implemented there will only be one library.
|
||||||
|
|
||||||
|
# The current petstore test will then work for both: the browser library and the vm library.
|
@ -29,18 +29,18 @@ fi
|
|||||||
export JAVA_OPTS="${JAVA_OPTS} -XX:MaxPermSize=256M -Xmx1024M -DloggerPath=conf/log4j.properties"
|
export JAVA_OPTS="${JAVA_OPTS} -XX:MaxPermSize=256M -Xmx1024M -DloggerPath=conf/log4j.properties"
|
||||||
|
|
||||||
# Generate non-browserClient
|
# Generate non-browserClient
|
||||||
ags="generate -t modules/openapi-generator/src/main/resources/dart -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g dart -o samples/client/petstore/dart/openapi -DhideGenerationTimestamp=true -DbrowserClient=false $@"
|
ags="generate -t modules/openapi-generator/src/main/resources/dart -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g dart -o samples/client/petstore/dart/openapi -DhideGenerationTimestamp=true -DbrowserClient=false --additional-properties supportDart2=false $@"
|
||||||
|
|
||||||
# then options to generate the library for vm would be:
|
# then options to generate the library for vm would be:
|
||||||
#ags="generate -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g dart -o samples/client/petstore/dart/openapi_vm -DbrowserClient=false -DpubName=openapi_vm $@"
|
#ags="generate -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g dart -o samples/client/petstore/dart/openapi_vm -DbrowserClient=false -DpubName=openapi_vm --additional-properties supportDart2=false $@"
|
||||||
java $JAVA_OPTS -jar $executable $ags
|
java $JAVA_OPTS -jar $executable $ags
|
||||||
|
|
||||||
# Generate browserClient
|
# Generate browserClient
|
||||||
ags="generate -t modules/openapi-generator/src/main/resources/dart -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g dart -o samples/client/petstore/dart/openapi-browser-client -DhideGenerationTimestamp=true -DbrowserClient=true $@"
|
ags="generate -t modules/openapi-generator/src/main/resources/dart -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g dart -o samples/client/petstore/dart/openapi-browser-client -DhideGenerationTimestamp=true -DbrowserClient=true --additional-properties supportDart2=false $@"
|
||||||
java $JAVA_OPTS -jar $executable $ags
|
java $JAVA_OPTS -jar $executable $ags
|
||||||
|
|
||||||
# Generate non-browserClient and put it to the flutter sample app
|
# Generate non-browserClient and put it to the flutter sample app
|
||||||
ags="generate -t modules/openapi-generator/src/main/resources/dart -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g dart -o samples/client/petstore/dart/flutter_petstore/openapi -DhideGenerationTimestamp=true -DbrowserClient=false $@"
|
ags="generate -t modules/openapi-generator/src/main/resources/dart -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g dart -o samples/client/petstore/dart/flutter_petstore/openapi -DhideGenerationTimestamp=true -DbrowserClient=false --additional-properties supportDart2=false $@"
|
||||||
java $JAVA_OPTS -jar $executable $ags
|
java $JAVA_OPTS -jar $executable $ags
|
||||||
|
|
||||||
# There is a proposal to allow importing different libraries depending on the environment:
|
# There is a proposal to allow importing different libraries depending on the environment:
|
||||||
|
50
bin/dart2-petstore.sh
Executable file
50
bin/dart2-petstore.sh
Executable file
@ -0,0 +1,50 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
|
||||||
|
SCRIPT="$0"
|
||||||
|
echo "# START SCRIPT: $SCRIPT"
|
||||||
|
|
||||||
|
while [ -h "$SCRIPT" ] ; do
|
||||||
|
ls=`ls -ld "$SCRIPT"`
|
||||||
|
link=`expr "$ls" : '.*-> \(.*\)$'`
|
||||||
|
if expr "$link" : '/.*' > /dev/null; then
|
||||||
|
SCRIPT="$link"
|
||||||
|
else
|
||||||
|
SCRIPT=`dirname "$SCRIPT"`/"$link"
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
|
||||||
|
if [ ! -d "${APP_DIR}" ]; then
|
||||||
|
APP_DIR=`dirname "$SCRIPT"`/..
|
||||||
|
APP_DIR=`cd "${APP_DIR}"; pwd`
|
||||||
|
fi
|
||||||
|
|
||||||
|
executable="./modules/openapi-generator-cli/target/openapi-generator-cli.jar"
|
||||||
|
|
||||||
|
if [ ! -f "$executable" ]
|
||||||
|
then
|
||||||
|
mvn -B clean package
|
||||||
|
fi
|
||||||
|
|
||||||
|
# if you've executed sbt assembly previously it will use that instead.
|
||||||
|
export JAVA_OPTS="${JAVA_OPTS} -XX:MaxPermSize=256M -Xmx1024M -DloggerPath=conf/log4j.properties"
|
||||||
|
|
||||||
|
# Generate non-browserClient
|
||||||
|
ags="generate -t modules/openapi-generator/src/main/resources/dart -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g dart -o samples/client/petstore/dart2/openapi -DhideGenerationTimestamp=true -DbrowserClient=false $@"
|
||||||
|
|
||||||
|
# then options to generate the library for vm would be:
|
||||||
|
#ags="generate -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g dart -o samples/client/petstore/dart2/openapi_vm -DbrowserClient=false -DpubName=openapi_vm $@"
|
||||||
|
java $JAVA_OPTS -jar $executable $ags
|
||||||
|
|
||||||
|
# Generate browserClient
|
||||||
|
ags="generate -t modules/openapi-generator/src/main/resources/dart -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g dart -o samples/client/petstore/dart2/openapi-browser-client -DhideGenerationTimestamp=true -DbrowserClient=true $@"
|
||||||
|
java $JAVA_OPTS -jar $executable $ags
|
||||||
|
|
||||||
|
# Generate non-browserClient and put it to the flutter sample app
|
||||||
|
ags="generate -t modules/openapi-generator/src/main/resources/dart -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g dart -o samples/client/petstore/dart2/flutter_petstore/openapi -DhideGenerationTimestamp=true -DbrowserClient=false $@"
|
||||||
|
java $JAVA_OPTS -jar $executable $ags
|
||||||
|
|
||||||
|
# There is a proposal to allow importing different libraries depending on the environment:
|
||||||
|
# https://github.com/munificent/dep-interface-libraries
|
||||||
|
# When this is implemented there will only be one library.
|
||||||
|
|
||||||
|
# The current petstore test will then work for both: the browser library and the vm library.
|
32
bin/elm-0.18-petstore.sh
Executable file
32
bin/elm-0.18-petstore.sh
Executable file
@ -0,0 +1,32 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
|
||||||
|
SCRIPT="$0"
|
||||||
|
echo "# START SCRIPT: $SCRIPT"
|
||||||
|
|
||||||
|
while [ -h "$SCRIPT" ] ; do
|
||||||
|
ls=`ls -ld "$SCRIPT"`
|
||||||
|
link=`expr "$ls" : '.*-> \(.*\)$'`
|
||||||
|
if expr "$link" : '/.*' > /dev/null; then
|
||||||
|
SCRIPT="$link"
|
||||||
|
else
|
||||||
|
SCRIPT=`dirname "$SCRIPT"`/"$link"
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
|
||||||
|
if [ ! -d "${APP_DIR}" ]; then
|
||||||
|
APP_DIR=`dirname "$SCRIPT"`/..
|
||||||
|
APP_DIR=`cd "${APP_DIR}"; pwd`
|
||||||
|
fi
|
||||||
|
|
||||||
|
executable="./modules/openapi-generator-cli/target/openapi-generator-cli.jar"
|
||||||
|
|
||||||
|
if [ ! -f "$executable" ]
|
||||||
|
then
|
||||||
|
mvn -B clean package
|
||||||
|
fi
|
||||||
|
|
||||||
|
# if you've executed sbt assembly previously it will use that instead.
|
||||||
|
export JAVA_OPTS="${JAVA_OPTS} -XX:MaxPermSize=256M -Xmx1024M -DloggerPath=conf/log4j.properties"
|
||||||
|
ags="generate -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g elm -t modules/openapi-generator/src/main/resources/elm -o samples/client/petstore/elm-0.18 --additional-properties elmVersion=0.18 $@"
|
||||||
|
|
||||||
|
java $JAVA_OPTS -jar $executable $ags
|
5
bin/elm-petstore-all.sh
Executable file
5
bin/elm-petstore-all.sh
Executable file
@ -0,0 +1,5 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
|
||||||
|
./bin/elm-0.18-petstore.sh
|
||||||
|
./bin/elm-petstore.sh
|
||||||
|
|
@ -4,6 +4,7 @@
|
|||||||
./bin/java-petstore-jersey1.sh
|
./bin/java-petstore-jersey1.sh
|
||||||
./bin/java-petstore-jersey2.sh
|
./bin/java-petstore-jersey2.sh
|
||||||
./bin/java-petstore-feign.sh
|
./bin/java-petstore-feign.sh
|
||||||
|
./bin/java-petstore-feign-10x.sh
|
||||||
./bin/java-petstore-okhttp-gson.sh
|
./bin/java-petstore-okhttp-gson.sh
|
||||||
./bin/java-petstore-okhttp-gson-parcelable.sh
|
./bin/java-petstore-okhttp-gson-parcelable.sh
|
||||||
./bin/java-petstore-retrofit.sh
|
./bin/java-petstore-retrofit.sh
|
||||||
@ -13,6 +14,7 @@
|
|||||||
./bin/java8-petstore-jersey2.sh
|
./bin/java8-petstore-jersey2.sh
|
||||||
./bin/java-petstore-retrofit2-play24.sh
|
./bin/java-petstore-retrofit2-play24.sh
|
||||||
./bin/java-petstore-retrofit2-play25.sh
|
./bin/java-petstore-retrofit2-play25.sh
|
||||||
|
./bin/java-petstore-retrofit2-play26.sh
|
||||||
./bin/java-petstore-jersey2-java6.sh
|
./bin/java-petstore-jersey2-java6.sh
|
||||||
./bin/java-petstore-resttemplate.sh
|
./bin/java-petstore-resttemplate.sh
|
||||||
./bin/java-petstore-resttemplate-withxml.sh
|
./bin/java-petstore-resttemplate-withxml.sh
|
||||||
|
5
bin/java-petstore-feign-10x.json
Normal file
5
bin/java-petstore-feign-10x.json
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
{
|
||||||
|
"library": "feign",
|
||||||
|
"artifactId": "petstore-feign-10x",
|
||||||
|
"feignVersion": "10.x"
|
||||||
|
}
|
40
bin/java-petstore-feign-10x.sh
Executable file
40
bin/java-petstore-feign-10x.sh
Executable file
@ -0,0 +1,40 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
|
||||||
|
SCRIPT="$0"
|
||||||
|
echo "# START SCRIPT: $SCRIPT"
|
||||||
|
|
||||||
|
while [ -h "$SCRIPT" ] ; do
|
||||||
|
ls=`ls -ld "$SCRIPT"`
|
||||||
|
link=`expr "$ls" : '.*-> \(.*\)$'`
|
||||||
|
if expr "$link" : '/.*' > /dev/null; then
|
||||||
|
SCRIPT="$link"
|
||||||
|
else
|
||||||
|
SCRIPT=`dirname "$SCRIPT"`/"$link"
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
|
||||||
|
if [ ! -d "${APP_DIR}" ]; then
|
||||||
|
APP_DIR=`dirname "$SCRIPT"`/..
|
||||||
|
APP_DIR=`cd "${APP_DIR}"; pwd`
|
||||||
|
fi
|
||||||
|
|
||||||
|
executable="./modules/openapi-generator-cli/target/openapi-generator-cli.jar"
|
||||||
|
|
||||||
|
if [ ! -f "$executable" ]
|
||||||
|
then
|
||||||
|
mvn -B clean package
|
||||||
|
fi
|
||||||
|
|
||||||
|
# if you've executed sbt assembly previously it will use that instead.
|
||||||
|
export JAVA_OPTS="${JAVA_OPTS} -XX:MaxPermSize=256M -Xmx1024M -DloggerPath=conf/log4j.properties"
|
||||||
|
ags="generate -t modules/openapi-generator/src/main/resources/Java/libraries/feign -i modules/openapi-generator/src/test/resources/2_0/petstore-with-fake-endpoints-models-for-testing.yaml -g java -c bin/java-petstore-feign-10x.json -o samples/client/petstore/java/feign10x -DhideGenerationTimestamp=true -DbooleanGetterPrefix=is $@"
|
||||||
|
|
||||||
|
echo "Removing files and folders under samples/client/petstore/java/feign10x/src/main"
|
||||||
|
rm -rf samples/client/petstore/java/feign10x/src/main
|
||||||
|
find samples/client/petstore/java/feign10x -maxdepth 1 -type f ! -name "README.md" -exec rm {} +
|
||||||
|
java $JAVA_OPTS -jar $executable $ags
|
||||||
|
|
||||||
|
# copy additional manually written unit-tests
|
||||||
|
mkdir samples/client/petstore/java/feign10x/src/test/java/org/openapitools/client
|
||||||
|
|
||||||
|
cp CI/samples.ci/client/petstore/java/test-manual/common/StringUtilTest.java samples/client/petstore/java/feign10x/src/test/java/org/openapitools/client/StringUtilTest.java
|
5
bin/java-petstore-feign-9x.json
Normal file
5
bin/java-petstore-feign-9x.json
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
{
|
||||||
|
"library": "feign",
|
||||||
|
"artifactId": "petstore-feign",
|
||||||
|
"feignVersion": "9.x"
|
||||||
|
}
|
@ -1,4 +1,5 @@
|
|||||||
{
|
{
|
||||||
"library": "feign",
|
"library": "feign",
|
||||||
"artifactId": "petstore-feign"
|
"artifactId": "petstore-feign",
|
||||||
|
"feignVersion": "10.x"
|
||||||
}
|
}
|
||||||
|
@ -27,7 +27,7 @@ fi
|
|||||||
|
|
||||||
# if you've executed sbt assembly previously it will use that instead.
|
# if you've executed sbt assembly previously it will use that instead.
|
||||||
export JAVA_OPTS="${JAVA_OPTS} -XX:MaxPermSize=256M -Xmx1024M -DloggerPath=conf/log4j.properties"
|
export JAVA_OPTS="${JAVA_OPTS} -XX:MaxPermSize=256M -Xmx1024M -DloggerPath=conf/log4j.properties"
|
||||||
ags="generate -t modules/openapi-generator/src/main/resources/Java/libraries/feign -i modules/openapi-generator/src/test/resources/2_0/petstore-with-fake-endpoints-models-for-testing.yaml -g java -c bin/java-petstore-feign.json -o samples/client/petstore/java/feign -DhideGenerationTimestamp=true -DbooleanGetterPrefix=is $@"
|
ags="generate -t modules/openapi-generator/src/main/resources/Java/libraries/feign -i modules/openapi-generator/src/test/resources/2_0/petstore-with-fake-endpoints-models-for-testing.yaml -g java -c bin/java-petstore-feign-9x.json -o samples/client/petstore/java/feign -DhideGenerationTimestamp=true -DbooleanGetterPrefix=is $@"
|
||||||
|
|
||||||
echo "Removing files and folders under samples/client/petstore/java/feign/src/main"
|
echo "Removing files and folders under samples/client/petstore/java/feign/src/main"
|
||||||
rm -rf samples/client/petstore/java/feign/src/main
|
rm -rf samples/client/petstore/java/feign/src/main
|
||||||
@ -37,4 +37,4 @@ java $JAVA_OPTS -jar $executable $ags
|
|||||||
# copy additional manually written unit-tests
|
# copy additional manually written unit-tests
|
||||||
mkdir samples/client/petstore/java/feign/src/test/java/org/openapitools/client
|
mkdir samples/client/petstore/java/feign/src/test/java/org/openapitools/client
|
||||||
|
|
||||||
cp CI/samples.ci/client/petstore/java/test-manual/common/StringUtilTest.java samples/client/petstore/java/feign/src/test/java/org/openapitools/client/StringUtilTest.java
|
cp CI/samples.ci/client/petstore/java/test-manual/common/StringUtilTest.java samples/client/petstore/java/feign/src/test/java/org/openapitools/client/StringUtilTest.java
|
||||||
|
1
bin/java-petstore-retrofit2-play26.json
Normal file
1
bin/java-petstore-retrofit2-play26.json
Normal file
@ -0,0 +1 @@
|
|||||||
|
{"useBeanValidation":"true","enableBuilderSupport":"true","library":"retrofit2","usePlayWS":"true","playVersion":"play26"}
|
35
bin/java-petstore-retrofit2-play26.sh
Executable file
35
bin/java-petstore-retrofit2-play26.sh
Executable file
@ -0,0 +1,35 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
|
||||||
|
SCRIPT="$0"
|
||||||
|
echo "# START SCRIPT: $SCRIPT"
|
||||||
|
|
||||||
|
while [ -h "$SCRIPT" ] ; do
|
||||||
|
ls=`ls -ld "$SCRIPT"`
|
||||||
|
link=`expr "$ls" : '.*-> \(.*\)$'`
|
||||||
|
if expr "$link" : '/.*' > /dev/null; then
|
||||||
|
SCRIPT="$link"
|
||||||
|
else
|
||||||
|
SCRIPT=`dirname "$SCRIPT"`/"$link"
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
|
||||||
|
if [ ! -d "${APP_DIR}" ]; then
|
||||||
|
APP_DIR=`dirname "$SCRIPT"`/..
|
||||||
|
APP_DIR=`cd "${APP_DIR}"; pwd`
|
||||||
|
fi
|
||||||
|
|
||||||
|
executable="./modules/openapi-generator-cli/target/openapi-generator-cli.jar"
|
||||||
|
|
||||||
|
if [ ! -f "$executable" ]
|
||||||
|
then
|
||||||
|
mvn -B clean package
|
||||||
|
fi
|
||||||
|
|
||||||
|
# if you've executed sbt assembly previously it will use that instead.
|
||||||
|
export JAVA_OPTS="${JAVA_OPTS} -XX:MaxPermSize=256M -Xmx1024M -DloggerPath=conf/log4j.properties"
|
||||||
|
ags="generate --artifact-id petstore-java-client-retrofit2-play26 -i modules/openapi-generator/src/test/resources/2_0/petstore-with-fake-endpoints-models-for-testing.yaml -g java -c bin/java-petstore-retrofit2-play26.json -o samples/client/petstore/java/retrofit2-play26 -DhideGenerationTimestamp=true $@"
|
||||||
|
|
||||||
|
echo "Removing files and folders under samples/client/petstore/java/retrofit2-play26/src/main"
|
||||||
|
rm -rf samples/client/petstore/java/retrofit2-play26/src/main
|
||||||
|
find samples/client/petstore/java/retrofit2-play26 -maxdepth 1 -type f ! -name "README.md" -exec rm {} +
|
||||||
|
java $JAVA_OPTS -jar $executable $ags
|
35
bin/kotlin-springboot-petstore-server.sh
Executable file
35
bin/kotlin-springboot-petstore-server.sh
Executable file
@ -0,0 +1,35 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
|
||||||
|
SCRIPT="$0"
|
||||||
|
echo "# START SCRIPT: $SCRIPT"
|
||||||
|
|
||||||
|
while [ -h "$SCRIPT" ] ; do
|
||||||
|
ls=$(ls -ld "$SCRIPT")
|
||||||
|
link=$(expr "$ls" : '.*-> \(.*\)$')
|
||||||
|
if expr "$link" : '/.*' > /dev/null; then
|
||||||
|
SCRIPT="$link"
|
||||||
|
else
|
||||||
|
SCRIPT=$(dirname "$SCRIPT")/"$link"
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
|
||||||
|
if [ ! -d "${APP_DIR}" ]; then
|
||||||
|
APP_DIR=$(dirname "$SCRIPT")/..
|
||||||
|
APP_DIR=$(cd "${APP_DIR}"; pwd)
|
||||||
|
fi
|
||||||
|
|
||||||
|
executable="./modules/openapi-generator-cli/target/openapi-generator-cli.jar"
|
||||||
|
|
||||||
|
if [ ! -f "$executable" ]
|
||||||
|
then
|
||||||
|
mvn clean package
|
||||||
|
fi
|
||||||
|
|
||||||
|
export JAVA_OPTS="${JAVA_OPTS} -XX:MaxPermSize=256M -Xmx1024M -DloggerPath=conf/log4j.properties"
|
||||||
|
ags="$@ generate -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -t modules/openapi-generator/src/main/resources/kotlin-spring -g kotlin-spring -o samples/server/petstore/kotlin-springboot --additional-properties=library=spring-boot,beanValidations=true,swaggerAnnotations=true,serviceImplementation=true"
|
||||||
|
|
||||||
|
echo "Cleaning previously generated files if any from samples/server/petstore/kotlin-springboot"
|
||||||
|
rm -rf samples/server/petstore/kotlin-springboot
|
||||||
|
|
||||||
|
echo "Generating Kotling Spring Boot server..."
|
||||||
|
java $JAVA_OPTS -jar $executable $ags
|
@ -26,11 +26,11 @@ then
|
|||||||
fi
|
fi
|
||||||
|
|
||||||
export JAVA_OPTS="${JAVA_OPTS} -XX:MaxPermSize=256M -Xmx1024M -DloggerPath=conf/log4j.properties"
|
export JAVA_OPTS="${JAVA_OPTS} -XX:MaxPermSize=256M -Xmx1024M -DloggerPath=conf/log4j.properties"
|
||||||
ags="meta -n myClientCodegen -p com.my.company.codegen -o samples/meta-codegen/lib $@"
|
ags="meta -n myClientCodegen -t DOCUMENTATION -p com.my.company.codegen -o samples/meta-codegen/lib $@"
|
||||||
|
|
||||||
java $JAVA_OPTS -jar $executable $ags
|
java $JAVA_OPTS -jar $executable $ags
|
||||||
|
|
||||||
mvn verify -f samples/meta-codegen/lib/pom.xml
|
mvn clean package -f samples/meta-codegen/pom.xml
|
||||||
|
|
||||||
ags2="generate -g myClientCodegen -i modules/openapi-generator/src/test/resources/2_0/petstore.json -o samples/meta-codegen/usage $@"
|
ags2="generate -g myClientCodegen -i modules/openapi-generator/src/test/resources/2_0/petstore.json -o samples/meta-codegen/usage $@"
|
||||||
|
|
||||||
|
0
bin/openapi3/jaxrs-jersey-petstore.sh
Normal file → Executable file
0
bin/openapi3/jaxrs-jersey-petstore.sh
Normal file → Executable file
35
bin/openapi3/kotlin-springboot-petstore-server.sh
Executable file
35
bin/openapi3/kotlin-springboot-petstore-server.sh
Executable file
@ -0,0 +1,35 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
|
||||||
|
SCRIPT="$0"
|
||||||
|
echo "# START SCRIPT: $SCRIPT"
|
||||||
|
|
||||||
|
while [ -h "$SCRIPT" ] ; do
|
||||||
|
ls=$(ls -ld "$SCRIPT")
|
||||||
|
link=$(expr "$ls" : '.*-> \(.*\)$')
|
||||||
|
if expr "$link" : '/.*' > /dev/null; then
|
||||||
|
SCRIPT="$link"
|
||||||
|
else
|
||||||
|
SCRIPT=$(dirname "$SCRIPT")/"$link"
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
|
||||||
|
if [ ! -d "${APP_DIR}" ]; then
|
||||||
|
APP_DIR=$(dirname "$SCRIPT")/..
|
||||||
|
APP_DIR=$(cd "${APP_DIR}"; pwd)
|
||||||
|
fi
|
||||||
|
|
||||||
|
executable="./modules/openapi-generator-cli/target/openapi-generator-cli.jar"
|
||||||
|
|
||||||
|
if [ ! -f "$executable" ]
|
||||||
|
then
|
||||||
|
mvn clean package
|
||||||
|
fi
|
||||||
|
|
||||||
|
export JAVA_OPTS="${JAVA_OPTS} -XX:MaxPermSize=256M -Xmx1024M -DloggerPath=conf/log4j.properties"
|
||||||
|
ags="$@ generate -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml -t modules/openapi-generator/src/main/resources/kotlin-spring -g kotlin-spring -o samples/server/openapi3/petstore/kotlin-springboot --additional-properties=library=spring-boot,beanValidations=true,swaggerAnnotations=true,serviceImplementation=true"
|
||||||
|
|
||||||
|
echo "Cleaning previously generated files if any from samples/server/openapi3/petstore/kotlin-springboot"
|
||||||
|
rm -rf samples/server/openapi3/petstore/kotlin-springboot
|
||||||
|
|
||||||
|
echo "Generating Kotling Spring Boot server..."
|
||||||
|
java $JAVA_OPTS -jar $executable $ags
|
@ -33,6 +33,6 @@ fi
|
|||||||
|
|
||||||
# if you've executed sbt assembly previously it will use that instead.
|
# if you've executed sbt assembly previously it will use that instead.
|
||||||
export JAVA_OPTS="${JAVA_OPTS} -XX:MaxPermSize=256M -Xmx1024M -DloggerPath=conf/log4j.properties"
|
export JAVA_OPTS="${JAVA_OPTS} -XX:MaxPermSize=256M -Xmx1024M -DloggerPath=conf/log4j.properties"
|
||||||
ags="generate -t modules/openapi-generator/src/main/resources/php -i modules/openapi-generator/src/test/resources/2_0/petstore-security-test.yaml -g php -o samples/client/petstore-security-test/php $@"
|
ags="generate -t modules/openapi-generator/src/main/resources/php -i modules/openapi-generator/src/test/resources/2_0/petstore-security-test.yaml -g php -o samples/client/petstore-security-test/php/OpenAPIClient-php $@"
|
||||||
|
|
||||||
java $JAVA_OPTS -jar $executable $ags
|
java $JAVA_OPTS -jar $executable $ags
|
||||||
|
@ -17,3 +17,4 @@
|
|||||||
./bin/springboot-petstore-server-beanvalidation.sh
|
./bin/springboot-petstore-server-beanvalidation.sh
|
||||||
./bin/springboot-petstore-server-implicitHeaders.sh
|
./bin/springboot-petstore-server-implicitHeaders.sh
|
||||||
./bin/springboot-petstore-server-useOptional.sh
|
./bin/springboot-petstore-server-useOptional.sh
|
||||||
|
./bin/springboot-virtualan-petstore-server.sh
|
@ -26,7 +26,7 @@ fi
|
|||||||
|
|
||||||
# if you've executed sbt assembly previously it will use that instead.
|
# if you've executed sbt assembly previously it will use that instead.
|
||||||
export JAVA_OPTS="${JAVA_OPTS} -XX:MaxPermSize=256M -Xmx1024M -DloggerPath=conf/log4j.properties"
|
export JAVA_OPTS="${JAVA_OPTS} -XX:MaxPermSize=256M -Xmx1024M -DloggerPath=conf/log4j.properties"
|
||||||
ags="generate --artifact-id springboot-reactive -t modules/openapi-generator/src/main/resources/JavaSpring -i modules/openapi-generator/src/test/resources/2_0/petstore-with-fake-endpoints-models-for-testing.yaml -g spring -o samples/server/petstore/springboot-reactive -Dreactive=true,hideGenerationTimestamp=true $@"
|
ags="generate --artifact-id springboot-reactive -t modules/openapi-generator/src/main/resources/JavaSpring -i modules/openapi-generator/src/test/resources/2_0/petstore-with-fake-endpoints-models-for-testing.yaml -g spring -o samples/server/petstore/springboot-reactive -Dreactive=true,delegatePattern=true,hideGenerationTimestamp=true $@"
|
||||||
|
|
||||||
echo "Removing files and folders under samples/server/petstore/springboot-reactive/src/main"
|
echo "Removing files and folders under samples/server/petstore/springboot-reactive/src/main"
|
||||||
rm -rf samples/server/petstore/springboot-reactive/src/main
|
rm -rf samples/server/petstore/springboot-reactive/src/main
|
||||||
|
7
bin/springboot-virtualan-petstore-server.json
Normal file
7
bin/springboot-virtualan-petstore-server.json
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
{
|
||||||
|
"artifactId": "springboot-virtualan",
|
||||||
|
"library": "spring-boot",
|
||||||
|
"virtualService": true,
|
||||||
|
"modelPackage" : "org.openapitools.virtualan.model",
|
||||||
|
"apiPackage" : "org.openapitools.virtualan.api"
|
||||||
|
}
|
35
bin/springboot-virtualan-petstore-server.sh
Normal file
35
bin/springboot-virtualan-petstore-server.sh
Normal file
@ -0,0 +1,35 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
|
||||||
|
SCRIPT="$0"
|
||||||
|
echo "# START SCRIPT: $SCRIPT"
|
||||||
|
|
||||||
|
while [ -h "$SCRIPT" ] ; do
|
||||||
|
ls=`ls -ld "$SCRIPT"`
|
||||||
|
link=`expr "$ls" : '.*-> \(.*\)$'`
|
||||||
|
if expr "$link" : '/.*' > /dev/null; then
|
||||||
|
SCRIPT="$link"
|
||||||
|
else
|
||||||
|
SCRIPT=`dirname "$SCRIPT"`/"$link"
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
|
||||||
|
if [ ! -d "${APP_DIR}" ]; then
|
||||||
|
APP_DIR=`dirname "$SCRIPT"`/..
|
||||||
|
APP_DIR=`cd "${APP_DIR}"; pwd`
|
||||||
|
fi
|
||||||
|
|
||||||
|
executable="./modules/openapi-generator-cli/target/openapi-generator-cli.jar"
|
||||||
|
|
||||||
|
if [ ! -f "$executable" ]
|
||||||
|
then
|
||||||
|
mvn -B clean package
|
||||||
|
fi
|
||||||
|
|
||||||
|
# if you've executed sbt assembly previously it will use that instead.
|
||||||
|
export JAVA_OPTS="${JAVA_OPTS} -XX:MaxPermSize=256M -Xmx1024M -DloggerPath=conf/log4j.properties"
|
||||||
|
ags="generate --artifact-id springboot-virtualan -t modules/openapi-generator/src/main/resources/JavaSpring -i modules/openapi-generator/src/test/resources/2_0/petstore-with-fake-endpoints-models-for-testing.yaml -g spring -o samples/server/petstore/springboot-virtualan -c bin/springboot-virtualan-petstore-server.json -DhideGenerationTimestamp=true $@"
|
||||||
|
|
||||||
|
echo "Removing files and folders under samples/server/petstore/springboot-virtualan/src/main"
|
||||||
|
rm -rf samples/server/petstore/springboot-virtualan/src/main
|
||||||
|
find samples/server/petstore/springboot-virtualan -maxdepth 1 -type f ! -name "README.md" -exec rm {} +
|
||||||
|
java $JAVA_OPTS -jar $executable $ags
|
33
bin/tests/run-all-test
Executable file
33
bin/tests/run-all-test
Executable file
@ -0,0 +1,33 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
# this bash script will loop through all the .sh files under bin/tests
|
||||||
|
# execute the script and check the result (exit code) to see if
|
||||||
|
# there's any error
|
||||||
|
|
||||||
|
echo "IMPORTANT: this script should be run by the CI (e.g. Shippable) only. There's no need to run this script manually."
|
||||||
|
echo "Please press CTRL+C to stop or the script will continue in 10 seconds."
|
||||||
|
|
||||||
|
sleep 10
|
||||||
|
|
||||||
|
successes=0
|
||||||
|
failures=0
|
||||||
|
for SCRIPT in $(ls -l ./bin/tests/*.sh | grep -v all)
|
||||||
|
do
|
||||||
|
if [ -f ${SCRIPT} -a -x ${SCRIPT} ]; then
|
||||||
|
echo "Running $SCRIPT (output to /dev/null)"
|
||||||
|
${SCRIPT} 2>&1 > /dev/null
|
||||||
|
rc=$?
|
||||||
|
if [[ ${rc} != 0 ]]; then
|
||||||
|
>&2 echo "ERROR!! FAILED TO RUN ${SCRIPT}"
|
||||||
|
((failures+=1))
|
||||||
|
else
|
||||||
|
((successes+=1))
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
|
||||||
|
if (( failures > 0 )); then
|
||||||
|
>&2 echo "[ERROR] ${failures} out of $((failures+successes)) scripts failed."
|
||||||
|
exit 1
|
||||||
|
else
|
||||||
|
echo "[SUCCESS] ${successes} generators finished."
|
||||||
|
fi
|
38
bin/tests/test-debug-supporting-files.sh
Executable file
38
bin/tests/test-debug-supporting-files.sh
Executable file
@ -0,0 +1,38 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
SCRIPT="$0"
|
||||||
|
echo "# START SCRIPT: $SCRIPT"
|
||||||
|
|
||||||
|
while [ -h "$SCRIPT" ] ; do
|
||||||
|
ls=`ls -ld "$SCRIPT"`
|
||||||
|
link=`expr "$ls" : '.*-> \(.*\)$'`
|
||||||
|
if expr "$link" : '/.*' > /dev/null; then
|
||||||
|
SCRIPT="$link"
|
||||||
|
else
|
||||||
|
SCRIPT=`dirname "$SCRIPT"`/"$link"
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
|
||||||
|
if [ ! -d "${APP_DIR}" ]; then
|
||||||
|
APP_DIR=`dirname "$SCRIPT"`/..
|
||||||
|
APP_DIR=`cd "${APP_DIR}"; pwd`
|
||||||
|
fi
|
||||||
|
|
||||||
|
executable="./modules/openapi-generator-cli/target/openapi-generator-cli.jar"
|
||||||
|
|
||||||
|
if [ ! -f "$executable" ]
|
||||||
|
then
|
||||||
|
mvn -B clean package $@
|
||||||
|
fi
|
||||||
|
|
||||||
|
# if you've executed sbt assembly previously it will use that instead.
|
||||||
|
export JAVA_OPTS="${JAVA_OPTS} -XX:MaxPermSize=256M -Xmx1024M -DloggerPath=conf/log4j.properties"
|
||||||
|
ags="generate -t modules/openapi-generator/src/main/resources/python -i modules/openapi-generator/src/test/resources/3_0/issue_241.yaml -g python -o /tmp/test-debug-supporting-files/ -DpackageName=petstore_api -DdebugSupportingFiles=true $@"
|
||||||
|
|
||||||
|
if [[ $(java $JAVA_OPTS -jar $executable $ags 2>&1 | grep "StackOverflowError") ]]; then
|
||||||
|
echo "There are StackOverflowError. Please check the result."
|
||||||
|
exit 1
|
||||||
|
else
|
||||||
|
echo "No StackOverflowError found."
|
||||||
|
fi
|
||||||
|
|
@ -32,6 +32,8 @@ sleep 5
|
|||||||
./bin/rust-server-petstore.sh > /dev/null 2>&1
|
./bin/rust-server-petstore.sh > /dev/null 2>&1
|
||||||
./bin/openapi3/haskell-http-client-petstore.sh > /dev/null 2>&1
|
./bin/openapi3/haskell-http-client-petstore.sh > /dev/null 2>&1
|
||||||
./bin/csharp-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:
|
# Check:
|
||||||
if [ -n "$(git status --porcelain)" ]; then
|
if [ -n "$(git status --porcelain)" ]; then
|
||||||
|
11
bin/utils/export_docs_generators.sh
Executable file
11
bin/utils/export_docs_generators.sh
Executable 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
17
bin/utils/export_generator.sh
Executable 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
8
bin/utils/export_generators_readme.sh
Executable 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
|
@ -31,8 +31,6 @@ else
|
|||||||
exit 1;
|
exit 1;
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
|
||||||
echo "IMPORTANT: this script works on Mac only"
|
|
||||||
echo "Release preparation: replacing $FROM with $TO in different files"
|
echo "Release preparation: replacing $FROM with $TO in different files"
|
||||||
|
|
||||||
declare -a files=("CI/pom.xml.bash"
|
declare -a files=("CI/pom.xml.bash"
|
||||||
@ -45,12 +43,18 @@ declare -a files=("CI/pom.xml.bash"
|
|||||||
"modules/openapi-generator-maven-plugin/pom.xml"
|
"modules/openapi-generator-maven-plugin/pom.xml"
|
||||||
"modules/openapi-generator-online/pom.xml"
|
"modules/openapi-generator-online/pom.xml"
|
||||||
"modules/openapi-generator/pom.xml"
|
"modules/openapi-generator/pom.xml"
|
||||||
|
"samples/meta-codegen/lib/pom.xml"
|
||||||
"pom.xml")
|
"pom.xml")
|
||||||
|
|
||||||
|
sedi () {
|
||||||
|
# Cross-platform version of sed -i that works both on Mac and Linux
|
||||||
|
sed --version >/dev/null 2>&1 && sed -i -e "$@" || sed -i "" "$@"
|
||||||
|
}
|
||||||
|
|
||||||
for filename in "${files[@]}"; do
|
for filename in "${files[@]}"; do
|
||||||
# e.g. sed -i '' "s/3.0.1-SNAPSHOT/3.0.1/g" CI/pom.xml.bash
|
# e.g. sed -i '' "s/3.0.1-SNAPSHOT/3.0.1/g" CI/pom.xml.bash
|
||||||
#echo "Running command: sed -i '' "s/$FROM/$TO/g" $filename"
|
#echo "Running command: sed -i '' "s/$FROM/$TO/g" $filename"
|
||||||
if sed -i '' "s/$FROM/$TO/g" $filename; then
|
if sedi "s/$FROM/$TO/g" $filename; then
|
||||||
echo "Updated $filename successfully!"
|
echo "Updated $filename successfully!"
|
||||||
else
|
else
|
||||||
echo "ERROR: Failed to update $filename with the following command"
|
echo "ERROR: Failed to update $filename with the following command"
|
||||||
|
@ -31,8 +31,6 @@ else
|
|||||||
exit 1;
|
exit 1;
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
|
||||||
echo "IMPORTANT: this script works on Mac only"
|
|
||||||
echo "Release preparation: replacing $FROM with $TO in different files"
|
echo "Release preparation: replacing $FROM with $TO in different files"
|
||||||
|
|
||||||
declare -a files=("modules/openapi-generator-maven-plugin/README.md"
|
declare -a files=("modules/openapi-generator-maven-plugin/README.md"
|
||||||
@ -45,10 +43,15 @@ declare -a files=("modules/openapi-generator-maven-plugin/README.md"
|
|||||||
"modules/openapi-generator-gradle-plugin/samples/local-spec/README.md"
|
"modules/openapi-generator-gradle-plugin/samples/local-spec/README.md"
|
||||||
"README.md")
|
"README.md")
|
||||||
|
|
||||||
|
sedi () {
|
||||||
|
# Cross-platform version of sed -i that works both on Mac and Linux
|
||||||
|
sed --version >/dev/null 2>&1 && sed -i -e "$@" || sed -i "" "$@"
|
||||||
|
}
|
||||||
|
|
||||||
for filename in "${files[@]}"; do
|
for filename in "${files[@]}"; do
|
||||||
# e.g. sed -i '' "s/3.0.1-SNAPSHOT/3.0.1/g" CI/pom.xml.bash
|
# e.g. sed -i '' "s/3.0.1-SNAPSHOT/3.0.1/g" CI/pom.xml.bash
|
||||||
#echo "Running command: sed -i '' "s/$FROM/$TO/g" $filename"
|
#echo "Running command: sed -i '' "s/$FROM/$TO/g" $filename"
|
||||||
if sed -i '' "s/$FROM/$TO/g" $filename; then
|
if sedi "s/$FROM/$TO/g" $filename; then
|
||||||
echo "Updated $filename successfully!"
|
echo "Updated $filename successfully!"
|
||||||
else
|
else
|
||||||
echo "ERROR: Failed to update $filename with the following command"
|
echo "ERROR: Failed to update $filename with the following command"
|
||||||
|
12
bin/windows/dart-client-petstore.bat
Executable file
12
bin/windows/dart-client-petstore.bat
Executable file
@ -0,0 +1,12 @@
|
|||||||
|
set executable=.\modules\swagger-codegen-cli\target\swagger-codegen-cli.jar
|
||||||
|
|
||||||
|
If Not Exist %executable% (
|
||||||
|
mvn clean package
|
||||||
|
)
|
||||||
|
|
||||||
|
REM set JAVA_OPTS=%JAVA_OPTS% -Xmx1024M -DloggerPath=conf/log4j.properties
|
||||||
|
set ags=generate -i modules\swagger-codegen\src\test\resources\2_0\petstore.yaml -l dart-jaguar -o samples\client\petstore\dart-jaguar\swagger -DhideGenerationTimestamp=true -DbrowserClient=false
|
||||||
|
java %JAVA_OPTS% -jar %executable% %ags%
|
||||||
|
|
||||||
|
set ags=generate -i modules\swagger-codegen\src\test\resources\2_0\petstore.yaml -l dart-jaguar -o samples\client\petstore\dart-jaguar\flutter_petstore\swagger -DhideGenerationTimestamp=true
|
||||||
|
java %JAVA_OPTS% -jar %executable% %ags%
|
10
bin/windows/kotlin-springboot-petstore-server.bat
Normal file
10
bin/windows/kotlin-springboot-petstore-server.bat
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
set executable=.\modules\openapi-generator-cli\target\openapi-generator-cli.jar
|
||||||
|
|
||||||
|
If Not Exist %executable% (
|
||||||
|
mvn clean package
|
||||||
|
)
|
||||||
|
|
||||||
|
REM set JAVA_OPTS=%JAVA_OPTS% -Xmx1024M
|
||||||
|
set ags=generate -i modules\openapi-generator\src\test\resources\2_0\petstore.yaml -g kotlin-spring -o samples\server\petstore\kotlin-springboot --additional-properties=library=spring-boot
|
||||||
|
|
||||||
|
java %JAVA_OPTS% -jar %executable% %ags%
|
10
bin/windows/openapi3/kotlin-springboot-petstore-server.bat
Normal file
10
bin/windows/openapi3/kotlin-springboot-petstore-server.bat
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
set executable=.\modules\openapi-generator-cli\target\openapi-generator-cli.jar
|
||||||
|
|
||||||
|
If Not Exist %executable% (
|
||||||
|
mvn clean package
|
||||||
|
)
|
||||||
|
|
||||||
|
REM set JAVA_OPTS=%JAVA_OPTS% -Xmx1024M
|
||||||
|
set ags=generate -i modules\openapi-generator\src\test\resources\3_0\petstore.yaml -g kotlin-spring -o samples\server\openapi3\petstore\kotlin-springboot --additional-properties=library=spring-boot
|
||||||
|
|
||||||
|
java %JAVA_OPTS% -jar %executable% %ags%
|
@ -10,7 +10,7 @@ jobs:
|
|||||||
machine:
|
machine:
|
||||||
docker_layer_caching: true
|
docker_layer_caching: true
|
||||||
working_directory: ~/OpenAPITools/openapi-generator
|
working_directory: ~/OpenAPITools/openapi-generator
|
||||||
parallelism: 2
|
parallelism: 3
|
||||||
shell: /bin/bash --login
|
shell: /bin/bash --login
|
||||||
environment:
|
environment:
|
||||||
CIRCLE_ARTIFACTS: /tmp/circleci-artifacts
|
CIRCLE_ARTIFACTS: /tmp/circleci-artifacts
|
||||||
|
109
docs/generators/README.md
Normal file
109
docs/generators/README.md
Normal 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
19
docs/generators/ada-server.md
Normal 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
19
docs/generators/ada.md
Normal 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
57
docs/generators/android.md
Normal 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
19
docs/generators/apache2.md
Normal 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
28
docs/generators/apex.md
Normal 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
31
docs/generators/aspnetcore.md
Normal 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
40
docs/generators/bash.md
Normal 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
37
docs/generators/clojure.md
Normal 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
7
docs/generators/cpp-pistache-server.md
Normal 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
19
docs/generators/cpp-qt5-qhttpengine-server.md
Normal 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
22
docs/generators/cpp-qt5.md
Normal 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
19
docs/generators/cpp-restbed-server.md
Normal 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
22
docs/generators/cpp-restsdk.md
Normal 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
16
docs/generators/cpp-tizen.md
Normal 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
13
docs/generators/csharp-dotnet2.md
Normal 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
46
docs/generators/csharp-nancyfx.md
Normal 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
72
docs/generators/csharp.md
Normal 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
46
docs/generators/cwiki.md
Normal 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
34
docs/generators/dart.md
Normal 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
28
docs/generators/dynamic-html.md
Normal 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
13
docs/generators/eiffel.md
Normal 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
25
docs/generators/elixir.md
Normal 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
4
docs/generators/elm.md
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
|
||||||
|
CONFIG OPTIONS for elm
|
||||||
|
|
||||||
|
Back to the [generators list](README.md)
|
10
docs/generators/erlang-client.md
Normal file
10
docs/generators/erlang-client.md
Normal 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
7
docs/generators/erlang-server.md
Normal 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
16
docs/generators/flash.md
Normal 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
10
docs/generators/go-server.md
Normal 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
22
docs/generators/go.md
Normal 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
110
docs/generators/groovy.md
Normal 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
73
docs/generators/haskell-http-client.md
Normal 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
22
docs/generators/haskell.md
Normal 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
46
docs/generators/html.md
Normal 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
58
docs/generators/html2.md
Normal 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
107
docs/generators/java-inflector.md
Normal 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
124
docs/generators/java-msf4j.md
Normal 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
137
docs/generators/java-pkmst.md
Normal 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
134
docs/generators/java-play-framework.md
Normal 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
107
docs/generators/java-undertow-server.md
Normal 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
113
docs/generators/java-vertx.md
Normal 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
152
docs/generators/java.md
Normal 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. Enable OpenFeign 10.0.1 using '-DuseFeign10=true'.
|
||||||
|
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
22
docs/generators/javascript-closure-angular.md
Normal 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
34
docs/generators/javascript-flowtyped.md
Normal 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
67
docs/generators/javascript.md
Normal 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
138
docs/generators/jaxrs-cxf-cdi.md
Normal 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
119
docs/generators/jaxrs-cxf-client.md
Normal 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
170
docs/generators/jaxrs-cxf.md
Normal 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
130
docs/generators/jaxrs-jersey.md
Normal 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
128
docs/generators/jaxrs-resteasy-eap.md
Normal 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
122
docs/generators/jaxrs-resteasy.md
Normal 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
135
docs/generators/jaxrs-spec.md
Normal 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
16
docs/generators/jmeter.md
Normal 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
41
docs/generators/kotlin-server.md
Normal 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
59
docs/generators/kotlin-spring.md
Normal 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
28
docs/generators/kotlin.md
Normal 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
13
docs/generators/lua.md
Normal 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
25
docs/generators/nodejs-server.md
Normal 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)
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user