Every great open source project has great documentation.
+
That's why we're proud to announce that we've adopted a new website and design for our official documentation.
+
+
We will still continue to maintain the documentation on our GitHub repository. In fact, our website will be generated with Docusaurus, so our docs on GitHub will still be incorporated into this site!
\ No newline at end of file
diff --git a/blog/2018/12/24/new-website/index.html b/blog/2018/12/24/new-website/index.html
new file mode 100644
index 00000000000..7caf5b3f107
--- /dev/null
+++ b/blog/2018/12/24/new-website/index.html
@@ -0,0 +1,32 @@
+New Website · OpenAPI Generator
Every great open source project has great documentation.
+
That's why we're proud to announce that we've adopted a new website and design for our official documentation.
+
+
We will still continue to maintain the documentation on our GitHub repository. In fact, our website will be generated with Docusaurus, so our docs on GitHub will still be incorporated into this site!
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
Our Standards
+
Examples of behavior that contributes to creating a positive environment include:
+
+
Using welcoming and inclusive language
+
Being respectful of differing viewpoints and experiences
+
Gracefully accepting constructive criticism
+
Focusing on what is best for the community
+
Showing empathy towards other community members
+
+
Examples of unacceptable behavior by participants include:
+
+
The use of sexualized language or imagery and unwelcome sexual attention or advances
+
Trolling, insulting/derogatory comments, and personal or political attacks
+
Public or private harassment
+
Publishing others' private information, such as a physical or electronic address, without explicit permission
+
Other conduct which could reasonably be considered inappropriate in a professional setting
+
+
Our Responsibilities
+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
Scope
+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
Enforcement
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at team@openapitools.org. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
\ No newline at end of file
diff --git a/docs/code-of-conduct/index.html b/docs/code-of-conduct/index.html
new file mode 100644
index 00000000000..68420a4aae6
--- /dev/null
+++ b/docs/code-of-conduct/index.html
@@ -0,0 +1,59 @@
+Code of Conduct · OpenAPI Generator
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
Our Standards
+
Examples of behavior that contributes to creating a positive environment include:
+
+
Using welcoming and inclusive language
+
Being respectful of differing viewpoints and experiences
+
Gracefully accepting constructive criticism
+
Focusing on what is best for the community
+
Showing empathy towards other community members
+
+
Examples of unacceptable behavior by participants include:
+
+
The use of sexualized language or imagery and unwelcome sexual attention or advances
+
Trolling, insulting/derogatory comments, and personal or political attacks
+
Public or private harassment
+
Publishing others' private information, such as a physical or electronic address, without explicit permission
+
Other conduct which could reasonably be considered inappropriate in a professional setting
+
+
Our Responsibilities
+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
Scope
+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
Enforcement
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at team@openapitools.org. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
\ No newline at end of file
diff --git a/docs/contribute-building.html b/docs/contribute-building.html
new file mode 100644
index 00000000000..4d91ac0f21c
--- /dev/null
+++ b/docs/contribute-building.html
@@ -0,0 +1,78 @@
+Building the code · OpenAPI Generator
After cloning the project, you can build it from source with this command:
+
mvn clean install
+
+
If you don't have maven installed, you may directly use the included maven wrapper, and build with the command:
+
./mvnw clean install
+
+
Using Docker
+
You can use run-in-docker.sh to do all development. This script maps your local repository to /gen
+in the docker container. It also maps ~/.m2/repository to the appropriate container location.
Build artifacts are now accessible in your working directory.
+
Once built, run-in-docker.sh will act as an executable for openapi-generator-cli. To generate code, you'll need to output to a directory under /gen (e.g. /gen/out). For example:
+
./run-in-docker.sh help# Executes 'help' command for openapi-generator-cli
+./run-in-docker.sh list # Executes 'list' command for openapi-generator-cli
+./run-in-docker.sh /gen/bin/go-petstore.sh # Builds the Go client
+./run-in-docker.sh generate -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml \
+ -g go -o /gen/out/go-petstore -DpackageName=petstore # generates go client, outputs locally to ./out/go-petstore
+
If an error like this occurs, just execute the mvn clean install -U command:
+
+
org.apache.maven.lifecycle.LifecycleExecutionException: Failed to execute goal org.apache.maven.plugins:maven-surefire-plugin:2.19.1:test (default-test) on project openapi-generator: A type incompatibility occurred while executing org.apache.maven.plugins:maven-surefire-plugin:2.19.1:test: java.lang.ExceptionInInitializerError cannot be cast to java.io.IOException
\ No newline at end of file
diff --git a/docs/contribute-building/index.html b/docs/contribute-building/index.html
new file mode 100644
index 00000000000..4d91ac0f21c
--- /dev/null
+++ b/docs/contribute-building/index.html
@@ -0,0 +1,78 @@
+Building the code · OpenAPI Generator
After cloning the project, you can build it from source with this command:
+
mvn clean install
+
+
If you don't have maven installed, you may directly use the included maven wrapper, and build with the command:
+
./mvnw clean install
+
+
Using Docker
+
You can use run-in-docker.sh to do all development. This script maps your local repository to /gen
+in the docker container. It also maps ~/.m2/repository to the appropriate container location.
Build artifacts are now accessible in your working directory.
+
Once built, run-in-docker.sh will act as an executable for openapi-generator-cli. To generate code, you'll need to output to a directory under /gen (e.g. /gen/out). For example:
+
./run-in-docker.sh help# Executes 'help' command for openapi-generator-cli
+./run-in-docker.sh list # Executes 'list' command for openapi-generator-cli
+./run-in-docker.sh /gen/bin/go-petstore.sh # Builds the Go client
+./run-in-docker.sh generate -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml \
+ -g go -o /gen/out/go-petstore -DpackageName=petstore # generates go client, outputs locally to ./out/go-petstore
+
If an error like this occurs, just execute the mvn clean install -U command:
+
+
org.apache.maven.lifecycle.LifecycleExecutionException: Failed to execute goal org.apache.maven.plugins:maven-surefire-plugin:2.19.1:test (default-test) on project openapi-generator: A type incompatibility occurred while executing org.apache.maven.plugins:maven-surefire-plugin:2.19.1:test: java.lang.ExceptionInInitializerError cannot be cast to java.io.IOException
\ No newline at end of file
diff --git a/docs/contributing.html b/docs/contributing.html
new file mode 100644
index 00000000000..9c8e74e2d2c
--- /dev/null
+++ b/docs/contributing.html
@@ -0,0 +1,121 @@
+Guidelines For Contributing · OpenAPI Generator
If you're not using the latest master to generate API clients or server stubs, please give it another try by pulling the latest master as the issue may have already been addressed. Ref: Getting Started
+
Search the open issue and closed issue to ensure no one else has reported something similar before.
+
File an issue ticket by providing all the required information.
+
Test with the latest master by building the JAR locally to see if the issue has already been addressed.
+
You can also make a suggestion or ask a question by opening an "issue".
+
+
Before submitting a PR
+
+
Search the open issue to ensure no one else has reported something similar and no one is actively working on similar proposed change.
+
If no one has suggested something similar, open an "issue" with your suggestion to gather feedback from the community.
+
If you're adding a new option to a generator, please consider using the -t option with customized templates instead or start a discussion first by opening an issue as we want to avoid adding too many options to the generator.
+
It's recommended to create a new git branch for the change so that the merge commit message looks nicer in the commit history.
+
+
How to contribute
+
git
+
If you're new to git, you may find the following FAQs useful:
To test the templates, please perform the following:
+
+
Update the Petstore sample by running the shell script under bin folder. For example, run ./bin/ruby-petstore.sh to update the Ruby PetStore API client under samples/client/petstore/ruby For Windows, the batch files can be found under bin\windows folder. (If you find that there are new files generated or unexpected changes as a result of the update, that's not unusual as the test cases are added to the OpenAPI spec from time to time. If you've questions or concerns, please open a ticket to start a discussion)
+
Run the tests in the sample folder, e.g. in samples/client/petstore/ruby, run mvn integration-test -rf :RubyPetstoreClientTests. (some languages may not contain unit testing for Petstore and we're looking for contribution from the community to implement those tests)
+
Finally, git commit the updated samples files: git commit -a
+(git add -A if added files with new test cases)
To start the CI tests, you can run mvn verify -Psamples (assuming you've all the required tools installed to run tests for different languages) or you can leverage http://travis-ci.org to run the CI tests by adding your own openapi-generator repository.
+
Tips
+
+
Smaller changes are easier to review
+
[Optional] For bug fixes, provide a OpenAPI Spec to repeat the issue so that the reviewer can use it to confirm the fix
+
Add test case(s) to cover the change
+
Document the fix in the code to make the code more readable
+
Make sure test cases passed after the change (one way is to leverage https://travis-ci.org/ to run the CI tests)
+
File a PR with meaningful title, description and commit messages.
+
Recommended git settings
+
+
git config --global core.autocrlf input to tell Git convert CRLF to LF on commit but not the other way around
+
+
To close an issue (e.g. issue 1542) automatically after a PR is merged, use keywords "fix", "close", "resolve" in the PR description, e.g. fix #1542. (Ref: closing issues using keywords)
\ No newline at end of file
diff --git a/docs/contributing/index.html b/docs/contributing/index.html
new file mode 100644
index 00000000000..9c8e74e2d2c
--- /dev/null
+++ b/docs/contributing/index.html
@@ -0,0 +1,121 @@
+Guidelines For Contributing · OpenAPI Generator
If you're not using the latest master to generate API clients or server stubs, please give it another try by pulling the latest master as the issue may have already been addressed. Ref: Getting Started
+
Search the open issue and closed issue to ensure no one else has reported something similar before.
+
File an issue ticket by providing all the required information.
+
Test with the latest master by building the JAR locally to see if the issue has already been addressed.
+
You can also make a suggestion or ask a question by opening an "issue".
+
+
Before submitting a PR
+
+
Search the open issue to ensure no one else has reported something similar and no one is actively working on similar proposed change.
+
If no one has suggested something similar, open an "issue" with your suggestion to gather feedback from the community.
+
If you're adding a new option to a generator, please consider using the -t option with customized templates instead or start a discussion first by opening an issue as we want to avoid adding too many options to the generator.
+
It's recommended to create a new git branch for the change so that the merge commit message looks nicer in the commit history.
+
+
How to contribute
+
git
+
If you're new to git, you may find the following FAQs useful:
To test the templates, please perform the following:
+
+
Update the Petstore sample by running the shell script under bin folder. For example, run ./bin/ruby-petstore.sh to update the Ruby PetStore API client under samples/client/petstore/ruby For Windows, the batch files can be found under bin\windows folder. (If you find that there are new files generated or unexpected changes as a result of the update, that's not unusual as the test cases are added to the OpenAPI spec from time to time. If you've questions or concerns, please open a ticket to start a discussion)
+
Run the tests in the sample folder, e.g. in samples/client/petstore/ruby, run mvn integration-test -rf :RubyPetstoreClientTests. (some languages may not contain unit testing for Petstore and we're looking for contribution from the community to implement those tests)
+
Finally, git commit the updated samples files: git commit -a
+(git add -A if added files with new test cases)
To start the CI tests, you can run mvn verify -Psamples (assuming you've all the required tools installed to run tests for different languages) or you can leverage http://travis-ci.org to run the CI tests by adding your own openapi-generator repository.
+
Tips
+
+
Smaller changes are easier to review
+
[Optional] For bug fixes, provide a OpenAPI Spec to repeat the issue so that the reviewer can use it to confirm the fix
+
Add test case(s) to cover the change
+
Document the fix in the code to make the code more readable
+
Make sure test cases passed after the change (one way is to leverage https://travis-ci.org/ to run the CI tests)
+
File a PR with meaningful title, description and commit messages.
+
Recommended git settings
+
+
git config --global core.autocrlf input to tell Git convert CRLF to LF on commit but not the other way around
+
+
To close an issue (e.g. issue 1542) automatically after a PR is merged, use keywords "fix", "close", "resolve" in the PR description, e.g. fix #1542. (Ref: closing issues using keywords)
\ No newline at end of file
diff --git a/docs/core-team.html b/docs/core-team.html
new file mode 100644
index 00000000000..70bca28161f
--- /dev/null
+++ b/docs/core-team.html
@@ -0,0 +1,16 @@
+Core Team Members · OpenAPI Generator
\ No newline at end of file
diff --git a/docs/core-team/index.html b/docs/core-team/index.html
new file mode 100644
index 00000000000..70bca28161f
--- /dev/null
+++ b/docs/core-team/index.html
@@ -0,0 +1,16 @@
+Core Team Members · OpenAPI Generator
\ No newline at end of file
diff --git a/docs/customization.html b/docs/customization.html
new file mode 100644
index 00000000000..274a93be24a
--- /dev/null
+++ b/docs/customization.html
@@ -0,0 +1,248 @@
+Customization · OpenAPI Generator
This will create a new directory out/generators/my-codegen, with all the files you need to get started - including a README.md. Once modified and compiled, you can use your new codegen just like any other, with your own custom-rolled logic.
+
These names can be anything you like. If you are building a client for the whitespace language, maybe you'd use the options -o out/generators/whitespace -n whitespace. They can be the same, or different, it doesn't matter. The -n value will be become the template name.
+
NOTE Convention is to use kebab casing for names passed to -n. Example, scala-finatra would become ScalaFinatraGenerator.
+
Use your new generator with the CLI
+
To compile your library, enter the out/generators/my-codegen directory, run mvn package and execute the generator:
If you publish your artifact to a distant maven repository, do not forget to add this repository as pluginRepository for your project.
+
Selective generation
+
You may not want to generate all models in your project. Likewise you may want just one or two apis to be written. If that's the case, you can use system properties to control the output:
+
The default is generate everything supported by the specific library. Once you enable a feature, it will restrict the contents generated:
+
# generate only models
+java -Dmodels {opts}
+
+# generate only apis
+java -Dapis {opts}
+
+# generate only supporting files
+java -DsupportingFiles
+
+# generate models and supporting files
+java -Dmodels -DsupportingFiles
+
+
To control the specific files being generated, you can pass a CSV list of what you want:
+
# generate the User and Pet models only
+-Dmodels=User,Pet
+
+# generate the User model and the supportingFile `StringUtil.java`:
+-Dmodels=User -DsupportingFiles=StringUtil.java
+
+
To control generation of docs and tests for api and models, pass false to the option. For api, these options are -DapiTests=false and -DapiDocs=false. For models, -DmodelTests=false and -DmodelDocs=false.
+These options default to true and don't limit the generation of the feature options listed above (like -Dapi):
+
# generate only models (with tests and documentation)
+java -Dmodels {opts}
+
+# generate only models (with tests but no documentation)
+java -Dmodels -DmodelDocs=false {opts}
+
+# generate only User and Pet models (no tests and no documentation)
+java -Dmodels=User,Pet -DmodelTests=false {opts}
+
+# generate only apis (without tests)
+java -Dapis -DapiTests=false {opts}
+
+# generate only apis (modelTests option is ignored)
+java -Dapis -DmodelTests=false {opts}
+
+
When using selective generation, only the templates needed for the specific generation will be used.
+
To skip models defined as the form parameters in "requestBody", please use skipFormModel (default to false) (this option is introduced at v3.2.2)
+
java -DskipFormModel=true
+
+
This option will be helpful to skip model generation due to the form parameter, which is defined differently in OAS3 as there's no form parameter in OAS3
+
Ignore file format
+
OpenAPI Generator supports a .openapi-generator-ignore file, similar to .gitignore or .dockerignore you're probably already familiar with.
+
The ignore file allows for better control over overwriting existing files than the --skip-overwrite flag. With the ignore file, you can specify individual files or directories can be ignored. This can be useful, for example if you only want a subset of the generated code.
+
Examples:
+
# OpenAPI Generator Ignore
+# Lines beginning with a # are comments
+
+# This should match build.sh located anywhere.
+build.sh
+
+# Matches build.sh in the root
+/build.sh
+
+# Exclude all recursively
+docs/**
+
+# Explicitly allow files excluded by other rules
+!docs/UserApi.md
+
+# Recursively exclude directories named Api
+# You can't negate files below this directory.
+src/**/Api/
+
+# When this file is nested under /Api (excluded above),
+# this rule is ignored because parent directory is excluded by previous rule.
+!src/**/PetApiTests.cs
+
+# Exclude a single, nested file explicitly
+src/Org.OpenAPITools.Test/Model/AnimalFarmTests.cs
+
+
The .openapi-generator-ignore file must exist in the root of the output directory.
+
Upon first code generation, you may also pass the CLI option --ignore-file-override=/path/to/ignore_file for greater control over generated outputs. Note that this is a complete override, and will override the .openapi-generator-ignore file in an output directory when regenerating code.
+
Editor support for .openapi-generator-ignore files is available in IntelliJ via the .ignore plugin.
+
Customizing the generator
+
There are different aspects of customizing the code generator beyond just creating or modifying templates. Each language has a supporting configuration file to handle different type mappings, etc:
Each of these files creates reasonable defaults so you can get running quickly. But if you want to configure package names, prefixes, model folders, etc. you can use a json config file to pass the values.
and config.json contains the following as an example:
+
{
+ "apiPackage" : "petstore"
+}
+
+
Supported config options can be different per language. Running config-help -g {lang} will show available options.
+These options are applied via configuration file (e.g. config.json) or by passing them with -D{optionName}={optionValue}. (If -D{optionName} does not work, please open a ticket and we'll look into it)
For all the unspecified options default values will be used.
+
Another way to override default options is to extend the config class for the specific language.
+To change, for example, the prefix for the Objective-C generated files, simply subclass the ObjcClientCodegen.java:
Your subclass will now be loaded and overrides the PREFIX value in the superclass.
+
Bringing your own models
+
Sometimes you don't want a model generated. In this case, you can simply specify an import mapping to tell
+the codegen what not to create. When doing this, every location that references a specific model will
+refer back to your classes. Note, this may not apply to all languages...
+
To specify an import mapping, use the --import-mappings argument and specify the model-to-import logic as such:
\ No newline at end of file
diff --git a/docs/customization/index.html b/docs/customization/index.html
new file mode 100644
index 00000000000..274a93be24a
--- /dev/null
+++ b/docs/customization/index.html
@@ -0,0 +1,248 @@
+Customization · OpenAPI Generator
This will create a new directory out/generators/my-codegen, with all the files you need to get started - including a README.md. Once modified and compiled, you can use your new codegen just like any other, with your own custom-rolled logic.
+
These names can be anything you like. If you are building a client for the whitespace language, maybe you'd use the options -o out/generators/whitespace -n whitespace. They can be the same, or different, it doesn't matter. The -n value will be become the template name.
+
NOTE Convention is to use kebab casing for names passed to -n. Example, scala-finatra would become ScalaFinatraGenerator.
+
Use your new generator with the CLI
+
To compile your library, enter the out/generators/my-codegen directory, run mvn package and execute the generator:
If you publish your artifact to a distant maven repository, do not forget to add this repository as pluginRepository for your project.
+
Selective generation
+
You may not want to generate all models in your project. Likewise you may want just one or two apis to be written. If that's the case, you can use system properties to control the output:
+
The default is generate everything supported by the specific library. Once you enable a feature, it will restrict the contents generated:
+
# generate only models
+java -Dmodels {opts}
+
+# generate only apis
+java -Dapis {opts}
+
+# generate only supporting files
+java -DsupportingFiles
+
+# generate models and supporting files
+java -Dmodels -DsupportingFiles
+
+
To control the specific files being generated, you can pass a CSV list of what you want:
+
# generate the User and Pet models only
+-Dmodels=User,Pet
+
+# generate the User model and the supportingFile `StringUtil.java`:
+-Dmodels=User -DsupportingFiles=StringUtil.java
+
+
To control generation of docs and tests for api and models, pass false to the option. For api, these options are -DapiTests=false and -DapiDocs=false. For models, -DmodelTests=false and -DmodelDocs=false.
+These options default to true and don't limit the generation of the feature options listed above (like -Dapi):
+
# generate only models (with tests and documentation)
+java -Dmodels {opts}
+
+# generate only models (with tests but no documentation)
+java -Dmodels -DmodelDocs=false {opts}
+
+# generate only User and Pet models (no tests and no documentation)
+java -Dmodels=User,Pet -DmodelTests=false {opts}
+
+# generate only apis (without tests)
+java -Dapis -DapiTests=false {opts}
+
+# generate only apis (modelTests option is ignored)
+java -Dapis -DmodelTests=false {opts}
+
+
When using selective generation, only the templates needed for the specific generation will be used.
+
To skip models defined as the form parameters in "requestBody", please use skipFormModel (default to false) (this option is introduced at v3.2.2)
+
java -DskipFormModel=true
+
+
This option will be helpful to skip model generation due to the form parameter, which is defined differently in OAS3 as there's no form parameter in OAS3
+
Ignore file format
+
OpenAPI Generator supports a .openapi-generator-ignore file, similar to .gitignore or .dockerignore you're probably already familiar with.
+
The ignore file allows for better control over overwriting existing files than the --skip-overwrite flag. With the ignore file, you can specify individual files or directories can be ignored. This can be useful, for example if you only want a subset of the generated code.
+
Examples:
+
# OpenAPI Generator Ignore
+# Lines beginning with a # are comments
+
+# This should match build.sh located anywhere.
+build.sh
+
+# Matches build.sh in the root
+/build.sh
+
+# Exclude all recursively
+docs/**
+
+# Explicitly allow files excluded by other rules
+!docs/UserApi.md
+
+# Recursively exclude directories named Api
+# You can't negate files below this directory.
+src/**/Api/
+
+# When this file is nested under /Api (excluded above),
+# this rule is ignored because parent directory is excluded by previous rule.
+!src/**/PetApiTests.cs
+
+# Exclude a single, nested file explicitly
+src/Org.OpenAPITools.Test/Model/AnimalFarmTests.cs
+
+
The .openapi-generator-ignore file must exist in the root of the output directory.
+
Upon first code generation, you may also pass the CLI option --ignore-file-override=/path/to/ignore_file for greater control over generated outputs. Note that this is a complete override, and will override the .openapi-generator-ignore file in an output directory when regenerating code.
+
Editor support for .openapi-generator-ignore files is available in IntelliJ via the .ignore plugin.
+
Customizing the generator
+
There are different aspects of customizing the code generator beyond just creating or modifying templates. Each language has a supporting configuration file to handle different type mappings, etc:
Each of these files creates reasonable defaults so you can get running quickly. But if you want to configure package names, prefixes, model folders, etc. you can use a json config file to pass the values.
and config.json contains the following as an example:
+
{
+ "apiPackage" : "petstore"
+}
+
+
Supported config options can be different per language. Running config-help -g {lang} will show available options.
+These options are applied via configuration file (e.g. config.json) or by passing them with -D{optionName}={optionValue}. (If -D{optionName} does not work, please open a ticket and we'll look into it)
For all the unspecified options default values will be used.
+
Another way to override default options is to extend the config class for the specific language.
+To change, for example, the prefix for the Objective-C generated files, simply subclass the ObjcClientCodegen.java:
Your subclass will now be loaded and overrides the PREFIX value in the superclass.
+
Bringing your own models
+
Sometimes you don't want a model generated. In this case, you can simply specify an import mapping to tell
+the codegen what not to create. When doing this, every location that references a specific model will
+refer back to your classes. Note, this may not apply to all languages...
+
To specify an import mapping, use the --import-mappings argument and specify the model-to-import logic as such:
\ No newline at end of file
diff --git a/docs/debugging.html b/docs/debugging.html
new file mode 100644
index 00000000000..7b941b7f8cb
--- /dev/null
+++ b/docs/debugging.html
@@ -0,0 +1,76 @@
+Debugging · OpenAPI Generator
Sometimes, you may have issues with variables in your templates. As discussed in the templating docs, we offer a variety of system properties for inspecting the models bound to templates.
+
+
-DdebugOpenAPI
+
Prints out the JSON model of the OpenAPI Document, as seen by OpenAPI Generator
+
-DdebugModels
+
Prints out the JSON model passed to model templates
+
-DdebugOperations
+
Prints out the JSON model passed to operation (api) templates
+
-DdebugSupportingFiles
+
Prints out the JSON model passed to supporting files
+
+
One or more of these properties can be passed alongside other command line options:
+
openapi-generator generate -g go \
+ -o out \
+ -i petstore-minimal.yaml \
+ -DdebugModels \
+ -DdebugOperations
+
+
Or you can add these to your JAVA_OPTS environment variable (this applies to every invocation of the tool):
NOTE: Globally available system options like these will apply to all invocations of the generator (CLI and plugins)
+
+
Runtime
+
When you're working with a custom generator, a new generator, or otherwise trying to understand the behavior of the toolset, you may need to attach a remote debugger in order to step through the code.
+
The steps are shown here for a specific version of the generator, but apply the same if you're working off master or a feature branch.
+
+
Determine the version of openapi-generator you're using. For the CLI, this is:
+
openapi-generator version
+
+
Navigate to the openapi-generator source directory (see building docs for obtaining source code and brief introduction).
+
Checkout the branch/tag for the target version. Branches are not prefixed, but tags are prefixed with a v. For instance if you're using version 3.3.0, you will execute:
+
git checkout v3.3.0
+
+
Open the project in your IDE.
+
Setup your IDE for remote debugging. You'll want to define a port used for connecting the remote debugger. For this example, we'll use 5005. See external tutorials for IntelliJ and Eclipse
+
Export the debug configuration, specifying suspend=y so you have time to attach a remote debugger. These are passed as Java system properties, either on command line or as part of the JAVA_OPTS environment variable. This will look like:
+
Execute the generator with your desired options. You should see the application output only
+
Listening for transport dt_socket at address: 5005
+
+
Set breakpoints in code, and then attach your remote debugger from your IDE (see above). The generator will automatically unblock once the remote debugger is attached. You can now step through the code.
\ No newline at end of file
diff --git a/docs/debugging/index.html b/docs/debugging/index.html
new file mode 100644
index 00000000000..7b941b7f8cb
--- /dev/null
+++ b/docs/debugging/index.html
@@ -0,0 +1,76 @@
+Debugging · OpenAPI Generator
Sometimes, you may have issues with variables in your templates. As discussed in the templating docs, we offer a variety of system properties for inspecting the models bound to templates.
+
+
-DdebugOpenAPI
+
Prints out the JSON model of the OpenAPI Document, as seen by OpenAPI Generator
+
-DdebugModels
+
Prints out the JSON model passed to model templates
+
-DdebugOperations
+
Prints out the JSON model passed to operation (api) templates
+
-DdebugSupportingFiles
+
Prints out the JSON model passed to supporting files
+
+
One or more of these properties can be passed alongside other command line options:
+
openapi-generator generate -g go \
+ -o out \
+ -i petstore-minimal.yaml \
+ -DdebugModels \
+ -DdebugOperations
+
+
Or you can add these to your JAVA_OPTS environment variable (this applies to every invocation of the tool):
NOTE: Globally available system options like these will apply to all invocations of the generator (CLI and plugins)
+
+
Runtime
+
When you're working with a custom generator, a new generator, or otherwise trying to understand the behavior of the toolset, you may need to attach a remote debugger in order to step through the code.
+
The steps are shown here for a specific version of the generator, but apply the same if you're working off master or a feature branch.
+
+
Determine the version of openapi-generator you're using. For the CLI, this is:
+
openapi-generator version
+
+
Navigate to the openapi-generator source directory (see building docs for obtaining source code and brief introduction).
+
Checkout the branch/tag for the target version. Branches are not prefixed, but tags are prefixed with a v. For instance if you're using version 3.3.0, you will execute:
+
git checkout v3.3.0
+
+
Open the project in your IDE.
+
Setup your IDE for remote debugging. You'll want to define a port used for connecting the remote debugger. For this example, we'll use 5005. See external tutorials for IntelliJ and Eclipse
+
Export the debug configuration, specifying suspend=y so you have time to attach a remote debugger. These are passed as Java system properties, either on command line or as part of the JAVA_OPTS environment variable. This will look like:
+
Execute the generator with your desired options. You should see the application output only
+
Listening for transport dt_socket at address: 5005
+
+
Set breakpoints in code, and then attach your remote debugger from your IDE (see above). The generator will automatically unblock once the remote debugger is attached. You can now step through the code.
\ No newline at end of file
diff --git a/docs/faq-contributing.html b/docs/faq-contributing.html
new file mode 100644
index 00000000000..46808678baf
--- /dev/null
+++ b/docs/faq-contributing.html
@@ -0,0 +1,74 @@
+FAQ: Contributing · OpenAPI Generator
How can I submit a PR to fix bugs or make enhancements?
+
Visit https://github.com/openapitools/openapi-generator and then click on the "Fork" button in the upper right corner. Then in your local machine, run the following (assuming your github ID is "your_user_id")
\ No newline at end of file
diff --git a/docs/faq-contributing/index.html b/docs/faq-contributing/index.html
new file mode 100644
index 00000000000..46808678baf
--- /dev/null
+++ b/docs/faq-contributing/index.html
@@ -0,0 +1,74 @@
+FAQ: Contributing · OpenAPI Generator
How can I submit a PR to fix bugs or make enhancements?
+
Visit https://github.com/openapitools/openapi-generator and then click on the "Fork" button in the upper right corner. Then in your local machine, run the following (assuming your github ID is "your_user_id")
\ No newline at end of file
diff --git a/docs/faq-extending.html b/docs/faq-extending.html
new file mode 100644
index 00000000000..3a889061c50
--- /dev/null
+++ b/docs/faq-extending.html
@@ -0,0 +1,51 @@
+FAQ: Extending · OpenAPI Generator
Please add -Dio.swagger.v3.parser.util.RemoteUrl.trustAll=true when generating the code.
+
How do I skip files during code generation?
+
OpenAPI Generator has a built-in ignore file processor.
+
For example, to skip git_push.sh, one can create a file named .openapi-generator-ignore in the root of the output directory with the contents:
+
# Prevent generator from creating these files:
+git_push.sh
+
+
The ignore file works just like .gitignore, and it is auto-generated by default.
+
If you need this functionality on initial generation, you can provide the option --ignore-file-override (CLI) or ignoreFileOverride (Maven and Gradle plugins) with a value targeting any existing file. The contents of that file will be evaluated relative to the output directory.
+
How can I customize the auto-generated code?
+
Variants:
+
+
"How can I add a header/footer to generated code?"
+
"How can I add my own logging to generated code?"
+
"How can I add my license to the top of files?"
+
+
OpenAPI Generator supports user-defined templates without need to recompile the artifact. We also support custom generators (templates and logic) if those generators are accessible on the classpath.
\ No newline at end of file
diff --git a/docs/faq-extending/index.html b/docs/faq-extending/index.html
new file mode 100644
index 00000000000..3a889061c50
--- /dev/null
+++ b/docs/faq-extending/index.html
@@ -0,0 +1,51 @@
+FAQ: Extending · OpenAPI Generator
Please add -Dio.swagger.v3.parser.util.RemoteUrl.trustAll=true when generating the code.
+
How do I skip files during code generation?
+
OpenAPI Generator has a built-in ignore file processor.
+
For example, to skip git_push.sh, one can create a file named .openapi-generator-ignore in the root of the output directory with the contents:
+
# Prevent generator from creating these files:
+git_push.sh
+
+
The ignore file works just like .gitignore, and it is auto-generated by default.
+
If you need this functionality on initial generation, you can provide the option --ignore-file-override (CLI) or ignoreFileOverride (Maven and Gradle plugins) with a value targeting any existing file. The contents of that file will be evaluated relative to the output directory.
+
How can I customize the auto-generated code?
+
Variants:
+
+
"How can I add a header/footer to generated code?"
+
"How can I add my own logging to generated code?"
+
"How can I add my license to the top of files?"
+
+
OpenAPI Generator supports user-defined templates without need to recompile the artifact. We also support custom generators (templates and logic) if those generators are accessible on the classpath.
\ No newline at end of file
diff --git a/docs/faq-generators.html b/docs/faq-generators.html
new file mode 100644
index 00000000000..8efc9d9f33a
--- /dev/null
+++ b/docs/faq-generators.html
@@ -0,0 +1,101 @@
+FAQ: Generators · OpenAPI Generator
We have around 40+ server generators, with more added regularly. Some of these include Spring in your choice of Java or Kotlin, the Finch and Scalatra frameworks using Scala, and C# generators for NancyFX and WebAPI (to name only a few).
+
Besides generating the server code as a starting point to implement the API backend, here are some use cases of the server generators:
+
+
prototyping - one can generate the server code and have a functional API backend very quickly to try different things or features.
+
mocking - easily provide an API backend for mocking based on the examples field defined in the response object.
+
migration - let's say one wants to migrate an API backend from Ruby on Rails to Java Spring. The server generator can save a lot of time in implementing and verify each endpoint in the new API backend.
+
evaluating - when you want to try a new language or framework, and a typical "Hello, World" is too trivial.
+
+
Java
+
The API client has SSL errors due to an invalid certificate. Is there a way to bypass that?
You can also generate the Java SDK with other HTTP libraries by replacing okhttp-gson with retrofit for example. For a list of support libraries, please run
We do not recommend using the default HTTP library (Apache HttpClient) with android as it's not actively maintained.
+
C-Sharp
+
How do I fix CSC: warning CS2002 in Xamarin?
+
The full warning might look like this: CSC: warning CS2002: Source file 'Api/FakeApi.cs' specified multiple times
+
The warning has no impact on the build process so you should be able to build the solution without issue. The warning should be addressed in the upcoming stable release of Xamarin.
+
Objective-C
+
How do I run integration test with Petstore ObjC API client?
Is Swift (2.x) generator still actively maintained?
+
No, please use swift3 or swift4 generator instead as we want to focus on Swift 3.x, 4.x.
+
TypeScript
+
The JSON response fails to deserialize due to change in variable naming (snake_case to camelCase). Is there any way to keep the original naming?
+
Yes, please use the following option when generating TypeScript clients:
+
modelPropertyNaming
+ Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case'and'original', which keeps the original name (Default: camelCase)
+
\ No newline at end of file
diff --git a/docs/faq-generators/index.html b/docs/faq-generators/index.html
new file mode 100644
index 00000000000..8efc9d9f33a
--- /dev/null
+++ b/docs/faq-generators/index.html
@@ -0,0 +1,101 @@
+FAQ: Generators · OpenAPI Generator
We have around 40+ server generators, with more added regularly. Some of these include Spring in your choice of Java or Kotlin, the Finch and Scalatra frameworks using Scala, and C# generators for NancyFX and WebAPI (to name only a few).
+
Besides generating the server code as a starting point to implement the API backend, here are some use cases of the server generators:
+
+
prototyping - one can generate the server code and have a functional API backend very quickly to try different things or features.
+
mocking - easily provide an API backend for mocking based on the examples field defined in the response object.
+
migration - let's say one wants to migrate an API backend from Ruby on Rails to Java Spring. The server generator can save a lot of time in implementing and verify each endpoint in the new API backend.
+
evaluating - when you want to try a new language or framework, and a typical "Hello, World" is too trivial.
+
+
Java
+
The API client has SSL errors due to an invalid certificate. Is there a way to bypass that?
You can also generate the Java SDK with other HTTP libraries by replacing okhttp-gson with retrofit for example. For a list of support libraries, please run
We do not recommend using the default HTTP library (Apache HttpClient) with android as it's not actively maintained.
+
C-Sharp
+
How do I fix CSC: warning CS2002 in Xamarin?
+
The full warning might look like this: CSC: warning CS2002: Source file 'Api/FakeApi.cs' specified multiple times
+
The warning has no impact on the build process so you should be able to build the solution without issue. The warning should be addressed in the upcoming stable release of Xamarin.
+
Objective-C
+
How do I run integration test with Petstore ObjC API client?
Is Swift (2.x) generator still actively maintained?
+
No, please use swift3 or swift4 generator instead as we want to focus on Swift 3.x, 4.x.
+
TypeScript
+
The JSON response fails to deserialize due to change in variable naming (snake_case to camelCase). Is there any way to keep the original naming?
+
Yes, please use the following option when generating TypeScript clients:
+
modelPropertyNaming
+ Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case'and'original', which keeps the original name (Default: camelCase)
+
\ No newline at end of file
diff --git a/docs/faq.html b/docs/faq.html
new file mode 100644
index 00000000000..b8b2b778319
--- /dev/null
+++ b/docs/faq.html
@@ -0,0 +1,37 @@
+FAQ: General · OpenAPI Generator
What is the governance structure of the OpenAPI Generator project?
+
OpenAPI generator (openapi-generator) is managed by the members of the core team.
+
What is the difference between Swagger Codegen and OpenAPI Generator?
+
Swagger Codegen is driven by SmartBear while OpenAPI Generator is driven by the community. More than 40 top contributors and template creators of Swagger Codegen have joined OpenAPI Generator as the founding team members. For more details, see the Fork Q&A.
+
Swagger is a trademark owned by SmartBear and the use of the term "Swagger" in this project is for demo (reference) purposes only.
\ No newline at end of file
diff --git a/docs/faq/index.html b/docs/faq/index.html
new file mode 100644
index 00000000000..b8b2b778319
--- /dev/null
+++ b/docs/faq/index.html
@@ -0,0 +1,37 @@
+FAQ: General · OpenAPI Generator
What is the governance structure of the OpenAPI Generator project?
+
OpenAPI generator (openapi-generator) is managed by the members of the core team.
+
What is the difference between Swagger Codegen and OpenAPI Generator?
+
Swagger Codegen is driven by SmartBear while OpenAPI Generator is driven by the community. More than 40 top contributors and template creators of Swagger Codegen have joined OpenAPI Generator as the founding team members. For more details, see the Fork Q&A.
+
Swagger is a trademark owned by SmartBear and the use of the term "Swagger" in this project is for demo (reference) purposes only.
This document aims to answer some questions about the fork for historical reference, where these questions don't fit into other documents related to the project itself.
+
Why was it decided to fork Swagger Codegen?
+
There are several reasons:
+
+
The founding members felt that Swagger Codegen 3.0.0 was diverging too much from the philosophy of Swagger Codegen 2.x.
+
The founding members were concerned that the maintenance overhead of two separate branches (2.x, 3.x) would result in issues similar to those felt in the Python community.
+
The founding members wanted a more rapid release cycle (weekly patch release, monthly minor release) so users do not need to wait for several months to get a stable release.
+
Having a community-driven version allows for innovation, reliability, and a roadmap owned by the community.
I am currently using Swagger Codegen 2.x. How can I upgrade the generator to OpenAPI Generator?
+
OpenAPI Generator is based on Swagger Codegen 2.4.0-SNAPSHOT version so the migration should be relatively straightforward. Refer to the migration guide for more information.
+
Who maintains this Q&A page?
+
This Q&A page is maintained by the core team members. It is not maintained by any single person, nor do these Q&As represent the views of any individual or person.
This document aims to answer some questions about the fork for historical reference, where these questions don't fit into other documents related to the project itself.
+
Why was it decided to fork Swagger Codegen?
+
There are several reasons:
+
+
The founding members felt that Swagger Codegen 3.0.0 was diverging too much from the philosophy of Swagger Codegen 2.x.
+
The founding members were concerned that the maintenance overhead of two separate branches (2.x, 3.x) would result in issues similar to those felt in the Python community.
+
The founding members wanted a more rapid release cycle (weekly patch release, monthly minor release) so users do not need to wait for several months to get a stable release.
+
Having a community-driven version allows for innovation, reliability, and a roadmap owned by the community.
I am currently using Swagger Codegen 2.x. How can I upgrade the generator to OpenAPI Generator?
+
OpenAPI Generator is based on Swagger Codegen 2.4.0-SNAPSHOT version so the migration should be relatively straightforward. Refer to the migration guide for more information.
+
Who maintains this Q&A page?
+
This Q&A page is maintained by the core team members. It is not maintained by any single person, nor do these Q&As represent the views of any individual or person.
\ No newline at end of file
diff --git a/docs/generators.html b/docs/generators.html
new file mode 100644
index 00000000000..a0f78fdd64d
--- /dev/null
+++ b/docs/generators.html
@@ -0,0 +1,160 @@
+Generators List · OpenAPI Generator
\ No newline at end of file
diff --git a/docs/generators/README.html b/docs/generators/README.html
new file mode 100644
index 00000000000..86cf710e00b
--- /dev/null
+++ b/docs/generators/README.html
@@ -0,0 +1,132 @@
+generators/README · OpenAPI Generator
\ No newline at end of file
diff --git a/docs/generators/README/index.html b/docs/generators/README/index.html
new file mode 100644
index 00000000000..86cf710e00b
--- /dev/null
+++ b/docs/generators/README/index.html
@@ -0,0 +1,132 @@
+generators/README · OpenAPI Generator
\ No newline at end of file
diff --git a/docs/generators/ada-server.html b/docs/generators/ada-server.html
new file mode 100644
index 00000000000..480a4fa8f86
--- /dev/null
+++ b/docs/generators/ada-server.html
@@ -0,0 +1,20 @@
+generators/ada-server · OpenAPI Generator
id: generator-opts-server-ada-server
+title: Config Options for ada-server
+sidebar_label: ada-server
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
projectName
GNAT project name
defaultProject
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/ada-server/index.html b/docs/generators/ada-server/index.html
new file mode 100644
index 00000000000..480a4fa8f86
--- /dev/null
+++ b/docs/generators/ada-server/index.html
@@ -0,0 +1,20 @@
+generators/ada-server · OpenAPI Generator
id: generator-opts-server-ada-server
+title: Config Options for ada-server
+sidebar_label: ada-server
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
projectName
GNAT project name
defaultProject
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/ada.html b/docs/generators/ada.html
new file mode 100644
index 00000000000..ab780851fc9
--- /dev/null
+++ b/docs/generators/ada.html
@@ -0,0 +1,20 @@
+generators/ada · OpenAPI Generator
id: generator-opts-client-ada
+title: Config Options for ada
+sidebar_label: ada
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
projectName
GNAT project name
defaultProject
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/ada/index.html b/docs/generators/ada/index.html
new file mode 100644
index 00000000000..ab780851fc9
--- /dev/null
+++ b/docs/generators/ada/index.html
@@ -0,0 +1,20 @@
+generators/ada · OpenAPI Generator
id: generator-opts-client-ada
+title: Config Options for ada
+sidebar_label: ada
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
projectName
GNAT project name
defaultProject
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/android.html b/docs/generators/android.html
new file mode 100644
index 00000000000..9c23fc01813
--- /dev/null
+++ b/docs/generators/android.html
@@ -0,0 +1,32 @@
+generators/android · OpenAPI Generator
id: generator-opts-client-android
+title: Config Options for android
+sidebar_label: android
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
invokerPackage
root package for generated code
null
+
groupId
groupId for use in the generated build.gradle and pom.xml
null
+
artifactId
artifactId for use in the generated build.gradle and pom.xml
null
+
artifactVersion
artifact version for use in the generated build.gradle and pom.xml
null
+
sourceFolder
source folder for generated code
null
+
useAndroidMavenGradlePlugin
A flag to toggle android-maven gradle plugin.
true
+
androidGradleVersion
gradleVersion version for use in the generated build.gradle
null
+
androidSdkVersion
compileSdkVersion version for use in the generated build.gradle
null
+
androidBuildToolsVersion
buildToolsVersion version for use in the generated build.gradle
null
+
serializableModel
boolean - toggle "implements Serializable" for generated models
false
+
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.
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/android/index.html b/docs/generators/android/index.html
new file mode 100644
index 00000000000..9c23fc01813
--- /dev/null
+++ b/docs/generators/android/index.html
@@ -0,0 +1,32 @@
+generators/android · OpenAPI Generator
id: generator-opts-client-android
+title: Config Options for android
+sidebar_label: android
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
invokerPackage
root package for generated code
null
+
groupId
groupId for use in the generated build.gradle and pom.xml
null
+
artifactId
artifactId for use in the generated build.gradle and pom.xml
null
+
artifactVersion
artifact version for use in the generated build.gradle and pom.xml
null
+
sourceFolder
source folder for generated code
null
+
useAndroidMavenGradlePlugin
A flag to toggle android-maven gradle plugin.
true
+
androidGradleVersion
gradleVersion version for use in the generated build.gradle
null
+
androidSdkVersion
compileSdkVersion version for use in the generated build.gradle
null
+
androidBuildToolsVersion
buildToolsVersion version for use in the generated build.gradle
null
+
serializableModel
boolean - toggle "implements Serializable" for generated models
false
+
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.
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/apache2.html b/docs/generators/apache2.html
new file mode 100644
index 00000000000..cc18da4d85f
--- /dev/null
+++ b/docs/generators/apache2.html
@@ -0,0 +1,20 @@
+generators/apache2 · OpenAPI Generator
id: generator-opts-config-apache2
+title: Config Options for apache2
+sidebar_label: apache2
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
userInfoPath
Path to the user and group files
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/apache2/index.html b/docs/generators/apache2/index.html
new file mode 100644
index 00000000000..cc18da4d85f
--- /dev/null
+++ b/docs/generators/apache2/index.html
@@ -0,0 +1,20 @@
+generators/apache2 · OpenAPI Generator
id: generator-opts-config-apache2
+title: Config Options for apache2
+sidebar_label: apache2
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
userInfoPath
Path to the user and group files
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/apex.html b/docs/generators/apex.html
new file mode 100644
index 00000000000..bc33450a052
--- /dev/null
+++ b/docs/generators/apex.html
@@ -0,0 +1,23 @@
+generators/apex · OpenAPI Generator
id: generator-opts-client-apex
+title: Config Options for apex
+sidebar_label: apex
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
classPrefix
Prefix for generated classes. Set this to avoid overwriting existing classes in your org.
null
+
apiVersion
The Metadata API version number to use for components in this package.
null
+
buildMethod
The build method for this package.
null
+
namedCredential
The named credential name for the HTTP callouts
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/apex/index.html b/docs/generators/apex/index.html
new file mode 100644
index 00000000000..bc33450a052
--- /dev/null
+++ b/docs/generators/apex/index.html
@@ -0,0 +1,23 @@
+generators/apex · OpenAPI Generator
id: generator-opts-client-apex
+title: Config Options for apex
+sidebar_label: apex
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
classPrefix
Prefix for generated classes. Set this to avoid overwriting existing classes in your org.
null
+
apiVersion
The Metadata API version number to use for components in this package.
null
+
buildMethod
The build method for this package.
null
+
namedCredential
The named credential name for the HTTP callouts
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/aspnetcore.html b/docs/generators/aspnetcore.html
new file mode 100644
index 00000000000..6b9f6eb3d46
--- /dev/null
+++ b/docs/generators/aspnetcore.html
@@ -0,0 +1,25 @@
+generators/aspnetcore · OpenAPI Generator
id: generator-opts-server-aspnetcore
+title: Config Options for aspnetcore
+sidebar_label: aspnetcore
+
+
+
+
Option
Description
Values
Default
+
+
+
packageName
C# package name (convention: Title.Case).
Org.OpenAPITools
+
packageVersion
C# package version.
1.0.0
+
packageGuid
The GUID that will be associated with the C# project
null
+
sourceFolder
source folder for generated code
src
+
aspnetCoreVersion
ASP.NET Core version: 2.1 (default), 2.0 (deprecated)
2.1
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
useDateTimeOffset
Use DateTimeOffset to model date-time properties
false
+
useCollection
Deserialize array types to Collection<T> instead of List<T>.
false
+
returnICollection
Return ICollection<T> instead of the concrete type.
false
+
useSwashbuckle
Uses the Swashbuckle.AspNetCore NuGet package for documentation.
true
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/aspnetcore/index.html b/docs/generators/aspnetcore/index.html
new file mode 100644
index 00000000000..6b9f6eb3d46
--- /dev/null
+++ b/docs/generators/aspnetcore/index.html
@@ -0,0 +1,25 @@
+generators/aspnetcore · OpenAPI Generator
id: generator-opts-server-aspnetcore
+title: Config Options for aspnetcore
+sidebar_label: aspnetcore
+
+
+
+
Option
Description
Values
Default
+
+
+
packageName
C# package name (convention: Title.Case).
Org.OpenAPITools
+
packageVersion
C# package version.
1.0.0
+
packageGuid
The GUID that will be associated with the C# project
null
+
sourceFolder
source folder for generated code
src
+
aspnetCoreVersion
ASP.NET Core version: 2.1 (default), 2.0 (deprecated)
2.1
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
useDateTimeOffset
Use DateTimeOffset to model date-time properties
false
+
useCollection
Deserialize array types to Collection<T> instead of List<T>.
false
+
returnICollection
Return ICollection<T> instead of the concrete type.
false
+
useSwashbuckle
Uses the Swashbuckle.AspNetCore NuGet package for documentation.
true
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/bash.html b/docs/generators/bash.html
new file mode 100644
index 00000000000..9a326ce005f
--- /dev/null
+++ b/docs/generators/bash.html
@@ -0,0 +1,27 @@
+generators/bash · OpenAPI Generator
Name of environment variable where username and password can be defined (e.g. PETSTORE_CREDS='username:password')
null
+
apiKeyAuthEnvironmentVariable
Name of environment variable where API key can be defined (e.g. PETSTORE_APIKEY='kjhasdGASDa5asdASD')
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/bash/index.html b/docs/generators/bash/index.html
new file mode 100644
index 00000000000..9a326ce005f
--- /dev/null
+++ b/docs/generators/bash/index.html
@@ -0,0 +1,27 @@
+generators/bash · OpenAPI Generator
Name of environment variable where username and password can be defined (e.g. PETSTORE_CREDS='username:password')
null
+
apiKeyAuthEnvironmentVariable
Name of environment variable where API key can be defined (e.g. PETSTORE_APIKEY='kjhasdGASDa5asdASD')
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/c.html b/docs/generators/c.html
new file mode 100644
index 00000000000..c0514fc57dd
--- /dev/null
+++ b/docs/generators/c.html
@@ -0,0 +1,20 @@
+generators/c · OpenAPI Generator
id: generator-opts-client-c
+title: Config Options for c
+sidebar_label: c
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
hideGenerationTimestamp
Hides the generation timestamp when files are generated.
true
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/c/index.html b/docs/generators/c/index.html
new file mode 100644
index 00000000000..c0514fc57dd
--- /dev/null
+++ b/docs/generators/c/index.html
@@ -0,0 +1,20 @@
+generators/c · OpenAPI Generator
id: generator-opts-client-c
+title: Config Options for c
+sidebar_label: c
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
hideGenerationTimestamp
Hides the generation timestamp when files are generated.
true
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/clojure.html b/docs/generators/clojure.html
new file mode 100644
index 00000000000..5b6c9d03349
--- /dev/null
+++ b/docs/generators/clojure.html
@@ -0,0 +1,26 @@
+generators/clojure · OpenAPI Generator
id: generator-opts-client-clojure
+title: Config Options for clojure
+sidebar_label: clojure
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
projectName
name of the project (Default: generated from info.title or "openapi-clj-client")
null
+
projectDescription
description of the project (Default: using info.description or "Client library of <projectName>")
null
+
projectVersion
version of the project (Default: using info.version or "1.0.0")
null
+
projectUrl
URL of the project (Default: using info.contact.url or not included in project.clj)
null
+
projectLicenseName
name of the license the project uses (Default: using info.license.name or not included in project.clj)
null
+
projectLicenseUrl
URL of the license the project uses (Default: using info.license.url or not included in project.clj)
null
+
baseNamespace
the base/top namespace (Default: generated from projectName)
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/clojure/index.html b/docs/generators/clojure/index.html
new file mode 100644
index 00000000000..5b6c9d03349
--- /dev/null
+++ b/docs/generators/clojure/index.html
@@ -0,0 +1,26 @@
+generators/clojure · OpenAPI Generator
id: generator-opts-client-clojure
+title: Config Options for clojure
+sidebar_label: clojure
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
projectName
name of the project (Default: generated from info.title or "openapi-clj-client")
null
+
projectDescription
description of the project (Default: using info.description or "Client library of <projectName>")
null
+
projectVersion
version of the project (Default: using info.version or "1.0.0")
null
+
projectUrl
URL of the project (Default: using info.contact.url or not included in project.clj)
null
+
projectLicenseName
name of the license the project uses (Default: using info.license.name or not included in project.clj)
null
+
projectLicenseUrl
URL of the license the project uses (Default: using info.license.url or not included in project.clj)
null
+
baseNamespace
the base/top namespace (Default: generated from projectName)
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/cpp-pistache-server.html b/docs/generators/cpp-pistache-server.html
new file mode 100644
index 00000000000..beb6a6ca564
--- /dev/null
+++ b/docs/generators/cpp-pistache-server.html
@@ -0,0 +1,17 @@
+generators/cpp-pistache-server · OpenAPI Generator
id: generator-opts-server-cpp-pistache-server
+title: Config Options for cpp-pistache-server
+sidebar_label: cpp-pistache-server
+
+
+
+
Option
Description
Values
Default
+
+
+
addExternalLibs
Add the Possibility to fetch and compile external Libraries needed by this Framework.
true
+
helpersPackage
Specify the package name to be used for the helpers (e.g. org.openapitools.server.helpers).
org.openapitools.server.helpers
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/cpp-pistache-server/index.html b/docs/generators/cpp-pistache-server/index.html
new file mode 100644
index 00000000000..beb6a6ca564
--- /dev/null
+++ b/docs/generators/cpp-pistache-server/index.html
@@ -0,0 +1,17 @@
+generators/cpp-pistache-server · OpenAPI Generator
id: generator-opts-server-cpp-pistache-server
+title: Config Options for cpp-pistache-server
+sidebar_label: cpp-pistache-server
+
+
+
+
Option
Description
Values
Default
+
+
+
addExternalLibs
Add the Possibility to fetch and compile external Libraries needed by this Framework.
true
+
helpersPackage
Specify the package name to be used for the helpers (e.g. org.openapitools.server.helpers).
org.openapitools.server.helpers
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/cpp-qt5-client.html b/docs/generators/cpp-qt5-client.html
new file mode 100644
index 00000000000..b2172655ffc
--- /dev/null
+++ b/docs/generators/cpp-qt5-client.html
@@ -0,0 +1,22 @@
+generators/cpp-qt5-client · OpenAPI Generator
id: generator-opts-client-cpp-qt5-client
+title: Config Options for cpp-qt5-client
+sidebar_label: cpp-qt5-client
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
cppNamespace
C++ namespace (convention: name::space::for::api).
OpenAPI
+
cppNamespace
C++ namespace (convention: name::space::for::api).
OpenAPI
+
optionalProjectFile
Generate client.pri.
true
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/cpp-qt5-client/index.html b/docs/generators/cpp-qt5-client/index.html
new file mode 100644
index 00000000000..b2172655ffc
--- /dev/null
+++ b/docs/generators/cpp-qt5-client/index.html
@@ -0,0 +1,22 @@
+generators/cpp-qt5-client · OpenAPI Generator
id: generator-opts-client-cpp-qt5-client
+title: Config Options for cpp-qt5-client
+sidebar_label: cpp-qt5-client
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
cppNamespace
C++ namespace (convention: name::space::for::api).
OpenAPI
+
cppNamespace
C++ namespace (convention: name::space::for::api).
OpenAPI
+
optionalProjectFile
Generate client.pri.
true
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/cpp-qt5-qhttpengine-server.html b/docs/generators/cpp-qt5-qhttpengine-server.html
new file mode 100644
index 00000000000..8335b248183
--- /dev/null
+++ b/docs/generators/cpp-qt5-qhttpengine-server.html
@@ -0,0 +1,21 @@
+generators/cpp-qt5-qhttpengine-server · OpenAPI Generator
id: generator-opts-server-cpp-qt5-qhttpengine-server
+title: Config Options for cpp-qt5-qhttpengine-server
+sidebar_label: cpp-qt5-qhttpengine-server
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
cppNamespace
C++ namespace (convention: name::space::for::api).
OpenAPI
+
cppNamespace
C++ namespace (convention: name::space::for::api).
OpenAPI
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/cpp-qt5-qhttpengine-server/index.html b/docs/generators/cpp-qt5-qhttpengine-server/index.html
new file mode 100644
index 00000000000..8335b248183
--- /dev/null
+++ b/docs/generators/cpp-qt5-qhttpengine-server/index.html
@@ -0,0 +1,21 @@
+generators/cpp-qt5-qhttpengine-server · OpenAPI Generator
id: generator-opts-server-cpp-qt5-qhttpengine-server
+title: Config Options for cpp-qt5-qhttpengine-server
+sidebar_label: cpp-qt5-qhttpengine-server
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
cppNamespace
C++ namespace (convention: name::space::for::api).
OpenAPI
+
cppNamespace
C++ namespace (convention: name::space::for::api).
OpenAPI
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/cpp-restbed-server.html b/docs/generators/cpp-restbed-server.html
new file mode 100644
index 00000000000..af4267976fb
--- /dev/null
+++ b/docs/generators/cpp-restbed-server.html
@@ -0,0 +1,20 @@
+generators/cpp-restbed-server · OpenAPI Generator
id: generator-opts-server-cpp-restbed-server
+title: Config Options for cpp-restbed-server
+sidebar_label: cpp-restbed-server
+
+
+
+
Option
Description
Values
Default
+
+
+
modelPackage
C++ namespace for models (convention: name.space.model).
org.openapitools.server.model
+
apiPackage
C++ namespace for apis (convention: name.space.api).
org.openapitools.server.api
+
packageVersion
C++ package version.
1.0.0
+
declspec
C++ preprocessor to place before the class name for handling dllexport/dllimport.
+
defaultInclude
The default include statement that should be placed in all headers for including things like the declspec (convention: #include "Commons.h"
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/cpp-restbed-server/index.html b/docs/generators/cpp-restbed-server/index.html
new file mode 100644
index 00000000000..af4267976fb
--- /dev/null
+++ b/docs/generators/cpp-restbed-server/index.html
@@ -0,0 +1,20 @@
+generators/cpp-restbed-server · OpenAPI Generator
id: generator-opts-server-cpp-restbed-server
+title: Config Options for cpp-restbed-server
+sidebar_label: cpp-restbed-server
+
+
+
+
Option
Description
Values
Default
+
+
+
modelPackage
C++ namespace for models (convention: name.space.model).
org.openapitools.server.model
+
apiPackage
C++ namespace for apis (convention: name.space.api).
org.openapitools.server.api
+
packageVersion
C++ package version.
1.0.0
+
declspec
C++ preprocessor to place before the class name for handling dllexport/dllimport.
+
defaultInclude
The default include statement that should be placed in all headers for including things like the declspec (convention: #include "Commons.h"
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/cpp-restsdk.html b/docs/generators/cpp-restsdk.html
new file mode 100644
index 00000000000..53f922e5ec5
--- /dev/null
+++ b/docs/generators/cpp-restsdk.html
@@ -0,0 +1,21 @@
+generators/cpp-restsdk · OpenAPI Generator
id: generator-opts-client-cpp-restsdk
+title: Config Options for cpp-restsdk
+sidebar_label: cpp-restsdk
+
+
+
+
Option
Description
Values
Default
+
+
+
modelPackage
C++ namespace for models (convention: name.space.model).
org.openapitools.client.model
+
apiPackage
C++ namespace for apis (convention: name.space.api).
org.openapitools.client.api
+
packageVersion
C++ package version.
1.0.0
+
declspec
C++ preprocessor to place before the class name for handling dllexport/dllimport.
+
defaultInclude
The default include statement that should be placed in all headers for including things like the declspec (convention: #include "Commons.h"
+
generateGMocksForApis
Generate Google Mock classes for APIs.
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/cpp-restsdk/index.html b/docs/generators/cpp-restsdk/index.html
new file mode 100644
index 00000000000..53f922e5ec5
--- /dev/null
+++ b/docs/generators/cpp-restsdk/index.html
@@ -0,0 +1,21 @@
+generators/cpp-restsdk · OpenAPI Generator
id: generator-opts-client-cpp-restsdk
+title: Config Options for cpp-restsdk
+sidebar_label: cpp-restsdk
+
+
+
+
Option
Description
Values
Default
+
+
+
modelPackage
C++ namespace for models (convention: name.space.model).
org.openapitools.client.model
+
apiPackage
C++ namespace for apis (convention: name.space.api).
org.openapitools.client.api
+
packageVersion
C++ package version.
1.0.0
+
declspec
C++ preprocessor to place before the class name for handling dllexport/dllimport.
+
defaultInclude
The default include statement that should be placed in all headers for including things like the declspec (convention: #include "Commons.h"
+
generateGMocksForApis
Generate Google Mock classes for APIs.
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/cpp-tizen.html b/docs/generators/cpp-tizen.html
new file mode 100644
index 00000000000..eb18fd71da2
--- /dev/null
+++ b/docs/generators/cpp-tizen.html
@@ -0,0 +1,19 @@
+generators/cpp-tizen · OpenAPI Generator
id: generator-opts-client-cpp-tizen
+title: Config Options for cpp-tizen
+sidebar_label: cpp-tizen
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/cpp-tizen/index.html b/docs/generators/cpp-tizen/index.html
new file mode 100644
index 00000000000..eb18fd71da2
--- /dev/null
+++ b/docs/generators/cpp-tizen/index.html
@@ -0,0 +1,19 @@
+generators/cpp-tizen · OpenAPI Generator
id: generator-opts-client-cpp-tizen
+title: Config Options for cpp-tizen
+sidebar_label: cpp-tizen
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/csharp-dotnet2.html b/docs/generators/csharp-dotnet2.html
new file mode 100644
index 00000000000..8388a363a78
--- /dev/null
+++ b/docs/generators/csharp-dotnet2.html
@@ -0,0 +1,18 @@
+generators/csharp-dotnet2 · OpenAPI Generator
id: generator-opts-client-csharp-dotnet2
+title: Config Options for csharp-dotnet2
+sidebar_label: csharp-dotnet2
+
+
+
+
Option
Description
Values
Default
+
+
+
packageName
C# package name (convention: Camel.Case).
Org.OpenAPITools
+
packageVersion
C# package version.
1.0.0
+
clientPackage
C# client package name (convention: Camel.Case).
Org.OpenAPITools.Client
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/csharp-dotnet2/index.html b/docs/generators/csharp-dotnet2/index.html
new file mode 100644
index 00000000000..8388a363a78
--- /dev/null
+++ b/docs/generators/csharp-dotnet2/index.html
@@ -0,0 +1,18 @@
+generators/csharp-dotnet2 · OpenAPI Generator
id: generator-opts-client-csharp-dotnet2
+title: Config Options for csharp-dotnet2
+sidebar_label: csharp-dotnet2
+
+
+
+
Option
Description
Values
Default
+
+
+
packageName
C# package name (convention: Camel.Case).
Org.OpenAPITools
+
packageVersion
C# package version.
1.0.0
+
clientPackage
C# client package name (convention: Camel.Case).
Org.OpenAPITools.Client
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/csharp-nancyfx.html b/docs/generators/csharp-nancyfx.html
new file mode 100644
index 00000000000..7266dbe7743
--- /dev/null
+++ b/docs/generators/csharp-nancyfx.html
@@ -0,0 +1,29 @@
+generators/csharp-nancyfx · OpenAPI Generator
id: generator-opts-server-csharp-nancyfx
+title: Config Options for csharp-nancyfx
+sidebar_label: csharp-nancyfx
+
+
+
+
Option
Description
Values
Default
+
+
+
packageName
C# package name (convention: Title.Case).
Org.OpenAPITools
+
packageVersion
C# package version.
1.0.0
+
sourceFolder
source folder for generated code
src
+
interfacePrefix
Prefix interfaces with a community standard or widely accepted prefix.
+
packageGuid
The GUID that will be associated with the C# project
null
+
packageContext
Optionally overrides the PackageContext which determines the namespace (namespace=packageName.packageContext). If not set, packageContext will default to basePath.
null
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
optionalProjectFile
Generate {PackageName}.csproj.
true
+
useDateTimeOffset
Use DateTimeOffset to model date-time properties
false
+
useCollection
Deserialize array types to Collection<T> instead of List<T>.
false
+
returnICollection
Return ICollection<T> instead of the concrete type.
false
+
immutable
Enabled by default. If disabled generates model classes with setters
true
+
writeModulePath
Enabled by default. If disabled, module paths will not mirror api base path
true
+
asyncServer
Set to true to enable the generation of async routes/endpoints.
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/csharp-nancyfx/index.html b/docs/generators/csharp-nancyfx/index.html
new file mode 100644
index 00000000000..7266dbe7743
--- /dev/null
+++ b/docs/generators/csharp-nancyfx/index.html
@@ -0,0 +1,29 @@
+generators/csharp-nancyfx · OpenAPI Generator
id: generator-opts-server-csharp-nancyfx
+title: Config Options for csharp-nancyfx
+sidebar_label: csharp-nancyfx
+
+
+
+
Option
Description
Values
Default
+
+
+
packageName
C# package name (convention: Title.Case).
Org.OpenAPITools
+
packageVersion
C# package version.
1.0.0
+
sourceFolder
source folder for generated code
src
+
interfacePrefix
Prefix interfaces with a community standard or widely accepted prefix.
+
packageGuid
The GUID that will be associated with the C# project
null
+
packageContext
Optionally overrides the PackageContext which determines the namespace (namespace=packageName.packageContext). If not set, packageContext will default to basePath.
null
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
optionalProjectFile
Generate {PackageName}.csproj.
true
+
useDateTimeOffset
Use DateTimeOffset to model date-time properties
false
+
useCollection
Deserialize array types to Collection<T> instead of List<T>.
false
+
returnICollection
Return ICollection<T> instead of the concrete type.
false
+
immutable
Enabled by default. If disabled generates model classes with setters
true
+
writeModulePath
Enabled by default. If disabled, module paths will not mirror api base path
true
+
asyncServer
Set to true to enable the generation of async routes/endpoints.
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/csharp-refactor.html b/docs/generators/csharp-refactor.html
new file mode 100644
index 00000000000..c97d1037b71
--- /dev/null
+++ b/docs/generators/csharp-refactor.html
@@ -0,0 +1,36 @@
+generators/csharp-refactor · OpenAPI Generator
Specifies a AssemblyDescription for the .NET Framework global assembly attributes stored in the AssemblyInfo file.
false
+
nonPublicApi
Generates code with reduced access modifiers; allows embedding elsewhere without exposing non-public API calls to consumers.
false
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
netCoreProjectFile
Use the new format (.NET Core) for .NET project files (.csproj).
false
+
validatable
Generates self-validatable models.
true
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/csharp-refactor/index.html b/docs/generators/csharp-refactor/index.html
new file mode 100644
index 00000000000..c97d1037b71
--- /dev/null
+++ b/docs/generators/csharp-refactor/index.html
@@ -0,0 +1,36 @@
+generators/csharp-refactor · OpenAPI Generator
Specifies a AssemblyDescription for the .NET Framework global assembly attributes stored in the AssemblyInfo file.
false
+
nonPublicApi
Generates code with reduced access modifiers; allows embedding elsewhere without exposing non-public API calls to consumers.
false
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
netCoreProjectFile
Use the new format (.NET Core) for .NET project files (.csproj).
false
+
validatable
Generates self-validatable models.
true
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/csharp.html b/docs/generators/csharp.html
new file mode 100644
index 00000000000..31a84e3cd4a
--- /dev/null
+++ b/docs/generators/csharp.html
@@ -0,0 +1,37 @@
+generators/csharp · OpenAPI Generator
Specifies a AssemblyDescription for the .NET Framework global assembly attributes stored in the AssemblyInfo file.
false
+
nonPublicApi
Generates code with reduced access modifiers; allows embedding elsewhere without exposing non-public API calls to consumers.
false
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
netCoreProjectFile
Use the new format (.NET Core) for .NET project files (.csproj).
false
+
validatable
Generates self-validatable models.
true
+
useCompareNetObjects
Use KellermanSoftware.CompareNetObjects for deep recursive object comparison. WARNING: this option incurs potential performance impact.
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/csharp/index.html b/docs/generators/csharp/index.html
new file mode 100644
index 00000000000..31a84e3cd4a
--- /dev/null
+++ b/docs/generators/csharp/index.html
@@ -0,0 +1,37 @@
+generators/csharp · OpenAPI Generator
Specifies a AssemblyDescription for the .NET Framework global assembly attributes stored in the AssemblyInfo file.
false
+
nonPublicApi
Generates code with reduced access modifiers; allows embedding elsewhere without exposing non-public API calls to consumers.
false
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
netCoreProjectFile
Use the new format (.NET Core) for .NET project files (.csproj).
false
+
validatable
Generates self-validatable models.
true
+
useCompareNetObjects
Use KellermanSoftware.CompareNetObjects for deep recursive object comparison. WARNING: this option incurs potential performance impact.
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/cwiki.html b/docs/generators/cwiki.html
new file mode 100644
index 00000000000..cbc64c71bdc
--- /dev/null
+++ b/docs/generators/cwiki.html
@@ -0,0 +1,29 @@
+generators/cwiki · OpenAPI Generator
id: generator-opts-documentation-cwiki
+title: Config Options for cwiki
+sidebar_label: cwiki
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
appName
short name of the application
null
+
appDescription
description of the application
null
+
infoUrl
a URL where users can get more information about the application
null
+
infoEmail
an email address to contact for inquiries about the application
null
+
licenseInfo
a short description of the license
null
+
licenseUrl
a URL pointing to the full license
null
+
invokerPackage
root package for generated code
null
+
groupId
groupId in generated pom.xml
null
+
artifactId
artifactId in generated pom.xml
null
+
artifactVersion
artifact version in generated pom.xml
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/cwiki/index.html b/docs/generators/cwiki/index.html
new file mode 100644
index 00000000000..cbc64c71bdc
--- /dev/null
+++ b/docs/generators/cwiki/index.html
@@ -0,0 +1,29 @@
+generators/cwiki · OpenAPI Generator
id: generator-opts-documentation-cwiki
+title: Config Options for cwiki
+sidebar_label: cwiki
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
appName
short name of the application
null
+
appDescription
description of the application
null
+
infoUrl
a URL where users can get more information about the application
null
+
infoEmail
an email address to contact for inquiries about the application
null
+
licenseInfo
a short description of the license
null
+
licenseUrl
a URL pointing to the full license
null
+
invokerPackage
root package for generated code
null
+
groupId
groupId in generated pom.xml
null
+
artifactId
artifactId in generated pom.xml
null
+
artifactVersion
artifact version in generated pom.xml
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/dart-jaguar.html b/docs/generators/dart-jaguar.html
new file mode 100644
index 00000000000..bb8aced1770
--- /dev/null
+++ b/docs/generators/dart-jaguar.html
@@ -0,0 +1,27 @@
+generators/dart-jaguar · OpenAPI Generator
id: generator-opts-client-dart-jaguar
+title: Config Options for dart-jaguar
+sidebar_label: dart-jaguar
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
browserClient
Is the client browser based
null
+
pubName
Name in generated pubspec
null
+
pubVersion
Version in generated pubspec
null
+
pubDescription
Description in generated pubspec
null
+
useEnumExtension
Allow the 'x-enum-values' extension for enums
null
+
sourceFolder
source folder for generated code
null
+
supportDart2
support dart2
true
+
nullableFields
Is the null fields should be in the JSON payload
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/dart-jaguar/index.html b/docs/generators/dart-jaguar/index.html
new file mode 100644
index 00000000000..bb8aced1770
--- /dev/null
+++ b/docs/generators/dart-jaguar/index.html
@@ -0,0 +1,27 @@
+generators/dart-jaguar · OpenAPI Generator
id: generator-opts-client-dart-jaguar
+title: Config Options for dart-jaguar
+sidebar_label: dart-jaguar
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
browserClient
Is the client browser based
null
+
pubName
Name in generated pubspec
null
+
pubVersion
Version in generated pubspec
null
+
pubDescription
Description in generated pubspec
null
+
useEnumExtension
Allow the 'x-enum-values' extension for enums
null
+
sourceFolder
source folder for generated code
null
+
supportDart2
support dart2
true
+
nullableFields
Is the null fields should be in the JSON payload
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/dart.html b/docs/generators/dart.html
new file mode 100644
index 00000000000..a05feb07356
--- /dev/null
+++ b/docs/generators/dart.html
@@ -0,0 +1,26 @@
+generators/dart · OpenAPI Generator
id: generator-opts-client-dart
+title: Config Options for dart
+sidebar_label: dart
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
browserClient
Is the client browser based
null
+
pubName
Name in generated pubspec
null
+
pubVersion
Version in generated pubspec
null
+
pubDescription
Description in generated pubspec
null
+
useEnumExtension
Allow the 'x-enum-values' extension for enums
null
+
sourceFolder
source folder for generated code
null
+
supportDart2
support dart2
true
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/dart/index.html b/docs/generators/dart/index.html
new file mode 100644
index 00000000000..a05feb07356
--- /dev/null
+++ b/docs/generators/dart/index.html
@@ -0,0 +1,26 @@
+generators/dart · OpenAPI Generator
id: generator-opts-client-dart
+title: Config Options for dart
+sidebar_label: dart
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
browserClient
Is the client browser based
null
+
pubName
Name in generated pubspec
null
+
pubVersion
Version in generated pubspec
null
+
pubDescription
Description in generated pubspec
null
+
useEnumExtension
Allow the 'x-enum-values' extension for enums
null
+
sourceFolder
source folder for generated code
null
+
supportDart2
support dart2
true
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/dynamic-html.html b/docs/generators/dynamic-html.html
new file mode 100644
index 00000000000..65db6785584
--- /dev/null
+++ b/docs/generators/dynamic-html.html
@@ -0,0 +1,23 @@
+generators/dynamic-html · OpenAPI Generator
id: generator-opts-documentation-dynamic-html
+title: Config Options for dynamic-html
+sidebar_label: dynamic-html
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
invokerPackage
root package for generated code
null
+
groupId
groupId in generated pom.xml
null
+
artifactId
artifactId in generated pom.xml
null
+
artifactVersion
artifact version in generated pom.xml
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/dynamic-html/index.html b/docs/generators/dynamic-html/index.html
new file mode 100644
index 00000000000..65db6785584
--- /dev/null
+++ b/docs/generators/dynamic-html/index.html
@@ -0,0 +1,23 @@
+generators/dynamic-html · OpenAPI Generator
id: generator-opts-documentation-dynamic-html
+title: Config Options for dynamic-html
+sidebar_label: dynamic-html
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
invokerPackage
root package for generated code
null
+
groupId
groupId in generated pom.xml
null
+
artifactId
artifactId in generated pom.xml
null
+
artifactVersion
artifact version in generated pom.xml
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/eiffel.html b/docs/generators/eiffel.html
new file mode 100644
index 00000000000..8632c6caf9e
--- /dev/null
+++ b/docs/generators/eiffel.html
@@ -0,0 +1,18 @@
+generators/eiffel · OpenAPI Generator
id: generator-opts-client-eiffel
+title: Config Options for eiffel
+sidebar_label: eiffel
+
+
+
+
Option
Description
Values
Default
+
+
+
packageName
Eiffel Cluster name (convention: lowercase).
openapi
+
packageVersion
Eiffel package version.
1.0.0
+
hideGenerationTimestamp
Hides the generation timestamp when files are generated.
true
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/eiffel/index.html b/docs/generators/eiffel/index.html
new file mode 100644
index 00000000000..8632c6caf9e
--- /dev/null
+++ b/docs/generators/eiffel/index.html
@@ -0,0 +1,18 @@
+generators/eiffel · OpenAPI Generator
id: generator-opts-client-eiffel
+title: Config Options for eiffel
+sidebar_label: eiffel
+
+
+
+
Option
Description
Values
Default
+
+
+
packageName
Eiffel Cluster name (convention: lowercase).
openapi
+
packageVersion
Eiffel package version.
1.0.0
+
hideGenerationTimestamp
Hides the generation timestamp when files are generated.
true
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/elixir.html b/docs/generators/elixir.html
new file mode 100644
index 00000000000..0df8c88ce9a
--- /dev/null
+++ b/docs/generators/elixir.html
@@ -0,0 +1,22 @@
+generators/elixir · OpenAPI Generator
id: generator-opts-client-elixir
+title: Config Options for elixir
+sidebar_label: elixir
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
invokerPackage
The main namespace to use for all classes. e.g. Yay.Pets
null
+
licenseHeader
The license header to prepend to the top of all source files.
null
+
packageName
Elixir package name (convention: lowercase).
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/elixir/index.html b/docs/generators/elixir/index.html
new file mode 100644
index 00000000000..0df8c88ce9a
--- /dev/null
+++ b/docs/generators/elixir/index.html
@@ -0,0 +1,22 @@
+generators/elixir · OpenAPI Generator
id: generator-opts-client-elixir
+title: Config Options for elixir
+sidebar_label: elixir
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
invokerPackage
The main namespace to use for all classes. e.g. Yay.Pets
null
+
licenseHeader
The license header to prepend to the top of all source files.
null
+
packageName
Elixir package name (convention: lowercase).
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/elm.html b/docs/generators/elm.html
new file mode 100644
index 00000000000..90dbde91321
--- /dev/null
+++ b/docs/generators/elm.html
@@ -0,0 +1,19 @@
+generators/elm · OpenAPI Generator
id: generator-opts-client-elm
+title: Config Options for elm
+sidebar_label: elm
+
+
+
+
Option
Description
Values
Default
+
+
+
elmVersion
Elm version: 0.18, 0.19
0.19
Elm 0.19
0.18
Elm 0.18
0.19
+
elmPrefixCustomTypeVariants
Prefix custom type variants
false
+
elmEnableCustomBasePaths
Enable setting the base path for each request
false
+
elmEnableHttpRequestTrackers
Enable adding a tracker to each http request
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/elm/index.html b/docs/generators/elm/index.html
new file mode 100644
index 00000000000..90dbde91321
--- /dev/null
+++ b/docs/generators/elm/index.html
@@ -0,0 +1,19 @@
+generators/elm · OpenAPI Generator
id: generator-opts-client-elm
+title: Config Options for elm
+sidebar_label: elm
+
+
+
+
Option
Description
Values
Default
+
+
+
elmVersion
Elm version: 0.18, 0.19
0.19
Elm 0.19
0.18
Elm 0.18
0.19
+
elmPrefixCustomTypeVariants
Prefix custom type variants
false
+
elmEnableCustomBasePaths
Enable setting the base path for each request
false
+
elmEnableHttpRequestTrackers
Enable adding a tracker to each http request
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/erlang-client.html b/docs/generators/erlang-client.html
new file mode 100644
index 00000000000..15fabb8002b
--- /dev/null
+++ b/docs/generators/erlang-client.html
@@ -0,0 +1,17 @@
+generators/erlang-client · OpenAPI Generator
id: generator-opts-client-erlang-client
+title: Config Options for erlang-client
+sidebar_label: erlang-client
+
+
+
+
Option
Description
Values
Default
+
+
+
packageName
Erlang application name (convention: lowercase).
openapi
+
packageName
Erlang application version
1.0.0
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/erlang-client/index.html b/docs/generators/erlang-client/index.html
new file mode 100644
index 00000000000..15fabb8002b
--- /dev/null
+++ b/docs/generators/erlang-client/index.html
@@ -0,0 +1,17 @@
+generators/erlang-client · OpenAPI Generator
id: generator-opts-client-erlang-client
+title: Config Options for erlang-client
+sidebar_label: erlang-client
+
+
+
+
Option
Description
Values
Default
+
+
+
packageName
Erlang application name (convention: lowercase).
openapi
+
packageName
Erlang application version
1.0.0
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/erlang-proper.html b/docs/generators/erlang-proper.html
new file mode 100644
index 00000000000..b120225c4b9
--- /dev/null
+++ b/docs/generators/erlang-proper.html
@@ -0,0 +1,17 @@
+generators/erlang-proper · OpenAPI Generator
id: generator-opts-client-erlang-proper
+title: Config Options for erlang-proper
+sidebar_label: erlang-proper
+
+
+
+
Option
Description
Values
Default
+
+
+
packageName
Erlang application name (convention: lowercase).
openapi
+
packageName
Erlang application version
1.0.0
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/erlang-proper/index.html b/docs/generators/erlang-proper/index.html
new file mode 100644
index 00000000000..b120225c4b9
--- /dev/null
+++ b/docs/generators/erlang-proper/index.html
@@ -0,0 +1,17 @@
+generators/erlang-proper · OpenAPI Generator
id: generator-opts-client-erlang-proper
+title: Config Options for erlang-proper
+sidebar_label: erlang-proper
+
+
+
+
Option
Description
Values
Default
+
+
+
packageName
Erlang application name (convention: lowercase).
openapi
+
packageName
Erlang application version
1.0.0
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/erlang-server.html b/docs/generators/erlang-server.html
new file mode 100644
index 00000000000..601bec7b4fe
--- /dev/null
+++ b/docs/generators/erlang-server.html
@@ -0,0 +1,17 @@
+generators/erlang-server · OpenAPI Generator
id: generator-opts-server-erlang-server
+title: Config Options for erlang-server
+sidebar_label: erlang-server
+
+
+
+
Option
Description
Values
Default
+
+
+
packageName
Erlang package name (convention: lowercase).
openapi
+
openAPISpecName
Openapi Spec Name.
openapi
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/erlang-server/index.html b/docs/generators/erlang-server/index.html
new file mode 100644
index 00000000000..601bec7b4fe
--- /dev/null
+++ b/docs/generators/erlang-server/index.html
@@ -0,0 +1,17 @@
+generators/erlang-server · OpenAPI Generator
id: generator-opts-server-erlang-server
+title: Config Options for erlang-server
+sidebar_label: erlang-server
+
+
+
+
Option
Description
Values
Default
+
+
+
packageName
Erlang package name (convention: lowercase).
openapi
+
openAPISpecName
Openapi Spec Name.
openapi
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/flash.html b/docs/generators/flash.html
new file mode 100644
index 00000000000..3168310f43d
--- /dev/null
+++ b/docs/generators/flash.html
@@ -0,0 +1,19 @@
+generators/flash · OpenAPI Generator
id: generator-opts-client-flash
+title: Config Options for flash
+sidebar_label: flash
+
+
+
+
Option
Description
Values
Default
+
+
+
packageName
flash package name (convention: package.name)
org.openapitools
+
packageVersion
flash package version
1.0.0
+
invokerPackage
root package for generated code
null
+
sourceFolder
source folder for generated code. e.g. flash
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/flash/index.html b/docs/generators/flash/index.html
new file mode 100644
index 00000000000..3168310f43d
--- /dev/null
+++ b/docs/generators/flash/index.html
@@ -0,0 +1,19 @@
+generators/flash · OpenAPI Generator
id: generator-opts-client-flash
+title: Config Options for flash
+sidebar_label: flash
+
+
+
+
Option
Description
Values
Default
+
+
+
packageName
flash package name (convention: package.name)
org.openapitools
+
packageVersion
flash package version
1.0.0
+
invokerPackage
root package for generated code
null
+
sourceFolder
source folder for generated code. e.g. flash
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/go-gin-server.html b/docs/generators/go-gin-server.html
new file mode 100644
index 00000000000..8c322dd5454
--- /dev/null
+++ b/docs/generators/go-gin-server.html
@@ -0,0 +1,17 @@
+generators/go-gin-server · OpenAPI Generator
id: generator-opts-server-go-gin-server
+title: Config Options for go-gin-server
+sidebar_label: go-gin-server
+
+
+
+
Option
Description
Values
Default
+
+
+
packageName
Go package name (convention: lowercase).
openapi
+
hideGenerationTimestamp
Hides the generation timestamp when files are generated.
true
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/go-gin-server/index.html b/docs/generators/go-gin-server/index.html
new file mode 100644
index 00000000000..8c322dd5454
--- /dev/null
+++ b/docs/generators/go-gin-server/index.html
@@ -0,0 +1,17 @@
+generators/go-gin-server · OpenAPI Generator
id: generator-opts-server-go-gin-server
+title: Config Options for go-gin-server
+sidebar_label: go-gin-server
+
+
+
+
Option
Description
Values
Default
+
+
+
packageName
Go package name (convention: lowercase).
openapi
+
hideGenerationTimestamp
Hides the generation timestamp when files are generated.
true
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/go-server.html b/docs/generators/go-server.html
new file mode 100644
index 00000000000..58c5952bbd8
--- /dev/null
+++ b/docs/generators/go-server.html
@@ -0,0 +1,17 @@
+generators/go-server · OpenAPI Generator
id: generator-opts-server-go-server
+title: Config Options for go-server
+sidebar_label: go-server
+
+
+
+
Option
Description
Values
Default
+
+
+
packageName
Go package name (convention: lowercase).
openapi
+
hideGenerationTimestamp
Hides the generation timestamp when files are generated.
true
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/go-server/index.html b/docs/generators/go-server/index.html
new file mode 100644
index 00000000000..58c5952bbd8
--- /dev/null
+++ b/docs/generators/go-server/index.html
@@ -0,0 +1,17 @@
+generators/go-server · OpenAPI Generator
id: generator-opts-server-go-server
+title: Config Options for go-server
+sidebar_label: go-server
+
+
+
+
Option
Description
Values
Default
+
+
+
packageName
Go package name (convention: lowercase).
openapi
+
hideGenerationTimestamp
Hides the generation timestamp when files are generated.
true
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/go.html b/docs/generators/go.html
new file mode 100644
index 00000000000..c7bed58be8f
--- /dev/null
+++ b/docs/generators/go.html
@@ -0,0 +1,21 @@
+generators/go · OpenAPI Generator
id: generator-opts-client-go
+title: Config Options for go
+sidebar_label: go
+
+
+
+
Option
Description
Values
Default
+
+
+
packageName
Go package name (convention: lowercase).
openapi
+
hideGenerationTimestamp
Hides the generation timestamp when files are generated.
true
+
packageVersion
Go package version.
1.0.0
+
withGoCodegenComment
whether to include Go codegen comment to disable Go Lint and collapse by default GitHub in PRs and diffs
false
+
withXml
whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/go/index.html b/docs/generators/go/index.html
new file mode 100644
index 00000000000..c7bed58be8f
--- /dev/null
+++ b/docs/generators/go/index.html
@@ -0,0 +1,21 @@
+generators/go · OpenAPI Generator
id: generator-opts-client-go
+title: Config Options for go
+sidebar_label: go
+
+
+
+
Option
Description
Values
Default
+
+
+
packageName
Go package name (convention: lowercase).
openapi
+
hideGenerationTimestamp
Hides the generation timestamp when files are generated.
true
+
packageVersion
Go package version.
1.0.0
+
withGoCodegenComment
whether to include Go codegen comment to disable Go Lint and collapse by default GitHub in PRs and diffs
false
+
withXml
whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/graphql-schema.html b/docs/generators/graphql-schema.html
new file mode 100644
index 00000000000..38f0174c6ae
--- /dev/null
+++ b/docs/generators/graphql-schema.html
@@ -0,0 +1,18 @@
+generators/graphql-schema · OpenAPI Generator
id: generator-opts-config-graphql-schema
+title: Config Options for graphql-schema
+sidebar_label: graphql-schema
+
+
+
+
Option
Description
Values
Default
+
+
+
packageName
GraphQL package name (convention: lowercase).
openapi2graphql
+
packageVersion
GraphQL package version.
1.0.0
+
hideGenerationTimestamp
Hides the generation timestamp when files are generated.
true
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/graphql-schema/index.html b/docs/generators/graphql-schema/index.html
new file mode 100644
index 00000000000..38f0174c6ae
--- /dev/null
+++ b/docs/generators/graphql-schema/index.html
@@ -0,0 +1,18 @@
+generators/graphql-schema · OpenAPI Generator
id: generator-opts-config-graphql-schema
+title: Config Options for graphql-schema
+sidebar_label: graphql-schema
+
+
+
+
Option
Description
Values
Default
+
+
+
packageName
GraphQL package name (convention: lowercase).
openapi2graphql
+
packageVersion
GraphQL package version.
1.0.0
+
hideGenerationTimestamp
Hides the generation timestamp when files are generated.
true
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/graphql-server.html b/docs/generators/graphql-server.html
new file mode 100644
index 00000000000..dec2bfb00c0
--- /dev/null
+++ b/docs/generators/graphql-server.html
@@ -0,0 +1,18 @@
+generators/graphql-server · OpenAPI Generator
id: generator-opts-server-graphql-server
+title: Config Options for graphql-server
+sidebar_label: graphql-server
+
+
+
+
Option
Description
Values
Default
+
+
+
packageName
GraphQL express server package name (convention: lowercase).
openapi3graphql-server
+
packageVersion
GraphQL express server package version.
1.0.0
+
hideGenerationTimestamp
Hides the generation timestamp when files are generated.
true
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/graphql-server/index.html b/docs/generators/graphql-server/index.html
new file mode 100644
index 00000000000..dec2bfb00c0
--- /dev/null
+++ b/docs/generators/graphql-server/index.html
@@ -0,0 +1,18 @@
+generators/graphql-server · OpenAPI Generator
id: generator-opts-server-graphql-server
+title: Config Options for graphql-server
+sidebar_label: graphql-server
+
+
+
+
Option
Description
Values
Default
+
+
+
packageName
GraphQL express server package name (convention: lowercase).
openapi3graphql-server
+
packageVersion
GraphQL express server package version.
1.0.0
+
hideGenerationTimestamp
Hides the generation timestamp when files are generated.
true
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/groovy.html b/docs/generators/groovy.html
new file mode 100644
index 00000000000..dcabc0079c8
--- /dev/null
+++ b/docs/generators/groovy.html
@@ -0,0 +1,51 @@
+generators/groovy · OpenAPI Generator
id: generator-opts-client-groovy
+title: Config Options for groovy
+sidebar_label: groovy
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
invokerPackage
root package for generated code
null
+
groupId
groupId in generated pom.xml
null
+
artifactId
artifactId in generated pom.xml
null
+
artifactVersion
artifact version in generated pom.xml
null
+
artifactUrl
artifact URL in generated pom.xml
null
+
artifactDescription
artifact description in generated pom.xml
null
+
scmConnection
SCM connection in generated pom.xml
null
+
scmDeveloperConnection
SCM developer connection in generated pom.xml
null
+
scmUrl
SCM URL in generated pom.xml
null
+
developerName
developer name in generated pom.xml
null
+
developerEmail
developer email in generated pom.xml
null
+
developerOrganization
developer organization in generated pom.xml
null
+
developerOrganizationUrl
developer organization URL in generated pom.xml
null
+
licenseName
The name of the license
null
+
licenseUrl
The URL of the license
null
+
sourceFolder
source folder for generated code
null
+
localVariablePrefix
prefix for generated code members and local variables
null
+
serializableModel
boolean - toggle "implements Serializable" for generated models
false
+
bigDecimalAsString
Treat BigDecimal values as Strings to avoid precision loss.
false
+
fullJavaUtil
whether to use fully qualified name for classes under java.util. This option only works for Java API client
false
+
hideGenerationTimestamp
hides the timestamp when files were generated
null
+
withXml
whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)
false
+
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)
null
+
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
null
+
disableHtmlEscaping
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)
false
+
booleanGetterPrefix
Set booleanGetterPrefix (default value 'get')
null
+
parentGroupId
parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentArtifactId
parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentVersion
parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
configPackage
configuration package for generated code
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/groovy/index.html b/docs/generators/groovy/index.html
new file mode 100644
index 00000000000..dcabc0079c8
--- /dev/null
+++ b/docs/generators/groovy/index.html
@@ -0,0 +1,51 @@
+generators/groovy · OpenAPI Generator
id: generator-opts-client-groovy
+title: Config Options for groovy
+sidebar_label: groovy
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
invokerPackage
root package for generated code
null
+
groupId
groupId in generated pom.xml
null
+
artifactId
artifactId in generated pom.xml
null
+
artifactVersion
artifact version in generated pom.xml
null
+
artifactUrl
artifact URL in generated pom.xml
null
+
artifactDescription
artifact description in generated pom.xml
null
+
scmConnection
SCM connection in generated pom.xml
null
+
scmDeveloperConnection
SCM developer connection in generated pom.xml
null
+
scmUrl
SCM URL in generated pom.xml
null
+
developerName
developer name in generated pom.xml
null
+
developerEmail
developer email in generated pom.xml
null
+
developerOrganization
developer organization in generated pom.xml
null
+
developerOrganizationUrl
developer organization URL in generated pom.xml
null
+
licenseName
The name of the license
null
+
licenseUrl
The URL of the license
null
+
sourceFolder
source folder for generated code
null
+
localVariablePrefix
prefix for generated code members and local variables
null
+
serializableModel
boolean - toggle "implements Serializable" for generated models
false
+
bigDecimalAsString
Treat BigDecimal values as Strings to avoid precision loss.
false
+
fullJavaUtil
whether to use fully qualified name for classes under java.util. This option only works for Java API client
false
+
hideGenerationTimestamp
hides the timestamp when files were generated
null
+
withXml
whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)
false
+
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)
null
+
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
null
+
disableHtmlEscaping
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)
false
+
booleanGetterPrefix
Set booleanGetterPrefix (default value 'get')
null
+
parentGroupId
parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentArtifactId
parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentVersion
parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
configPackage
configuration package for generated code
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/haskell-http-client.html b/docs/generators/haskell-http-client.html
new file mode 100644
index 00000000000..dfeaf665abb
--- /dev/null
+++ b/docs/generators/haskell-http-client.html
@@ -0,0 +1,38 @@
+generators/haskell-http-client · OpenAPI Generator
id: generator-opts-client-haskell-http-client
+title: Config Options for haskell-http-client
+sidebar_label: haskell-http-client
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
cabalPackage
Set the cabal package name, which consists of one or more alphanumeric words separated by hyphens
null
+
cabalVersion
Set the cabal version number, consisting of a sequence of one or more integers separated by dots
null
+
baseModule
Set the base module namespace
null
+
requestType
Set the name of the type used to generate requests
null
+
configType
Set the name of the type used for configuration
null
+
allowFromJsonNulls
allow JSON Null during model decoding from JSON
true
+
allowToJsonNulls
allow emitting JSON Null during model encoding to JSON
false
+
allowNonUniqueOperationIds
allow different API modules to contain the same operationId. Each API must be imported qualified
false
+
generateLenses
Generate Lens optics for Models
true
+
generateModelConstructors
Generate smart constructors (only supply required fields) for models
true
+
generateEnums
Generate specific datatypes for OpenAPI enums
true
+
generateFormUrlEncodedInstances
Generate FromForm/ToForm instances for models that are used by operations that produce or consume application/x-www-form-urlencoded
true
+
inlineMimeTypes
Inline (hardcode) the content-type and accept parameters on operations, when there is only 1 option
true
+
modelDeriving
Additional classes to include in the deriving() clause of Models
null
+
strictFields
Add strictness annotations to all model fields
true
+
useMonadLogger
Use the monad-logger package to provide logging (if false, use the katip logging package)
false
+
dateTimeFormat
format string used to parse/render a datetime
null
+
dateFormat
format string used to parse/render a date
%Y-%m-%d
+
hideGenerationTimestamp
Hides the generation timestamp when files are generated.
true
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/haskell-http-client/index.html b/docs/generators/haskell-http-client/index.html
new file mode 100644
index 00000000000..dfeaf665abb
--- /dev/null
+++ b/docs/generators/haskell-http-client/index.html
@@ -0,0 +1,38 @@
+generators/haskell-http-client · OpenAPI Generator
id: generator-opts-client-haskell-http-client
+title: Config Options for haskell-http-client
+sidebar_label: haskell-http-client
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
cabalPackage
Set the cabal package name, which consists of one or more alphanumeric words separated by hyphens
null
+
cabalVersion
Set the cabal version number, consisting of a sequence of one or more integers separated by dots
null
+
baseModule
Set the base module namespace
null
+
requestType
Set the name of the type used to generate requests
null
+
configType
Set the name of the type used for configuration
null
+
allowFromJsonNulls
allow JSON Null during model decoding from JSON
true
+
allowToJsonNulls
allow emitting JSON Null during model encoding to JSON
false
+
allowNonUniqueOperationIds
allow different API modules to contain the same operationId. Each API must be imported qualified
false
+
generateLenses
Generate Lens optics for Models
true
+
generateModelConstructors
Generate smart constructors (only supply required fields) for models
true
+
generateEnums
Generate specific datatypes for OpenAPI enums
true
+
generateFormUrlEncodedInstances
Generate FromForm/ToForm instances for models that are used by operations that produce or consume application/x-www-form-urlencoded
true
+
inlineMimeTypes
Inline (hardcode) the content-type and accept parameters on operations, when there is only 1 option
true
+
modelDeriving
Additional classes to include in the deriving() clause of Models
null
+
strictFields
Add strictness annotations to all model fields
true
+
useMonadLogger
Use the monad-logger package to provide logging (if false, use the katip logging package)
false
+
dateTimeFormat
format string used to parse/render a datetime
null
+
dateFormat
format string used to parse/render a date
%Y-%m-%d
+
hideGenerationTimestamp
Hides the generation timestamp when files are generated.
true
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/haskell.html b/docs/generators/haskell.html
new file mode 100644
index 00000000000..8a505e3bddb
--- /dev/null
+++ b/docs/generators/haskell.html
@@ -0,0 +1,21 @@
+generators/haskell · OpenAPI Generator
id: generator-opts-server-haskell
+title: Config Options for haskell
+sidebar_label: haskell
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/haskell/index.html b/docs/generators/haskell/index.html
new file mode 100644
index 00000000000..8a505e3bddb
--- /dev/null
+++ b/docs/generators/haskell/index.html
@@ -0,0 +1,21 @@
+generators/haskell · OpenAPI Generator
id: generator-opts-server-haskell
+title: Config Options for haskell
+sidebar_label: haskell
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/html.html b/docs/generators/html.html
new file mode 100644
index 00000000000..c825ae2bb8f
--- /dev/null
+++ b/docs/generators/html.html
@@ -0,0 +1,29 @@
+generators/html · OpenAPI Generator
id: generator-opts-documentation-html
+title: Config Options for html
+sidebar_label: html
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
appName
short name of the application
null
+
appDescription
description of the application
null
+
infoUrl
a URL where users can get more information about the application
null
+
infoEmail
an email address to contact for inquiries about the application
null
+
licenseInfo
a short description of the license
null
+
licenseUrl
a URL pointing to the full license
null
+
invokerPackage
root package for generated code
null
+
groupId
groupId in generated pom.xml
null
+
artifactId
artifactId in generated pom.xml
null
+
artifactVersion
artifact version in generated pom.xml
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/html/index.html b/docs/generators/html/index.html
new file mode 100644
index 00000000000..c825ae2bb8f
--- /dev/null
+++ b/docs/generators/html/index.html
@@ -0,0 +1,29 @@
+generators/html · OpenAPI Generator
id: generator-opts-documentation-html
+title: Config Options for html
+sidebar_label: html
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
appName
short name of the application
null
+
appDescription
description of the application
null
+
infoUrl
a URL where users can get more information about the application
null
+
infoEmail
an email address to contact for inquiries about the application
null
+
licenseInfo
a short description of the license
null
+
licenseUrl
a URL pointing to the full license
null
+
invokerPackage
root package for generated code
null
+
groupId
groupId in generated pom.xml
null
+
artifactId
artifactId in generated pom.xml
null
+
artifactVersion
artifact version in generated pom.xml
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/html2.html b/docs/generators/html2.html
new file mode 100644
index 00000000000..9ff8e333bef
--- /dev/null
+++ b/docs/generators/html2.html
@@ -0,0 +1,33 @@
+generators/html2 · OpenAPI Generator
id: generator-opts-documentation-html2
+title: Config Options for html2
+sidebar_label: html2
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
appName
short name of the application
null
+
appDescription
description of the application
null
+
infoUrl
a URL where users can get more information about the application
null
+
infoEmail
an email address to contact for inquiries about the application
null
+
licenseInfo
a short description of the license
null
+
licenseUrl
a URL pointing to the full license
null
+
invokerPackage
root package for generated code
null
+
phpInvokerPackage
root package for generated php code
null
+
perlModuleName
root module name for generated perl code
null
+
pythonPackageName
package name for generated python code
null
+
packageName
C# package name
null
+
groupId
groupId in generated pom.xml
null
+
artifactId
artifactId in generated pom.xml
null
+
artifactVersion
artifact version in generated pom.xml
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/html2/index.html b/docs/generators/html2/index.html
new file mode 100644
index 00000000000..9ff8e333bef
--- /dev/null
+++ b/docs/generators/html2/index.html
@@ -0,0 +1,33 @@
+generators/html2 · OpenAPI Generator
id: generator-opts-documentation-html2
+title: Config Options for html2
+sidebar_label: html2
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
appName
short name of the application
null
+
appDescription
description of the application
null
+
infoUrl
a URL where users can get more information about the application
null
+
infoEmail
an email address to contact for inquiries about the application
null
+
licenseInfo
a short description of the license
null
+
licenseUrl
a URL pointing to the full license
null
+
invokerPackage
root package for generated code
null
+
phpInvokerPackage
root package for generated php code
null
+
perlModuleName
root module name for generated perl code
null
+
pythonPackageName
package name for generated python code
null
+
packageName
C# package name
null
+
groupId
groupId in generated pom.xml
null
+
artifactId
artifactId in generated pom.xml
null
+
artifactVersion
artifact version in generated pom.xml
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/index.html b/docs/generators/index.html
new file mode 100644
index 00000000000..a0f78fdd64d
--- /dev/null
+++ b/docs/generators/index.html
@@ -0,0 +1,160 @@
+Generators List · OpenAPI Generator
\ No newline at end of file
diff --git a/docs/generators/java-inflector.html b/docs/generators/java-inflector.html
new file mode 100644
index 00000000000..d58f5d65c2b
--- /dev/null
+++ b/docs/generators/java-inflector.html
@@ -0,0 +1,50 @@
+generators/java-inflector · OpenAPI Generator
id: generator-opts-server-java-inflector
+title: Config Options for java-inflector
+sidebar_label: java-inflector
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
invokerPackage
root package for generated code
null
+
groupId
groupId in generated pom.xml
null
+
artifactId
artifactId in generated pom.xml
null
+
artifactVersion
artifact version in generated pom.xml
null
+
artifactUrl
artifact URL in generated pom.xml
null
+
artifactDescription
artifact description in generated pom.xml
null
+
scmConnection
SCM connection in generated pom.xml
null
+
scmDeveloperConnection
SCM developer connection in generated pom.xml
null
+
scmUrl
SCM URL in generated pom.xml
null
+
developerName
developer name in generated pom.xml
null
+
developerEmail
developer email in generated pom.xml
null
+
developerOrganization
developer organization in generated pom.xml
null
+
developerOrganizationUrl
developer organization URL in generated pom.xml
null
+
licenseName
The name of the license
null
+
licenseUrl
The URL of the license
null
+
sourceFolder
source folder for generated code
null
+
localVariablePrefix
prefix for generated code members and local variables
null
+
serializableModel
boolean - toggle "implements Serializable" for generated models
false
+
bigDecimalAsString
Treat BigDecimal values as Strings to avoid precision loss.
false
+
fullJavaUtil
whether to use fully qualified name for classes under java.util. This option only works for Java API client
false
+
hideGenerationTimestamp
hides the timestamp when files were generated
null
+
withXml
whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)
false
+
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)
null
+
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
null
+
disableHtmlEscaping
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)
false
+
booleanGetterPrefix
Set booleanGetterPrefix (default value 'get')
null
+
parentGroupId
parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentArtifactId
parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentVersion
parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/java-inflector/index.html b/docs/generators/java-inflector/index.html
new file mode 100644
index 00000000000..d58f5d65c2b
--- /dev/null
+++ b/docs/generators/java-inflector/index.html
@@ -0,0 +1,50 @@
+generators/java-inflector · OpenAPI Generator
id: generator-opts-server-java-inflector
+title: Config Options for java-inflector
+sidebar_label: java-inflector
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
invokerPackage
root package for generated code
null
+
groupId
groupId in generated pom.xml
null
+
artifactId
artifactId in generated pom.xml
null
+
artifactVersion
artifact version in generated pom.xml
null
+
artifactUrl
artifact URL in generated pom.xml
null
+
artifactDescription
artifact description in generated pom.xml
null
+
scmConnection
SCM connection in generated pom.xml
null
+
scmDeveloperConnection
SCM developer connection in generated pom.xml
null
+
scmUrl
SCM URL in generated pom.xml
null
+
developerName
developer name in generated pom.xml
null
+
developerEmail
developer email in generated pom.xml
null
+
developerOrganization
developer organization in generated pom.xml
null
+
developerOrganizationUrl
developer organization URL in generated pom.xml
null
+
licenseName
The name of the license
null
+
licenseUrl
The URL of the license
null
+
sourceFolder
source folder for generated code
null
+
localVariablePrefix
prefix for generated code members and local variables
null
+
serializableModel
boolean - toggle "implements Serializable" for generated models
false
+
bigDecimalAsString
Treat BigDecimal values as Strings to avoid precision loss.
false
+
fullJavaUtil
whether to use fully qualified name for classes under java.util. This option only works for Java API client
false
+
hideGenerationTimestamp
hides the timestamp when files were generated
null
+
withXml
whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)
false
+
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)
null
+
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
null
+
disableHtmlEscaping
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)
false
+
booleanGetterPrefix
Set booleanGetterPrefix (default value 'get')
null
+
parentGroupId
parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentArtifactId
parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentVersion
parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/java-msf4j.html b/docs/generators/java-msf4j.html
new file mode 100644
index 00000000000..1b6f5854c5b
--- /dev/null
+++ b/docs/generators/java-msf4j.html
@@ -0,0 +1,55 @@
+generators/java-msf4j · OpenAPI Generator
id: generator-opts-server-java-msf4j
+title: Config Options for java-msf4j
+sidebar_label: java-msf4j
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
invokerPackage
root package for generated code
null
+
groupId
groupId in generated pom.xml
null
+
artifactId
artifactId in generated pom.xml
null
+
artifactVersion
artifact version in generated pom.xml
null
+
artifactUrl
artifact URL in generated pom.xml
null
+
artifactDescription
artifact description in generated pom.xml
null
+
scmConnection
SCM connection in generated pom.xml
null
+
scmDeveloperConnection
SCM developer connection in generated pom.xml
null
+
scmUrl
SCM URL in generated pom.xml
null
+
developerName
developer name in generated pom.xml
null
+
developerEmail
developer email in generated pom.xml
null
+
developerOrganization
developer organization in generated pom.xml
null
+
developerOrganizationUrl
developer organization URL in generated pom.xml
null
+
licenseName
The name of the license
null
+
licenseUrl
The URL of the license
null
+
sourceFolder
source folder for generated code
null
+
localVariablePrefix
prefix for generated code members and local variables
null
+
serializableModel
boolean - toggle "implements Serializable" for generated models
false
+
bigDecimalAsString
Treat BigDecimal values as Strings to avoid precision loss.
false
+
fullJavaUtil
whether to use fully qualified name for classes under java.util. This option only works for Java API client
false
+
hideGenerationTimestamp
hides the timestamp when files were generated
null
+
withXml
whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)
false
+
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)
null
+
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
null
+
disableHtmlEscaping
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)
false
+
booleanGetterPrefix
Set booleanGetterPrefix (default value 'get')
null
+
parentGroupId
parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentArtifactId
parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentVersion
parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
implFolder
folder for generated implementation code
null
+
title
a title describing the application
null
+
useBeanValidation
Use BeanValidation API annotations
true
+
serverPort
The port on which the server should be started
null
+
library
library template (sub-template) to use
jersey1
Jersey core 1.x
jersey2
Jersey core 2.x
jersey2
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/java-msf4j/index.html b/docs/generators/java-msf4j/index.html
new file mode 100644
index 00000000000..1b6f5854c5b
--- /dev/null
+++ b/docs/generators/java-msf4j/index.html
@@ -0,0 +1,55 @@
+generators/java-msf4j · OpenAPI Generator
id: generator-opts-server-java-msf4j
+title: Config Options for java-msf4j
+sidebar_label: java-msf4j
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
invokerPackage
root package for generated code
null
+
groupId
groupId in generated pom.xml
null
+
artifactId
artifactId in generated pom.xml
null
+
artifactVersion
artifact version in generated pom.xml
null
+
artifactUrl
artifact URL in generated pom.xml
null
+
artifactDescription
artifact description in generated pom.xml
null
+
scmConnection
SCM connection in generated pom.xml
null
+
scmDeveloperConnection
SCM developer connection in generated pom.xml
null
+
scmUrl
SCM URL in generated pom.xml
null
+
developerName
developer name in generated pom.xml
null
+
developerEmail
developer email in generated pom.xml
null
+
developerOrganization
developer organization in generated pom.xml
null
+
developerOrganizationUrl
developer organization URL in generated pom.xml
null
+
licenseName
The name of the license
null
+
licenseUrl
The URL of the license
null
+
sourceFolder
source folder for generated code
null
+
localVariablePrefix
prefix for generated code members and local variables
null
+
serializableModel
boolean - toggle "implements Serializable" for generated models
false
+
bigDecimalAsString
Treat BigDecimal values as Strings to avoid precision loss.
false
+
fullJavaUtil
whether to use fully qualified name for classes under java.util. This option only works for Java API client
false
+
hideGenerationTimestamp
hides the timestamp when files were generated
null
+
withXml
whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)
false
+
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)
null
+
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
null
+
disableHtmlEscaping
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)
false
+
booleanGetterPrefix
Set booleanGetterPrefix (default value 'get')
null
+
parentGroupId
parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentArtifactId
parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentVersion
parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
implFolder
folder for generated implementation code
null
+
title
a title describing the application
null
+
useBeanValidation
Use BeanValidation API annotations
true
+
serverPort
The port on which the server should be started
null
+
library
library template (sub-template) to use
jersey1
Jersey core 1.x
jersey2
Jersey core 2.x
jersey2
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/java-pkmst.html b/docs/generators/java-pkmst.html
new file mode 100644
index 00000000000..600bf60660d
--- /dev/null
+++ b/docs/generators/java-pkmst.html
@@ -0,0 +1,60 @@
+generators/java-pkmst · OpenAPI Generator
id: generator-opts-server-java-pkmst
+title: Config Options for java-pkmst
+sidebar_label: java-pkmst
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
invokerPackage
root package for generated code
null
+
groupId
groupId in generated pom.xml
null
+
artifactId
artifactId in generated pom.xml
null
+
artifactVersion
artifact version in generated pom.xml
null
+
artifactUrl
artifact URL in generated pom.xml
null
+
artifactDescription
artifact description in generated pom.xml
null
+
scmConnection
SCM connection in generated pom.xml
null
+
scmDeveloperConnection
SCM developer connection in generated pom.xml
null
+
scmUrl
SCM URL in generated pom.xml
null
+
developerName
developer name in generated pom.xml
null
+
developerEmail
developer email in generated pom.xml
null
+
developerOrganization
developer organization in generated pom.xml
null
+
developerOrganizationUrl
developer organization URL in generated pom.xml
null
+
licenseName
The name of the license
null
+
licenseUrl
The URL of the license
null
+
sourceFolder
source folder for generated code
null
+
localVariablePrefix
prefix for generated code members and local variables
null
+
serializableModel
boolean - toggle "implements Serializable" for generated models
false
+
bigDecimalAsString
Treat BigDecimal values as Strings to avoid precision loss.
false
+
fullJavaUtil
whether to use fully qualified name for classes under java.util. This option only works for Java API client
false
+
hideGenerationTimestamp
hides the timestamp when files were generated
null
+
withXml
whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)
false
+
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)
null
+
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
null
+
disableHtmlEscaping
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)
false
+
booleanGetterPrefix
Set booleanGetterPrefix (default value 'get')
null
+
parentGroupId
parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentArtifactId
parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentVersion
parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
groupId
groupId in generated pom.xml
null
+
artifactId
artifactId in generated pom.xml
null
+
artifactVersion
artifact version in generated pom.xml
null
+
basePackage
base package for java source code
null
+
serviceName
Service Name
null
+
title
server title name or client service name
null
+
eurekaUri
Eureka URI
null
+
zipkinUri
Zipkin URI
null
+
springBootAdminUri
Spring-Boot URI
null
+
pkmstInterceptor
PKMST Interceptor
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/java-pkmst/index.html b/docs/generators/java-pkmst/index.html
new file mode 100644
index 00000000000..600bf60660d
--- /dev/null
+++ b/docs/generators/java-pkmst/index.html
@@ -0,0 +1,60 @@
+generators/java-pkmst · OpenAPI Generator
id: generator-opts-server-java-pkmst
+title: Config Options for java-pkmst
+sidebar_label: java-pkmst
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
invokerPackage
root package for generated code
null
+
groupId
groupId in generated pom.xml
null
+
artifactId
artifactId in generated pom.xml
null
+
artifactVersion
artifact version in generated pom.xml
null
+
artifactUrl
artifact URL in generated pom.xml
null
+
artifactDescription
artifact description in generated pom.xml
null
+
scmConnection
SCM connection in generated pom.xml
null
+
scmDeveloperConnection
SCM developer connection in generated pom.xml
null
+
scmUrl
SCM URL in generated pom.xml
null
+
developerName
developer name in generated pom.xml
null
+
developerEmail
developer email in generated pom.xml
null
+
developerOrganization
developer organization in generated pom.xml
null
+
developerOrganizationUrl
developer organization URL in generated pom.xml
null
+
licenseName
The name of the license
null
+
licenseUrl
The URL of the license
null
+
sourceFolder
source folder for generated code
null
+
localVariablePrefix
prefix for generated code members and local variables
null
+
serializableModel
boolean - toggle "implements Serializable" for generated models
false
+
bigDecimalAsString
Treat BigDecimal values as Strings to avoid precision loss.
false
+
fullJavaUtil
whether to use fully qualified name for classes under java.util. This option only works for Java API client
false
+
hideGenerationTimestamp
hides the timestamp when files were generated
null
+
withXml
whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)
false
+
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)
null
+
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
null
+
disableHtmlEscaping
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)
false
+
booleanGetterPrefix
Set booleanGetterPrefix (default value 'get')
null
+
parentGroupId
parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentArtifactId
parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentVersion
parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
groupId
groupId in generated pom.xml
null
+
artifactId
artifactId in generated pom.xml
null
+
artifactVersion
artifact version in generated pom.xml
null
+
basePackage
base package for java source code
null
+
serviceName
Service Name
null
+
title
server title name or client service name
null
+
eurekaUri
Eureka URI
null
+
zipkinUri
Zipkin URI
null
+
springBootAdminUri
Spring-Boot URI
null
+
pkmstInterceptor
PKMST Interceptor
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/java-play-framework.html b/docs/generators/java-play-framework.html
new file mode 100644
index 00000000000..1af3f6c194d
--- /dev/null
+++ b/docs/generators/java-play-framework.html
@@ -0,0 +1,59 @@
+generators/java-play-framework · OpenAPI Generator
id: generator-opts-server-java-play-framework
+title: Config Options for java-play-framework
+sidebar_label: java-play-framework
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
invokerPackage
root package for generated code
null
+
groupId
groupId in generated pom.xml
null
+
artifactId
artifactId in generated pom.xml
null
+
artifactVersion
artifact version in generated pom.xml
null
+
artifactUrl
artifact URL in generated pom.xml
null
+
artifactDescription
artifact description in generated pom.xml
null
+
scmConnection
SCM connection in generated pom.xml
null
+
scmDeveloperConnection
SCM developer connection in generated pom.xml
null
+
scmUrl
SCM URL in generated pom.xml
null
+
developerName
developer name in generated pom.xml
null
+
developerEmail
developer email in generated pom.xml
null
+
developerOrganization
developer organization in generated pom.xml
null
+
developerOrganizationUrl
developer organization URL in generated pom.xml
null
+
licenseName
The name of the license
null
+
licenseUrl
The URL of the license
null
+
sourceFolder
source folder for generated code
null
+
localVariablePrefix
prefix for generated code members and local variables
null
+
serializableModel
boolean - toggle "implements Serializable" for generated models
false
+
bigDecimalAsString
Treat BigDecimal values as Strings to avoid precision loss.
false
+
fullJavaUtil
whether to use fully qualified name for classes under java.util. This option only works for Java API client
false
+
hideGenerationTimestamp
hides the timestamp when files were generated
null
+
withXml
whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)
false
+
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)
null
+
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
null
+
disableHtmlEscaping
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)
false
+
booleanGetterPrefix
Set booleanGetterPrefix (default value 'get')
null
+
parentGroupId
parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentArtifactId
parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentVersion
parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
title
server title name or client service name
null
+
configPackage
configuration package for generated code
null
+
basePackage
base package for generated code
null
+
controllerOnly
Whether to generate only API interface stubs without the server files.
false
+
useBeanValidation
Use BeanValidation API annotations
true
+
useInterfaces
Makes the controllerImp implements an interface to facilitate automatic completion when updating from version x to y of your spec
true
+
handleExceptions
Add a 'throw exception' to each controller function. Add also a custom error handler where you can put your custom logic
true
+
wrapCalls
Add a wrapper to each controller function to handle things like metrics, response modification, etc..
true
+
useSwaggerUI
Add a route to /api which show your documentation in swagger-ui. Will also import needed dependencies
true
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/java-play-framework/index.html b/docs/generators/java-play-framework/index.html
new file mode 100644
index 00000000000..1af3f6c194d
--- /dev/null
+++ b/docs/generators/java-play-framework/index.html
@@ -0,0 +1,59 @@
+generators/java-play-framework · OpenAPI Generator
id: generator-opts-server-java-play-framework
+title: Config Options for java-play-framework
+sidebar_label: java-play-framework
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
invokerPackage
root package for generated code
null
+
groupId
groupId in generated pom.xml
null
+
artifactId
artifactId in generated pom.xml
null
+
artifactVersion
artifact version in generated pom.xml
null
+
artifactUrl
artifact URL in generated pom.xml
null
+
artifactDescription
artifact description in generated pom.xml
null
+
scmConnection
SCM connection in generated pom.xml
null
+
scmDeveloperConnection
SCM developer connection in generated pom.xml
null
+
scmUrl
SCM URL in generated pom.xml
null
+
developerName
developer name in generated pom.xml
null
+
developerEmail
developer email in generated pom.xml
null
+
developerOrganization
developer organization in generated pom.xml
null
+
developerOrganizationUrl
developer organization URL in generated pom.xml
null
+
licenseName
The name of the license
null
+
licenseUrl
The URL of the license
null
+
sourceFolder
source folder for generated code
null
+
localVariablePrefix
prefix for generated code members and local variables
null
+
serializableModel
boolean - toggle "implements Serializable" for generated models
false
+
bigDecimalAsString
Treat BigDecimal values as Strings to avoid precision loss.
false
+
fullJavaUtil
whether to use fully qualified name for classes under java.util. This option only works for Java API client
false
+
hideGenerationTimestamp
hides the timestamp when files were generated
null
+
withXml
whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)
false
+
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)
null
+
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
null
+
disableHtmlEscaping
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)
false
+
booleanGetterPrefix
Set booleanGetterPrefix (default value 'get')
null
+
parentGroupId
parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentArtifactId
parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentVersion
parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
title
server title name or client service name
null
+
configPackage
configuration package for generated code
null
+
basePackage
base package for generated code
null
+
controllerOnly
Whether to generate only API interface stubs without the server files.
false
+
useBeanValidation
Use BeanValidation API annotations
true
+
useInterfaces
Makes the controllerImp implements an interface to facilitate automatic completion when updating from version x to y of your spec
true
+
handleExceptions
Add a 'throw exception' to each controller function. Add also a custom error handler where you can put your custom logic
true
+
wrapCalls
Add a wrapper to each controller function to handle things like metrics, response modification, etc..
true
+
useSwaggerUI
Add a route to /api which show your documentation in swagger-ui. Will also import needed dependencies
true
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/java-undertow-server.html b/docs/generators/java-undertow-server.html
new file mode 100644
index 00000000000..f7a5284386f
--- /dev/null
+++ b/docs/generators/java-undertow-server.html
@@ -0,0 +1,50 @@
+generators/java-undertow-server · OpenAPI Generator
id: generator-opts-server-java-undertow-server
+title: Config Options for java-undertow-server
+sidebar_label: java-undertow-server
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
invokerPackage
root package for generated code
null
+
groupId
groupId in generated pom.xml
null
+
artifactId
artifactId in generated pom.xml
null
+
artifactVersion
artifact version in generated pom.xml
null
+
artifactUrl
artifact URL in generated pom.xml
null
+
artifactDescription
artifact description in generated pom.xml
null
+
scmConnection
SCM connection in generated pom.xml
null
+
scmDeveloperConnection
SCM developer connection in generated pom.xml
null
+
scmUrl
SCM URL in generated pom.xml
null
+
developerName
developer name in generated pom.xml
null
+
developerEmail
developer email in generated pom.xml
null
+
developerOrganization
developer organization in generated pom.xml
null
+
developerOrganizationUrl
developer organization URL in generated pom.xml
null
+
licenseName
The name of the license
null
+
licenseUrl
The URL of the license
null
+
sourceFolder
source folder for generated code
null
+
localVariablePrefix
prefix for generated code members and local variables
null
+
serializableModel
boolean - toggle "implements Serializable" for generated models
false
+
bigDecimalAsString
Treat BigDecimal values as Strings to avoid precision loss.
false
+
fullJavaUtil
whether to use fully qualified name for classes under java.util. This option only works for Java API client
false
+
hideGenerationTimestamp
hides the timestamp when files were generated
null
+
withXml
whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)
false
+
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)
null
+
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
null
+
disableHtmlEscaping
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)
false
+
booleanGetterPrefix
Set booleanGetterPrefix (default value 'get')
null
+
parentGroupId
parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentArtifactId
parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentVersion
parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/java-undertow-server/index.html b/docs/generators/java-undertow-server/index.html
new file mode 100644
index 00000000000..f7a5284386f
--- /dev/null
+++ b/docs/generators/java-undertow-server/index.html
@@ -0,0 +1,50 @@
+generators/java-undertow-server · OpenAPI Generator
id: generator-opts-server-java-undertow-server
+title: Config Options for java-undertow-server
+sidebar_label: java-undertow-server
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
invokerPackage
root package for generated code
null
+
groupId
groupId in generated pom.xml
null
+
artifactId
artifactId in generated pom.xml
null
+
artifactVersion
artifact version in generated pom.xml
null
+
artifactUrl
artifact URL in generated pom.xml
null
+
artifactDescription
artifact description in generated pom.xml
null
+
scmConnection
SCM connection in generated pom.xml
null
+
scmDeveloperConnection
SCM developer connection in generated pom.xml
null
+
scmUrl
SCM URL in generated pom.xml
null
+
developerName
developer name in generated pom.xml
null
+
developerEmail
developer email in generated pom.xml
null
+
developerOrganization
developer organization in generated pom.xml
null
+
developerOrganizationUrl
developer organization URL in generated pom.xml
null
+
licenseName
The name of the license
null
+
licenseUrl
The URL of the license
null
+
sourceFolder
source folder for generated code
null
+
localVariablePrefix
prefix for generated code members and local variables
null
+
serializableModel
boolean - toggle "implements Serializable" for generated models
false
+
bigDecimalAsString
Treat BigDecimal values as Strings to avoid precision loss.
false
+
fullJavaUtil
whether to use fully qualified name for classes under java.util. This option only works for Java API client
false
+
hideGenerationTimestamp
hides the timestamp when files were generated
null
+
withXml
whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)
false
+
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)
null
+
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
null
+
disableHtmlEscaping
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)
false
+
booleanGetterPrefix
Set booleanGetterPrefix (default value 'get')
null
+
parentGroupId
parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentArtifactId
parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentVersion
parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/java-vertx.html b/docs/generators/java-vertx.html
new file mode 100644
index 00000000000..31970848bef
--- /dev/null
+++ b/docs/generators/java-vertx.html
@@ -0,0 +1,52 @@
+generators/java-vertx · OpenAPI Generator
id: generator-opts-server-java-vertx
+title: Config Options for java-vertx
+sidebar_label: java-vertx
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
invokerPackage
root package for generated code
null
+
groupId
groupId in generated pom.xml
null
+
artifactId
artifactId in generated pom.xml
null
+
artifactVersion
artifact version in generated pom.xml
null
+
artifactUrl
artifact URL in generated pom.xml
null
+
artifactDescription
artifact description in generated pom.xml
null
+
scmConnection
SCM connection in generated pom.xml
null
+
scmDeveloperConnection
SCM developer connection in generated pom.xml
null
+
scmUrl
SCM URL in generated pom.xml
null
+
developerName
developer name in generated pom.xml
null
+
developerEmail
developer email in generated pom.xml
null
+
developerOrganization
developer organization in generated pom.xml
null
+
developerOrganizationUrl
developer organization URL in generated pom.xml
null
+
licenseName
The name of the license
null
+
licenseUrl
The URL of the license
null
+
sourceFolder
source folder for generated code
null
+
localVariablePrefix
prefix for generated code members and local variables
null
+
serializableModel
boolean - toggle "implements Serializable" for generated models
false
+
bigDecimalAsString
Treat BigDecimal values as Strings to avoid precision loss.
false
+
fullJavaUtil
whether to use fully qualified name for classes under java.util. This option only works for Java API client
false
+
hideGenerationTimestamp
hides the timestamp when files were generated
null
+
withXml
whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)
false
+
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)
null
+
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
null
+
disableHtmlEscaping
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)
false
+
booleanGetterPrefix
Set booleanGetterPrefix (default value 'get')
null
+
parentGroupId
parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentArtifactId
parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentVersion
parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
rxInterface
When specified, API interfaces are generated with RX and methods return Single<> and Comparable.
false
+
vertxSwaggerRouterVersion
Specify the version of the swagger router library
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/java-vertx/index.html b/docs/generators/java-vertx/index.html
new file mode 100644
index 00000000000..31970848bef
--- /dev/null
+++ b/docs/generators/java-vertx/index.html
@@ -0,0 +1,52 @@
+generators/java-vertx · OpenAPI Generator
id: generator-opts-server-java-vertx
+title: Config Options for java-vertx
+sidebar_label: java-vertx
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
invokerPackage
root package for generated code
null
+
groupId
groupId in generated pom.xml
null
+
artifactId
artifactId in generated pom.xml
null
+
artifactVersion
artifact version in generated pom.xml
null
+
artifactUrl
artifact URL in generated pom.xml
null
+
artifactDescription
artifact description in generated pom.xml
null
+
scmConnection
SCM connection in generated pom.xml
null
+
scmDeveloperConnection
SCM developer connection in generated pom.xml
null
+
scmUrl
SCM URL in generated pom.xml
null
+
developerName
developer name in generated pom.xml
null
+
developerEmail
developer email in generated pom.xml
null
+
developerOrganization
developer organization in generated pom.xml
null
+
developerOrganizationUrl
developer organization URL in generated pom.xml
null
+
licenseName
The name of the license
null
+
licenseUrl
The URL of the license
null
+
sourceFolder
source folder for generated code
null
+
localVariablePrefix
prefix for generated code members and local variables
null
+
serializableModel
boolean - toggle "implements Serializable" for generated models
false
+
bigDecimalAsString
Treat BigDecimal values as Strings to avoid precision loss.
false
+
fullJavaUtil
whether to use fully qualified name for classes under java.util. This option only works for Java API client
false
+
hideGenerationTimestamp
hides the timestamp when files were generated
null
+
withXml
whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)
false
+
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)
null
+
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
null
+
disableHtmlEscaping
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)
false
+
booleanGetterPrefix
Set booleanGetterPrefix (default value 'get')
null
+
parentGroupId
parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentArtifactId
parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentVersion
parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
rxInterface
When specified, API interfaces are generated with RX and methods return Single<> and Comparable.
false
+
vertxSwaggerRouterVersion
Specify the version of the swagger router library
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/java.html b/docs/generators/java.html
new file mode 100644
index 00000000000..9fa65c89936
--- /dev/null
+++ b/docs/generators/java.html
@@ -0,0 +1,63 @@
+generators/java · OpenAPI Generator
id: generator-opts-client-java
+title: Config Options for java
+sidebar_label: java
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
invokerPackage
root package for generated code
null
+
groupId
groupId in generated pom.xml
null
+
artifactId
artifactId in generated pom.xml
null
+
artifactVersion
artifact version in generated pom.xml
null
+
artifactUrl
artifact URL in generated pom.xml
null
+
artifactDescription
artifact description in generated pom.xml
null
+
scmConnection
SCM connection in generated pom.xml
null
+
scmDeveloperConnection
SCM developer connection in generated pom.xml
null
+
scmUrl
SCM URL in generated pom.xml
null
+
developerName
developer name in generated pom.xml
null
+
developerEmail
developer email in generated pom.xml
null
+
developerOrganization
developer organization in generated pom.xml
null
+
developerOrganizationUrl
developer organization URL in generated pom.xml
null
+
licenseName
The name of the license
null
+
licenseUrl
The URL of the license
null
+
sourceFolder
source folder for generated code
null
+
localVariablePrefix
prefix for generated code members and local variables
null
+
serializableModel
boolean - toggle "implements Serializable" for generated models
false
+
bigDecimalAsString
Treat BigDecimal values as Strings to avoid precision loss.
false
+
fullJavaUtil
whether to use fully qualified name for classes under java.util. This option only works for Java API client
false
+
hideGenerationTimestamp
hides the timestamp when files were generated
null
+
withXml
whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)
false
+
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)
null
+
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
null
+
disableHtmlEscaping
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)
false
+
booleanGetterPrefix
Set booleanGetterPrefix (default value 'get')
null
+
parentGroupId
parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentArtifactId
parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentVersion
parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
useRxJava
Whether to use the RxJava adapter with the retrofit2 library.
false
+
useRxJava2
Whether to use the RxJava2 adapter with the retrofit2 library.
false
+
parcelableModel
Whether to generate models for Android that implement Parcelable with the okhttp-gson library.
false
+
usePlayWS
Use Play! Async HTTP client (Play WS API)
false
+
playVersion
Version of Play! Framework (possible values "play24", "play25" (default), "play26")
null
+
supportJava6
Whether to support Java6 with the Jersey1 library.
false
+
useBeanValidation
Use BeanValidation API annotations
false
+
performBeanValidation
Perform BeanValidation
false
+
useGzipFeature
Send gzip-encoded requests
false
+
useRuntimeException
Use RuntimeException instead of Exception
false
+
feignVersion
Version of OpenFeign: '10.x', '9.x' (default)
false
+
useReflectionEqualsHashCode
Use org.apache.commons.lang3.builder for equals and hashCode in the models. WARNING: This will fail under a security manager, unless the appropriate permissions are set up correctly and also there's potential performance impact.
false
+
library
library template (sub-template) to use
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. To enable OpenFeign 10.x, set the 'feignVersion' option to '10.x'
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
okhttp-gson
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/java/index.html b/docs/generators/java/index.html
new file mode 100644
index 00000000000..9fa65c89936
--- /dev/null
+++ b/docs/generators/java/index.html
@@ -0,0 +1,63 @@
+generators/java · OpenAPI Generator
id: generator-opts-client-java
+title: Config Options for java
+sidebar_label: java
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
invokerPackage
root package for generated code
null
+
groupId
groupId in generated pom.xml
null
+
artifactId
artifactId in generated pom.xml
null
+
artifactVersion
artifact version in generated pom.xml
null
+
artifactUrl
artifact URL in generated pom.xml
null
+
artifactDescription
artifact description in generated pom.xml
null
+
scmConnection
SCM connection in generated pom.xml
null
+
scmDeveloperConnection
SCM developer connection in generated pom.xml
null
+
scmUrl
SCM URL in generated pom.xml
null
+
developerName
developer name in generated pom.xml
null
+
developerEmail
developer email in generated pom.xml
null
+
developerOrganization
developer organization in generated pom.xml
null
+
developerOrganizationUrl
developer organization URL in generated pom.xml
null
+
licenseName
The name of the license
null
+
licenseUrl
The URL of the license
null
+
sourceFolder
source folder for generated code
null
+
localVariablePrefix
prefix for generated code members and local variables
null
+
serializableModel
boolean - toggle "implements Serializable" for generated models
false
+
bigDecimalAsString
Treat BigDecimal values as Strings to avoid precision loss.
false
+
fullJavaUtil
whether to use fully qualified name for classes under java.util. This option only works for Java API client
false
+
hideGenerationTimestamp
hides the timestamp when files were generated
null
+
withXml
whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)
false
+
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)
null
+
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
null
+
disableHtmlEscaping
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)
false
+
booleanGetterPrefix
Set booleanGetterPrefix (default value 'get')
null
+
parentGroupId
parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentArtifactId
parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentVersion
parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
useRxJava
Whether to use the RxJava adapter with the retrofit2 library.
false
+
useRxJava2
Whether to use the RxJava2 adapter with the retrofit2 library.
false
+
parcelableModel
Whether to generate models for Android that implement Parcelable with the okhttp-gson library.
false
+
usePlayWS
Use Play! Async HTTP client (Play WS API)
false
+
playVersion
Version of Play! Framework (possible values "play24", "play25" (default), "play26")
null
+
supportJava6
Whether to support Java6 with the Jersey1 library.
false
+
useBeanValidation
Use BeanValidation API annotations
false
+
performBeanValidation
Perform BeanValidation
false
+
useGzipFeature
Send gzip-encoded requests
false
+
useRuntimeException
Use RuntimeException instead of Exception
false
+
feignVersion
Version of OpenFeign: '10.x', '9.x' (default)
false
+
useReflectionEqualsHashCode
Use org.apache.commons.lang3.builder for equals and hashCode in the models. WARNING: This will fail under a security manager, unless the appropriate permissions are set up correctly and also there's potential performance impact.
false
+
library
library template (sub-template) to use
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. To enable OpenFeign 10.x, set the 'feignVersion' option to '10.x'
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
okhttp-gson
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/javascript-closure-angular.html b/docs/generators/javascript-closure-angular.html
new file mode 100644
index 00000000000..9be4377ab06
--- /dev/null
+++ b/docs/generators/javascript-closure-angular.html
@@ -0,0 +1,21 @@
+generators/javascript-closure-angular · OpenAPI Generator
id: generator-opts-client-javascript-closure-angular
+title: Config Options for javascript-closure-angular
+sidebar_label: javascript-closure-angular
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
hideGenerationTimestamp
Hides the generation timestamp when files are generated.
true
+
useEs6
use ES6 templates
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/javascript-closure-angular/index.html b/docs/generators/javascript-closure-angular/index.html
new file mode 100644
index 00000000000..9be4377ab06
--- /dev/null
+++ b/docs/generators/javascript-closure-angular/index.html
@@ -0,0 +1,21 @@
+generators/javascript-closure-angular · OpenAPI Generator
id: generator-opts-client-javascript-closure-angular
+title: Config Options for javascript-closure-angular
+sidebar_label: javascript-closure-angular
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
hideGenerationTimestamp
Hides the generation timestamp when files are generated.
true
+
useEs6
use ES6 templates
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/javascript-flowtyped.html b/docs/generators/javascript-flowtyped.html
new file mode 100644
index 00000000000..7592fd437df
--- /dev/null
+++ b/docs/generators/javascript-flowtyped.html
@@ -0,0 +1,25 @@
+generators/javascript-flowtyped · OpenAPI Generator
id: generator-opts-client-javascript-flowtyped
+title: Config Options for javascript-flowtyped
+sidebar_label: javascript-flowtyped
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPropertyNaming
Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name
camelCase
+
supportsES6
Generate code that conforms to ES6.
false
+
npmName
The name under which you want to publish generated npm package
null
+
npmVersion
The version of your npm package
null
+
npmRepository
Use this property to set an url your private npmRepo in the package.json
null
+
snapshot
When setting this property to true the version will be suffixed with -SNAPSHOT.yyyyMMddHHmm
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/javascript-flowtyped/index.html b/docs/generators/javascript-flowtyped/index.html
new file mode 100644
index 00000000000..7592fd437df
--- /dev/null
+++ b/docs/generators/javascript-flowtyped/index.html
@@ -0,0 +1,25 @@
+generators/javascript-flowtyped · OpenAPI Generator
id: generator-opts-client-javascript-flowtyped
+title: Config Options for javascript-flowtyped
+sidebar_label: javascript-flowtyped
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPropertyNaming
Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name
camelCase
+
supportsES6
Generate code that conforms to ES6.
false
+
npmName
The name under which you want to publish generated npm package
null
+
npmVersion
The version of your npm package
null
+
npmRepository
Use this property to set an url your private npmRepo in the package.json
null
+
snapshot
When setting this property to true the version will be suffixed with -SNAPSHOT.yyyyMMddHHmm
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/javascript.html b/docs/generators/javascript.html
new file mode 100644
index 00000000000..fbd491bb2f9
--- /dev/null
+++ b/docs/generators/javascript.html
@@ -0,0 +1,36 @@
+generators/javascript · OpenAPI Generator
id: generator-opts-client-javascript
+title: Config Options for javascript
+sidebar_label: javascript
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
sourceFolder
source folder for generated code
src
+
localVariablePrefix
prefix for generated code members and local variables
null
+
invokerPackage
root package for generated code
null
+
apiPackage
package for generated api classes
null
+
modelPackage
package for generated models
null
+
projectName
name of the project (Default: generated from info.title or "openapi-js-client")
null
+
moduleName
module name for AMD, Node or globals (Default: generated from <projectName>)
null
+
projectDescription
description of the project (Default: using info.description or "Client library of <projectName>")
null
+
projectVersion
version of the project (Default: using info.version or "1.0.0")
null
+
licenseName
name of the license the project uses (Default: using info.license.name)
null
+
usePromises
use Promises as return values from the client API, instead of superagent callbacks
false
+
emitModelMethods
generate getters and setters for model properties
false
+
emitJSDoc
generate JSDoc comments
true
+
useInheritance
use JavaScript prototype chains & delegation for inheritance
true
+
hideGenerationTimestamp
Hides the generation timestamp when files are generated.
true
+
useES6
use JavaScript ES6 (ECMAScript 6) (beta). Default is ES6.
true
+
modelPropertyNaming
Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name
camelCase
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/javascript/index.html b/docs/generators/javascript/index.html
new file mode 100644
index 00000000000..fbd491bb2f9
--- /dev/null
+++ b/docs/generators/javascript/index.html
@@ -0,0 +1,36 @@
+generators/javascript · OpenAPI Generator
id: generator-opts-client-javascript
+title: Config Options for javascript
+sidebar_label: javascript
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
sourceFolder
source folder for generated code
src
+
localVariablePrefix
prefix for generated code members and local variables
null
+
invokerPackage
root package for generated code
null
+
apiPackage
package for generated api classes
null
+
modelPackage
package for generated models
null
+
projectName
name of the project (Default: generated from info.title or "openapi-js-client")
null
+
moduleName
module name for AMD, Node or globals (Default: generated from <projectName>)
null
+
projectDescription
description of the project (Default: using info.description or "Client library of <projectName>")
null
+
projectVersion
version of the project (Default: using info.version or "1.0.0")
null
+
licenseName
name of the license the project uses (Default: using info.license.name)
null
+
usePromises
use Promises as return values from the client API, instead of superagent callbacks
false
+
emitModelMethods
generate getters and setters for model properties
false
+
emitJSDoc
generate JSDoc comments
true
+
useInheritance
use JavaScript prototype chains & delegation for inheritance
true
+
hideGenerationTimestamp
Hides the generation timestamp when files are generated.
true
+
useES6
use JavaScript ES6 (ECMAScript 6) (beta). Default is ES6.
true
+
modelPropertyNaming
Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name
camelCase
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/jaxrs-cxf-cdi.html b/docs/generators/jaxrs-cxf-cdi.html
new file mode 100644
index 00000000000..4371d861cd4
--- /dev/null
+++ b/docs/generators/jaxrs-cxf-cdi.html
@@ -0,0 +1,60 @@
+generators/jaxrs-cxf-cdi · OpenAPI Generator
id: generator-opts-server-jaxrs-cxf-cdi
+title: Config Options for jaxrs-cxf-cdi
+sidebar_label: jaxrs-cxf-cdi
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
invokerPackage
root package for generated code
null
+
groupId
groupId in generated pom.xml
null
+
artifactId
artifactId in generated pom.xml
null
+
artifactVersion
artifact version in generated pom.xml
null
+
artifactUrl
artifact URL in generated pom.xml
null
+
artifactDescription
artifact description in generated pom.xml
null
+
scmConnection
SCM connection in generated pom.xml
null
+
scmDeveloperConnection
SCM developer connection in generated pom.xml
null
+
scmUrl
SCM URL in generated pom.xml
null
+
developerName
developer name in generated pom.xml
null
+
developerEmail
developer email in generated pom.xml
null
+
developerOrganization
developer organization in generated pom.xml
null
+
developerOrganizationUrl
developer organization URL in generated pom.xml
null
+
licenseName
The name of the license
null
+
licenseUrl
The URL of the license
null
+
sourceFolder
source folder for generated code
null
+
localVariablePrefix
prefix for generated code members and local variables
null
+
serializableModel
boolean - toggle "implements Serializable" for generated models
false
+
bigDecimalAsString
Treat BigDecimal values as Strings to avoid precision loss.
false
+
fullJavaUtil
whether to use fully qualified name for classes under java.util. This option only works for Java API client
false
+
hideGenerationTimestamp
hides the timestamp when files were generated
null
+
withXml
whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)
false
+
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)
null
+
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
null
+
disableHtmlEscaping
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)
false
+
booleanGetterPrefix
Set booleanGetterPrefix (default value 'get')
null
+
parentGroupId
parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentArtifactId
parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentVersion
parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
implFolder
folder for generated implementation code
null
+
title
a title describing the application
null
+
useBeanValidation
Use BeanValidation API annotations
true
+
serverPort
The port on which the server should be started
null
+
library
library template (sub-template) to use
<default>
JAXRS
<default>
+
generatePom
Whether to generate pom.xml if the file does not already exist.
true
+
interfaceOnly
Whether to generate only API interface stubs without the server files.
false
+
returnResponse
Whether generate API interface should return javax.ws.rs.core.Response instead of a deserialized entity. Only useful if interfaceOnly is true.
false
+
useSwaggerAnnotations
Whether to generate Swagger annotations.
true
+
useBeanValidation
Use BeanValidation API annotations
true
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/jaxrs-cxf-cdi/index.html b/docs/generators/jaxrs-cxf-cdi/index.html
new file mode 100644
index 00000000000..4371d861cd4
--- /dev/null
+++ b/docs/generators/jaxrs-cxf-cdi/index.html
@@ -0,0 +1,60 @@
+generators/jaxrs-cxf-cdi · OpenAPI Generator
id: generator-opts-server-jaxrs-cxf-cdi
+title: Config Options for jaxrs-cxf-cdi
+sidebar_label: jaxrs-cxf-cdi
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
invokerPackage
root package for generated code
null
+
groupId
groupId in generated pom.xml
null
+
artifactId
artifactId in generated pom.xml
null
+
artifactVersion
artifact version in generated pom.xml
null
+
artifactUrl
artifact URL in generated pom.xml
null
+
artifactDescription
artifact description in generated pom.xml
null
+
scmConnection
SCM connection in generated pom.xml
null
+
scmDeveloperConnection
SCM developer connection in generated pom.xml
null
+
scmUrl
SCM URL in generated pom.xml
null
+
developerName
developer name in generated pom.xml
null
+
developerEmail
developer email in generated pom.xml
null
+
developerOrganization
developer organization in generated pom.xml
null
+
developerOrganizationUrl
developer organization URL in generated pom.xml
null
+
licenseName
The name of the license
null
+
licenseUrl
The URL of the license
null
+
sourceFolder
source folder for generated code
null
+
localVariablePrefix
prefix for generated code members and local variables
null
+
serializableModel
boolean - toggle "implements Serializable" for generated models
false
+
bigDecimalAsString
Treat BigDecimal values as Strings to avoid precision loss.
false
+
fullJavaUtil
whether to use fully qualified name for classes under java.util. This option only works for Java API client
false
+
hideGenerationTimestamp
hides the timestamp when files were generated
null
+
withXml
whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)
false
+
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)
null
+
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
null
+
disableHtmlEscaping
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)
false
+
booleanGetterPrefix
Set booleanGetterPrefix (default value 'get')
null
+
parentGroupId
parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentArtifactId
parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentVersion
parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
implFolder
folder for generated implementation code
null
+
title
a title describing the application
null
+
useBeanValidation
Use BeanValidation API annotations
true
+
serverPort
The port on which the server should be started
null
+
library
library template (sub-template) to use
<default>
JAXRS
<default>
+
generatePom
Whether to generate pom.xml if the file does not already exist.
true
+
interfaceOnly
Whether to generate only API interface stubs without the server files.
false
+
returnResponse
Whether generate API interface should return javax.ws.rs.core.Response instead of a deserialized entity. Only useful if interfaceOnly is true.
false
+
useSwaggerAnnotations
Whether to generate Swagger annotations.
true
+
useBeanValidation
Use BeanValidation API annotations
true
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/jaxrs-cxf-client.html b/docs/generators/jaxrs-cxf-client.html
new file mode 100644
index 00000000000..daebabf843d
--- /dev/null
+++ b/docs/generators/jaxrs-cxf-client.html
@@ -0,0 +1,54 @@
+generators/jaxrs-cxf-client · OpenAPI Generator
id: generator-opts-client-jaxrs-cxf-client
+title: Config Options for jaxrs-cxf-client
+sidebar_label: jaxrs-cxf-client
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
invokerPackage
root package for generated code
null
+
groupId
groupId in generated pom.xml
null
+
artifactId
artifactId in generated pom.xml
null
+
artifactVersion
artifact version in generated pom.xml
null
+
artifactUrl
artifact URL in generated pom.xml
null
+
artifactDescription
artifact description in generated pom.xml
null
+
scmConnection
SCM connection in generated pom.xml
null
+
scmDeveloperConnection
SCM developer connection in generated pom.xml
null
+
scmUrl
SCM URL in generated pom.xml
null
+
developerName
developer name in generated pom.xml
null
+
developerEmail
developer email in generated pom.xml
null
+
developerOrganization
developer organization in generated pom.xml
null
+
developerOrganizationUrl
developer organization URL in generated pom.xml
null
+
licenseName
The name of the license
null
+
licenseUrl
The URL of the license
null
+
sourceFolder
source folder for generated code
null
+
localVariablePrefix
prefix for generated code members and local variables
null
+
serializableModel
boolean - toggle "implements Serializable" for generated models
false
+
bigDecimalAsString
Treat BigDecimal values as Strings to avoid precision loss.
false
+
fullJavaUtil
whether to use fully qualified name for classes under java.util. This option only works for Java API client
false
+
hideGenerationTimestamp
hides the timestamp when files were generated
null
+
withXml
whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)
false
+
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)
null
+
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
null
+
disableHtmlEscaping
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)
false
+
booleanGetterPrefix
Set booleanGetterPrefix (default value 'get')
null
+
parentGroupId
parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentArtifactId
parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentVersion
parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
useBeanValidation
Use BeanValidation API annotations
false
+
useGzipFeatureForTests
Use Gzip Feature for tests
false
+
useLoggingFeatureForTests
Use Logging Feature for tests
false
+
useGenericResponse
Use generic response
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/jaxrs-cxf-client/index.html b/docs/generators/jaxrs-cxf-client/index.html
new file mode 100644
index 00000000000..daebabf843d
--- /dev/null
+++ b/docs/generators/jaxrs-cxf-client/index.html
@@ -0,0 +1,54 @@
+generators/jaxrs-cxf-client · OpenAPI Generator
id: generator-opts-client-jaxrs-cxf-client
+title: Config Options for jaxrs-cxf-client
+sidebar_label: jaxrs-cxf-client
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
invokerPackage
root package for generated code
null
+
groupId
groupId in generated pom.xml
null
+
artifactId
artifactId in generated pom.xml
null
+
artifactVersion
artifact version in generated pom.xml
null
+
artifactUrl
artifact URL in generated pom.xml
null
+
artifactDescription
artifact description in generated pom.xml
null
+
scmConnection
SCM connection in generated pom.xml
null
+
scmDeveloperConnection
SCM developer connection in generated pom.xml
null
+
scmUrl
SCM URL in generated pom.xml
null
+
developerName
developer name in generated pom.xml
null
+
developerEmail
developer email in generated pom.xml
null
+
developerOrganization
developer organization in generated pom.xml
null
+
developerOrganizationUrl
developer organization URL in generated pom.xml
null
+
licenseName
The name of the license
null
+
licenseUrl
The URL of the license
null
+
sourceFolder
source folder for generated code
null
+
localVariablePrefix
prefix for generated code members and local variables
null
+
serializableModel
boolean - toggle "implements Serializable" for generated models
false
+
bigDecimalAsString
Treat BigDecimal values as Strings to avoid precision loss.
false
+
fullJavaUtil
whether to use fully qualified name for classes under java.util. This option only works for Java API client
false
+
hideGenerationTimestamp
hides the timestamp when files were generated
null
+
withXml
whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)
false
+
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)
null
+
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
null
+
disableHtmlEscaping
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)
false
+
booleanGetterPrefix
Set booleanGetterPrefix (default value 'get')
null
+
parentGroupId
parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentArtifactId
parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentVersion
parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
useBeanValidation
Use BeanValidation API annotations
false
+
useGzipFeatureForTests
Use Gzip Feature for tests
false
+
useLoggingFeatureForTests
Use Logging Feature for tests
false
+
useGenericResponse
Use generic response
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/jaxrs-cxf.html b/docs/generators/jaxrs-cxf.html
new file mode 100644
index 00000000000..eb6403efb1b
--- /dev/null
+++ b/docs/generators/jaxrs-cxf.html
@@ -0,0 +1,71 @@
+generators/jaxrs-cxf · OpenAPI Generator
id: generator-opts-server-jaxrs-cxf
+title: Config Options for jaxrs-cxf
+sidebar_label: jaxrs-cxf
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
invokerPackage
root package for generated code
null
+
groupId
groupId in generated pom.xml
null
+
artifactId
artifactId in generated pom.xml
null
+
artifactVersion
artifact version in generated pom.xml
null
+
artifactUrl
artifact URL in generated pom.xml
null
+
artifactDescription
artifact description in generated pom.xml
null
+
scmConnection
SCM connection in generated pom.xml
null
+
scmDeveloperConnection
SCM developer connection in generated pom.xml
null
+
scmUrl
SCM URL in generated pom.xml
null
+
developerName
developer name in generated pom.xml
null
+
developerEmail
developer email in generated pom.xml
null
+
developerOrganization
developer organization in generated pom.xml
null
+
developerOrganizationUrl
developer organization URL in generated pom.xml
null
+
licenseName
The name of the license
null
+
licenseUrl
The URL of the license
null
+
sourceFolder
source folder for generated code
null
+
localVariablePrefix
prefix for generated code members and local variables
null
+
serializableModel
boolean - toggle "implements Serializable" for generated models
false
+
bigDecimalAsString
Treat BigDecimal values as Strings to avoid precision loss.
false
+
fullJavaUtil
whether to use fully qualified name for classes under java.util. This option only works for Java API client
false
+
hideGenerationTimestamp
hides the timestamp when files were generated
null
+
withXml
whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)
false
+
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)
null
+
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
null
+
disableHtmlEscaping
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)
false
+
booleanGetterPrefix
Set booleanGetterPrefix (default value 'get')
null
+
parentGroupId
parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentArtifactId
parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentVersion
parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
implFolder
folder for generated implementation code
null
+
title
a title describing the application
null
+
useBeanValidation
Use BeanValidation API annotations
true
+
serverPort
The port on which the server should be started
null
+
generateSpringApplication
Generate Spring application
false
+
useSpringAnnotationConfig
Use Spring Annotation Config
false
+
useSwaggerFeature
Use Swagger Feature
false
+
useSwaggerUI
Use Swagger UI
false
+
useWadlFeature
Use WADL Feature
false
+
useMultipartFeature
Use Multipart Feature
false
+
useGzipFeature
Use Gzip Feature
false
+
useGzipFeatureForTests
Use Gzip Feature for tests
false
+
useBeanValidationFeature
Use BeanValidation Feature
false
+
useLoggingFeature
Use Logging Feature
false
+
useLoggingFeatureForTests
Use Logging Feature for tests
false
+
generateSpringBootApplication
Generate Spring Boot application
false
+
generateJbossDeploymentDescriptor
Generate Jboss Deployment Descriptor
false
+
addConsumesProducesJson
Add @Consumes/@Produces Json to API interface
false
+
useAnnotatedBasePath
Use @Path annotations for basePath
false
+
generateNonSpringApplication
Generate non-Spring application
false
+
useGenericResponse
Use generic response
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/jaxrs-cxf/index.html b/docs/generators/jaxrs-cxf/index.html
new file mode 100644
index 00000000000..eb6403efb1b
--- /dev/null
+++ b/docs/generators/jaxrs-cxf/index.html
@@ -0,0 +1,71 @@
+generators/jaxrs-cxf · OpenAPI Generator
id: generator-opts-server-jaxrs-cxf
+title: Config Options for jaxrs-cxf
+sidebar_label: jaxrs-cxf
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
invokerPackage
root package for generated code
null
+
groupId
groupId in generated pom.xml
null
+
artifactId
artifactId in generated pom.xml
null
+
artifactVersion
artifact version in generated pom.xml
null
+
artifactUrl
artifact URL in generated pom.xml
null
+
artifactDescription
artifact description in generated pom.xml
null
+
scmConnection
SCM connection in generated pom.xml
null
+
scmDeveloperConnection
SCM developer connection in generated pom.xml
null
+
scmUrl
SCM URL in generated pom.xml
null
+
developerName
developer name in generated pom.xml
null
+
developerEmail
developer email in generated pom.xml
null
+
developerOrganization
developer organization in generated pom.xml
null
+
developerOrganizationUrl
developer organization URL in generated pom.xml
null
+
licenseName
The name of the license
null
+
licenseUrl
The URL of the license
null
+
sourceFolder
source folder for generated code
null
+
localVariablePrefix
prefix for generated code members and local variables
null
+
serializableModel
boolean - toggle "implements Serializable" for generated models
false
+
bigDecimalAsString
Treat BigDecimal values as Strings to avoid precision loss.
false
+
fullJavaUtil
whether to use fully qualified name for classes under java.util. This option only works for Java API client
false
+
hideGenerationTimestamp
hides the timestamp when files were generated
null
+
withXml
whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)
false
+
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)
null
+
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
null
+
disableHtmlEscaping
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)
false
+
booleanGetterPrefix
Set booleanGetterPrefix (default value 'get')
null
+
parentGroupId
parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentArtifactId
parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentVersion
parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
implFolder
folder for generated implementation code
null
+
title
a title describing the application
null
+
useBeanValidation
Use BeanValidation API annotations
true
+
serverPort
The port on which the server should be started
null
+
generateSpringApplication
Generate Spring application
false
+
useSpringAnnotationConfig
Use Spring Annotation Config
false
+
useSwaggerFeature
Use Swagger Feature
false
+
useSwaggerUI
Use Swagger UI
false
+
useWadlFeature
Use WADL Feature
false
+
useMultipartFeature
Use Multipart Feature
false
+
useGzipFeature
Use Gzip Feature
false
+
useGzipFeatureForTests
Use Gzip Feature for tests
false
+
useBeanValidationFeature
Use BeanValidation Feature
false
+
useLoggingFeature
Use Logging Feature
false
+
useLoggingFeatureForTests
Use Logging Feature for tests
false
+
generateSpringBootApplication
Generate Spring Boot application
false
+
generateJbossDeploymentDescriptor
Generate Jboss Deployment Descriptor
false
+
addConsumesProducesJson
Add @Consumes/@Produces Json to API interface
false
+
useAnnotatedBasePath
Use @Path annotations for basePath
false
+
generateNonSpringApplication
Generate non-Spring application
false
+
useGenericResponse
Use generic response
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/jaxrs-jersey.html b/docs/generators/jaxrs-jersey.html
new file mode 100644
index 00000000000..0fc79710864
--- /dev/null
+++ b/docs/generators/jaxrs-jersey.html
@@ -0,0 +1,57 @@
+generators/jaxrs-jersey · OpenAPI Generator
id: generator-opts-server-jaxrs-jersey
+title: Config Options for jaxrs-jersey
+sidebar_label: jaxrs-jersey
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
invokerPackage
root package for generated code
null
+
groupId
groupId in generated pom.xml
null
+
artifactId
artifactId in generated pom.xml
null
+
artifactVersion
artifact version in generated pom.xml
null
+
artifactUrl
artifact URL in generated pom.xml
null
+
artifactDescription
artifact description in generated pom.xml
null
+
scmConnection
SCM connection in generated pom.xml
null
+
scmDeveloperConnection
SCM developer connection in generated pom.xml
null
+
scmUrl
SCM URL in generated pom.xml
null
+
developerName
developer name in generated pom.xml
null
+
developerEmail
developer email in generated pom.xml
null
+
developerOrganization
developer organization in generated pom.xml
null
+
developerOrganizationUrl
developer organization URL in generated pom.xml
null
+
licenseName
The name of the license
null
+
licenseUrl
The URL of the license
null
+
sourceFolder
source folder for generated code
null
+
localVariablePrefix
prefix for generated code members and local variables
null
+
serializableModel
boolean - toggle "implements Serializable" for generated models
false
+
bigDecimalAsString
Treat BigDecimal values as Strings to avoid precision loss.
false
+
fullJavaUtil
whether to use fully qualified name for classes under java.util. This option only works for Java API client
false
+
hideGenerationTimestamp
hides the timestamp when files were generated
null
+
withXml
whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)
false
+
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)
null
+
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
null
+
disableHtmlEscaping
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)
false
+
booleanGetterPrefix
Set booleanGetterPrefix (default value 'get')
null
+
parentGroupId
parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentArtifactId
parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentVersion
parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
implFolder
folder for generated implementation code
null
+
title
a title describing the application
null
+
useBeanValidation
Use BeanValidation API annotations
true
+
serverPort
The port on which the server should be started
null
+
library
library template (sub-template) to use
jersey1
Jersey core 1.x
jersey2
Jersey core 2.x
jersey2
+
supportJava6
Whether to support Java6 with the Jersey1/2 library.
false
+
useTags
use tags for creating interface and controller classnames
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/jaxrs-jersey/index.html b/docs/generators/jaxrs-jersey/index.html
new file mode 100644
index 00000000000..0fc79710864
--- /dev/null
+++ b/docs/generators/jaxrs-jersey/index.html
@@ -0,0 +1,57 @@
+generators/jaxrs-jersey · OpenAPI Generator
id: generator-opts-server-jaxrs-jersey
+title: Config Options for jaxrs-jersey
+sidebar_label: jaxrs-jersey
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
invokerPackage
root package for generated code
null
+
groupId
groupId in generated pom.xml
null
+
artifactId
artifactId in generated pom.xml
null
+
artifactVersion
artifact version in generated pom.xml
null
+
artifactUrl
artifact URL in generated pom.xml
null
+
artifactDescription
artifact description in generated pom.xml
null
+
scmConnection
SCM connection in generated pom.xml
null
+
scmDeveloperConnection
SCM developer connection in generated pom.xml
null
+
scmUrl
SCM URL in generated pom.xml
null
+
developerName
developer name in generated pom.xml
null
+
developerEmail
developer email in generated pom.xml
null
+
developerOrganization
developer organization in generated pom.xml
null
+
developerOrganizationUrl
developer organization URL in generated pom.xml
null
+
licenseName
The name of the license
null
+
licenseUrl
The URL of the license
null
+
sourceFolder
source folder for generated code
null
+
localVariablePrefix
prefix for generated code members and local variables
null
+
serializableModel
boolean - toggle "implements Serializable" for generated models
false
+
bigDecimalAsString
Treat BigDecimal values as Strings to avoid precision loss.
false
+
fullJavaUtil
whether to use fully qualified name for classes under java.util. This option only works for Java API client
false
+
hideGenerationTimestamp
hides the timestamp when files were generated
null
+
withXml
whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)
false
+
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)
null
+
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
null
+
disableHtmlEscaping
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)
false
+
booleanGetterPrefix
Set booleanGetterPrefix (default value 'get')
null
+
parentGroupId
parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentArtifactId
parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentVersion
parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
implFolder
folder for generated implementation code
null
+
title
a title describing the application
null
+
useBeanValidation
Use BeanValidation API annotations
true
+
serverPort
The port on which the server should be started
null
+
library
library template (sub-template) to use
jersey1
Jersey core 1.x
jersey2
Jersey core 2.x
jersey2
+
supportJava6
Whether to support Java6 with the Jersey1/2 library.
false
+
useTags
use tags for creating interface and controller classnames
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/jaxrs-resteasy-eap.html b/docs/generators/jaxrs-resteasy-eap.html
new file mode 100644
index 00000000000..4cdeea5280c
--- /dev/null
+++ b/docs/generators/jaxrs-resteasy-eap.html
@@ -0,0 +1,57 @@
+generators/jaxrs-resteasy-eap · OpenAPI Generator
id: generator-opts-server-jaxrs-resteasy-eap
+title: Config Options for jaxrs-resteasy-eap
+sidebar_label: jaxrs-resteasy-eap
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
invokerPackage
root package for generated code
null
+
groupId
groupId in generated pom.xml
null
+
artifactId
artifactId in generated pom.xml
null
+
artifactVersion
artifact version in generated pom.xml
null
+
artifactUrl
artifact URL in generated pom.xml
null
+
artifactDescription
artifact description in generated pom.xml
null
+
scmConnection
SCM connection in generated pom.xml
null
+
scmDeveloperConnection
SCM developer connection in generated pom.xml
null
+
scmUrl
SCM URL in generated pom.xml
null
+
developerName
developer name in generated pom.xml
null
+
developerEmail
developer email in generated pom.xml
null
+
developerOrganization
developer organization in generated pom.xml
null
+
developerOrganizationUrl
developer organization URL in generated pom.xml
null
+
licenseName
The name of the license
null
+
licenseUrl
The URL of the license
null
+
sourceFolder
source folder for generated code
null
+
localVariablePrefix
prefix for generated code members and local variables
null
+
serializableModel
boolean - toggle "implements Serializable" for generated models
false
+
bigDecimalAsString
Treat BigDecimal values as Strings to avoid precision loss.
false
+
fullJavaUtil
whether to use fully qualified name for classes under java.util. This option only works for Java API client
false
+
hideGenerationTimestamp
hides the timestamp when files were generated
null
+
withXml
whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)
false
+
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)
null
+
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
null
+
disableHtmlEscaping
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)
false
+
booleanGetterPrefix
Set booleanGetterPrefix (default value 'get')
null
+
parentGroupId
parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentArtifactId
parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentVersion
parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
implFolder
folder for generated implementation code
null
+
title
a title describing the application
null
+
useBeanValidation
Use BeanValidation API annotations
true
+
serverPort
The port on which the server should be started
null
+
useBeanValidation
Use BeanValidation API annotations
true
+
generateJbossDeploymentDescriptor
Generate Jboss Deployment Descriptor
true
+
useSwaggerFeature
Use dynamic Swagger generator
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/jaxrs-resteasy-eap/index.html b/docs/generators/jaxrs-resteasy-eap/index.html
new file mode 100644
index 00000000000..4cdeea5280c
--- /dev/null
+++ b/docs/generators/jaxrs-resteasy-eap/index.html
@@ -0,0 +1,57 @@
+generators/jaxrs-resteasy-eap · OpenAPI Generator
id: generator-opts-server-jaxrs-resteasy-eap
+title: Config Options for jaxrs-resteasy-eap
+sidebar_label: jaxrs-resteasy-eap
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
invokerPackage
root package for generated code
null
+
groupId
groupId in generated pom.xml
null
+
artifactId
artifactId in generated pom.xml
null
+
artifactVersion
artifact version in generated pom.xml
null
+
artifactUrl
artifact URL in generated pom.xml
null
+
artifactDescription
artifact description in generated pom.xml
null
+
scmConnection
SCM connection in generated pom.xml
null
+
scmDeveloperConnection
SCM developer connection in generated pom.xml
null
+
scmUrl
SCM URL in generated pom.xml
null
+
developerName
developer name in generated pom.xml
null
+
developerEmail
developer email in generated pom.xml
null
+
developerOrganization
developer organization in generated pom.xml
null
+
developerOrganizationUrl
developer organization URL in generated pom.xml
null
+
licenseName
The name of the license
null
+
licenseUrl
The URL of the license
null
+
sourceFolder
source folder for generated code
null
+
localVariablePrefix
prefix for generated code members and local variables
null
+
serializableModel
boolean - toggle "implements Serializable" for generated models
false
+
bigDecimalAsString
Treat BigDecimal values as Strings to avoid precision loss.
false
+
fullJavaUtil
whether to use fully qualified name for classes under java.util. This option only works for Java API client
false
+
hideGenerationTimestamp
hides the timestamp when files were generated
null
+
withXml
whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)
false
+
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)
null
+
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
null
+
disableHtmlEscaping
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)
false
+
booleanGetterPrefix
Set booleanGetterPrefix (default value 'get')
null
+
parentGroupId
parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentArtifactId
parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentVersion
parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
implFolder
folder for generated implementation code
null
+
title
a title describing the application
null
+
useBeanValidation
Use BeanValidation API annotations
true
+
serverPort
The port on which the server should be started
null
+
useBeanValidation
Use BeanValidation API annotations
true
+
generateJbossDeploymentDescriptor
Generate Jboss Deployment Descriptor
true
+
useSwaggerFeature
Use dynamic Swagger generator
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/jaxrs-resteasy.html b/docs/generators/jaxrs-resteasy.html
new file mode 100644
index 00000000000..b4a6c47b383
--- /dev/null
+++ b/docs/generators/jaxrs-resteasy.html
@@ -0,0 +1,55 @@
+generators/jaxrs-resteasy · OpenAPI Generator
id: generator-opts-server-jaxrs-resteasy
+title: Config Options for jaxrs-resteasy
+sidebar_label: jaxrs-resteasy
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
invokerPackage
root package for generated code
null
+
groupId
groupId in generated pom.xml
null
+
artifactId
artifactId in generated pom.xml
null
+
artifactVersion
artifact version in generated pom.xml
null
+
artifactUrl
artifact URL in generated pom.xml
null
+
artifactDescription
artifact description in generated pom.xml
null
+
scmConnection
SCM connection in generated pom.xml
null
+
scmDeveloperConnection
SCM developer connection in generated pom.xml
null
+
scmUrl
SCM URL in generated pom.xml
null
+
developerName
developer name in generated pom.xml
null
+
developerEmail
developer email in generated pom.xml
null
+
developerOrganization
developer organization in generated pom.xml
null
+
developerOrganizationUrl
developer organization URL in generated pom.xml
null
+
licenseName
The name of the license
null
+
licenseUrl
The URL of the license
null
+
sourceFolder
source folder for generated code
null
+
localVariablePrefix
prefix for generated code members and local variables
null
+
serializableModel
boolean - toggle "implements Serializable" for generated models
false
+
bigDecimalAsString
Treat BigDecimal values as Strings to avoid precision loss.
false
+
fullJavaUtil
whether to use fully qualified name for classes under java.util. This option only works for Java API client
false
+
hideGenerationTimestamp
hides the timestamp when files were generated
null
+
withXml
whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)
false
+
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)
null
+
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
null
+
disableHtmlEscaping
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)
false
+
booleanGetterPrefix
Set booleanGetterPrefix (default value 'get')
null
+
parentGroupId
parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentArtifactId
parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentVersion
parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
implFolder
folder for generated implementation code
null
+
title
a title describing the application
null
+
useBeanValidation
Use BeanValidation API annotations
true
+
serverPort
The port on which the server should be started
null
+
generateJbossDeploymentDescriptor
Generate Jboss Deployment Descriptor
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/jaxrs-resteasy/index.html b/docs/generators/jaxrs-resteasy/index.html
new file mode 100644
index 00000000000..b4a6c47b383
--- /dev/null
+++ b/docs/generators/jaxrs-resteasy/index.html
@@ -0,0 +1,55 @@
+generators/jaxrs-resteasy · OpenAPI Generator
id: generator-opts-server-jaxrs-resteasy
+title: Config Options for jaxrs-resteasy
+sidebar_label: jaxrs-resteasy
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
invokerPackage
root package for generated code
null
+
groupId
groupId in generated pom.xml
null
+
artifactId
artifactId in generated pom.xml
null
+
artifactVersion
artifact version in generated pom.xml
null
+
artifactUrl
artifact URL in generated pom.xml
null
+
artifactDescription
artifact description in generated pom.xml
null
+
scmConnection
SCM connection in generated pom.xml
null
+
scmDeveloperConnection
SCM developer connection in generated pom.xml
null
+
scmUrl
SCM URL in generated pom.xml
null
+
developerName
developer name in generated pom.xml
null
+
developerEmail
developer email in generated pom.xml
null
+
developerOrganization
developer organization in generated pom.xml
null
+
developerOrganizationUrl
developer organization URL in generated pom.xml
null
+
licenseName
The name of the license
null
+
licenseUrl
The URL of the license
null
+
sourceFolder
source folder for generated code
null
+
localVariablePrefix
prefix for generated code members and local variables
null
+
serializableModel
boolean - toggle "implements Serializable" for generated models
false
+
bigDecimalAsString
Treat BigDecimal values as Strings to avoid precision loss.
false
+
fullJavaUtil
whether to use fully qualified name for classes under java.util. This option only works for Java API client
false
+
hideGenerationTimestamp
hides the timestamp when files were generated
null
+
withXml
whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)
false
+
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)
null
+
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
null
+
disableHtmlEscaping
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)
false
+
booleanGetterPrefix
Set booleanGetterPrefix (default value 'get')
null
+
parentGroupId
parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentArtifactId
parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentVersion
parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
implFolder
folder for generated implementation code
null
+
title
a title describing the application
null
+
useBeanValidation
Use BeanValidation API annotations
true
+
serverPort
The port on which the server should be started
null
+
generateJbossDeploymentDescriptor
Generate Jboss Deployment Descriptor
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/jaxrs-spec.html b/docs/generators/jaxrs-spec.html
new file mode 100644
index 00000000000..6a22dd189c3
--- /dev/null
+++ b/docs/generators/jaxrs-spec.html
@@ -0,0 +1,59 @@
+generators/jaxrs-spec · OpenAPI Generator
id: generator-opts-server-jaxrs-spec
+title: Config Options for jaxrs-spec
+sidebar_label: jaxrs-spec
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
invokerPackage
root package for generated code
null
+
groupId
groupId in generated pom.xml
null
+
artifactId
artifactId in generated pom.xml
null
+
artifactVersion
artifact version in generated pom.xml
null
+
artifactUrl
artifact URL in generated pom.xml
null
+
artifactDescription
artifact description in generated pom.xml
null
+
scmConnection
SCM connection in generated pom.xml
null
+
scmDeveloperConnection
SCM developer connection in generated pom.xml
null
+
scmUrl
SCM URL in generated pom.xml
null
+
developerName
developer name in generated pom.xml
null
+
developerEmail
developer email in generated pom.xml
null
+
developerOrganization
developer organization in generated pom.xml
null
+
developerOrganizationUrl
developer organization URL in generated pom.xml
null
+
licenseName
The name of the license
null
+
licenseUrl
The URL of the license
null
+
sourceFolder
source folder for generated code
null
+
localVariablePrefix
prefix for generated code members and local variables
null
+
serializableModel
boolean - toggle "implements Serializable" for generated models
false
+
bigDecimalAsString
Treat BigDecimal values as Strings to avoid precision loss.
false
+
fullJavaUtil
whether to use fully qualified name for classes under java.util. This option only works for Java API client
false
+
hideGenerationTimestamp
hides the timestamp when files were generated
null
+
withXml
whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)
false
+
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)
null
+
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
null
+
disableHtmlEscaping
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)
false
+
booleanGetterPrefix
Set booleanGetterPrefix (default value 'get')
null
+
parentGroupId
parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentArtifactId
parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentVersion
parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
implFolder
folder for generated implementation code
null
+
title
a title describing the application
null
+
useBeanValidation
Use BeanValidation API annotations
true
+
serverPort
The port on which the server should be started
null
+
library
library template (sub-template) to use
<default>
JAXRS
<default>
+
generatePom
Whether to generate pom.xml if the file does not already exist.
true
+
interfaceOnly
Whether to generate only API interface stubs without the server files.
false
+
returnResponse
Whether generate API interface should return javax.ws.rs.core.Response instead of a deserialized entity. Only useful if interfaceOnly is true.
false
+
useSwaggerAnnotations
Whether to generate Swagger annotations.
true
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/jaxrs-spec/index.html b/docs/generators/jaxrs-spec/index.html
new file mode 100644
index 00000000000..6a22dd189c3
--- /dev/null
+++ b/docs/generators/jaxrs-spec/index.html
@@ -0,0 +1,59 @@
+generators/jaxrs-spec · OpenAPI Generator
id: generator-opts-server-jaxrs-spec
+title: Config Options for jaxrs-spec
+sidebar_label: jaxrs-spec
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
invokerPackage
root package for generated code
null
+
groupId
groupId in generated pom.xml
null
+
artifactId
artifactId in generated pom.xml
null
+
artifactVersion
artifact version in generated pom.xml
null
+
artifactUrl
artifact URL in generated pom.xml
null
+
artifactDescription
artifact description in generated pom.xml
null
+
scmConnection
SCM connection in generated pom.xml
null
+
scmDeveloperConnection
SCM developer connection in generated pom.xml
null
+
scmUrl
SCM URL in generated pom.xml
null
+
developerName
developer name in generated pom.xml
null
+
developerEmail
developer email in generated pom.xml
null
+
developerOrganization
developer organization in generated pom.xml
null
+
developerOrganizationUrl
developer organization URL in generated pom.xml
null
+
licenseName
The name of the license
null
+
licenseUrl
The URL of the license
null
+
sourceFolder
source folder for generated code
null
+
localVariablePrefix
prefix for generated code members and local variables
null
+
serializableModel
boolean - toggle "implements Serializable" for generated models
false
+
bigDecimalAsString
Treat BigDecimal values as Strings to avoid precision loss.
false
+
fullJavaUtil
whether to use fully qualified name for classes under java.util. This option only works for Java API client
false
+
hideGenerationTimestamp
hides the timestamp when files were generated
null
+
withXml
whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)
false
+
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)
null
+
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
null
+
disableHtmlEscaping
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)
false
+
booleanGetterPrefix
Set booleanGetterPrefix (default value 'get')
null
+
parentGroupId
parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentArtifactId
parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentVersion
parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
implFolder
folder for generated implementation code
null
+
title
a title describing the application
null
+
useBeanValidation
Use BeanValidation API annotations
true
+
serverPort
The port on which the server should be started
null
+
library
library template (sub-template) to use
<default>
JAXRS
<default>
+
generatePom
Whether to generate pom.xml if the file does not already exist.
true
+
interfaceOnly
Whether to generate only API interface stubs without the server files.
false
+
returnResponse
Whether generate API interface should return javax.ws.rs.core.Response instead of a deserialized entity. Only useful if interfaceOnly is true.
false
+
useSwaggerAnnotations
Whether to generate Swagger annotations.
true
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/jmeter.html b/docs/generators/jmeter.html
new file mode 100644
index 00000000000..216ef18d40e
--- /dev/null
+++ b/docs/generators/jmeter.html
@@ -0,0 +1,19 @@
+generators/jmeter · OpenAPI Generator
id: generator-opts-client-jmeter
+title: Config Options for jmeter
+sidebar_label: jmeter
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/jmeter/index.html b/docs/generators/jmeter/index.html
new file mode 100644
index 00000000000..216ef18d40e
--- /dev/null
+++ b/docs/generators/jmeter/index.html
@@ -0,0 +1,19 @@
+generators/jmeter · OpenAPI Generator
id: generator-opts-client-jmeter
+title: Config Options for jmeter
+sidebar_label: jmeter
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/kotlin-server.html b/docs/generators/kotlin-server.html
new file mode 100644
index 00000000000..7e1e4e85fb4
--- /dev/null
+++ b/docs/generators/kotlin-server.html
@@ -0,0 +1,28 @@
+generators/kotlin-server · OpenAPI Generator
Naming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'
camelCase
+
parcelizeModels
toggle "@Parcelize" for generated models
null
+
library
library template (sub-template) to use
ktor
ktor framework
ktor
+
featureAutoHead
Automatically provide responses to HEAD requests for existing routes that have the GET verb defined.
true
+
featureConditionalHeaders
Avoid sending content if client already has same content, by checking ETag or LastModified properties.
false
+
featureHSTS
Avoid sending content if client already has same content, by checking ETag or LastModified properties.
true
+
featureCORS
Ktor by default provides an interceptor for implementing proper support for Cross-Origin Resource Sharing (CORS). See enable-cors.org.
false
+
featureCompression
Adds ability to compress outgoing content using gzip, deflate or custom encoder and thus reduce size of the response.
true
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/kotlin-server/index.html b/docs/generators/kotlin-server/index.html
new file mode 100644
index 00000000000..7e1e4e85fb4
--- /dev/null
+++ b/docs/generators/kotlin-server/index.html
@@ -0,0 +1,28 @@
+generators/kotlin-server · OpenAPI Generator
Naming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'
camelCase
+
parcelizeModels
toggle "@Parcelize" for generated models
null
+
library
library template (sub-template) to use
ktor
ktor framework
ktor
+
featureAutoHead
Automatically provide responses to HEAD requests for existing routes that have the GET verb defined.
true
+
featureConditionalHeaders
Avoid sending content if client already has same content, by checking ETag or LastModified properties.
false
+
featureHSTS
Avoid sending content if client already has same content, by checking ETag or LastModified properties.
true
+
featureCORS
Ktor by default provides an interceptor for implementing proper support for Cross-Origin Resource Sharing (CORS). See enable-cors.org.
false
+
featureCompression
Adds ability to compress outgoing content using gzip, deflate or custom encoder and thus reduce size of the response.
true
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/kotlin-spring.html b/docs/generators/kotlin-spring.html
new file mode 100644
index 00000000000..ef455d55c45
--- /dev/null
+++ b/docs/generators/kotlin-spring.html
@@ -0,0 +1,34 @@
+generators/kotlin-spring · OpenAPI Generator
Naming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'
camelCase
+
parcelizeModels
toggle "@Parcelize" for generated models
null
+
title
server title name or client service name
OpenAPI Kotlin Spring
+
basePackage
base package (invokerPackage) for generated code
org.openapitools
+
serverPort
configuration the port in which the sever is to run on
8080
+
modelPackage
model package for generated code
org.openapitools.model
+
apiPackage
api package for generated code
org.openapitools.api
+
exceptionHandler
generate default global exception handlers
true
+
gradleBuildFile
generate a gradle build file using the Kotlin DSL
true
+
swaggerAnnotations
generate swagger annotations to go alongside controllers and models
false
+
serviceInterface
generate service interfaces to go alongside controllers. In most cases this option would be used to update an existing project, so not to override implementations. Useful to help facilitate the generation gap pattern
false
+
serviceImplementation
generate stub service implementations that extends service interfaces. If this is set to true service interfaces will also be generated
false
+
useBeanValidation
Use BeanValidation API annotations to validate data types
true
+
library
library template (sub-template) to use
spring-boot
Spring-boot Server application.
spring-boot
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/kotlin-spring/index.html b/docs/generators/kotlin-spring/index.html
new file mode 100644
index 00000000000..ef455d55c45
--- /dev/null
+++ b/docs/generators/kotlin-spring/index.html
@@ -0,0 +1,34 @@
+generators/kotlin-spring · OpenAPI Generator
Naming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'
camelCase
+
parcelizeModels
toggle "@Parcelize" for generated models
null
+
title
server title name or client service name
OpenAPI Kotlin Spring
+
basePackage
base package (invokerPackage) for generated code
org.openapitools
+
serverPort
configuration the port in which the sever is to run on
8080
+
modelPackage
model package for generated code
org.openapitools.model
+
apiPackage
api package for generated code
org.openapitools.api
+
exceptionHandler
generate default global exception handlers
true
+
gradleBuildFile
generate a gradle build file using the Kotlin DSL
true
+
swaggerAnnotations
generate swagger annotations to go alongside controllers and models
false
+
serviceInterface
generate service interfaces to go alongside controllers. In most cases this option would be used to update an existing project, so not to override implementations. Useful to help facilitate the generation gap pattern
false
+
serviceImplementation
generate stub service implementations that extends service interfaces. If this is set to true service interfaces will also be generated
false
+
useBeanValidation
Use BeanValidation API annotations to validate data types
true
+
library
library template (sub-template) to use
spring-boot
Spring-boot Server application.
spring-boot
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/kotlin.html b/docs/generators/kotlin.html
new file mode 100644
index 00000000000..343496c451c
--- /dev/null
+++ b/docs/generators/kotlin.html
@@ -0,0 +1,24 @@
+generators/kotlin · OpenAPI Generator
Naming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'
camelCase
+
parcelizeModels
toggle "@Parcelize" for generated models
null
+
dateLibrary
Option. Date library to use
string
String
java8
Java 8 native JSR310
threetenbp
Threetenbp
null
+
collectionType
Option. Collection type to use
array
kotlin.Array
list
kotlin.collections.List
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/kotlin/index.html b/docs/generators/kotlin/index.html
new file mode 100644
index 00000000000..343496c451c
--- /dev/null
+++ b/docs/generators/kotlin/index.html
@@ -0,0 +1,24 @@
+generators/kotlin · OpenAPI Generator
Naming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'
camelCase
+
parcelizeModels
toggle "@Parcelize" for generated models
null
+
dateLibrary
Option. Date library to use
string
String
java8
Java 8 native JSR310
threetenbp
Threetenbp
null
+
collectionType
Option. Collection type to use
array
kotlin.Array
list
kotlin.collections.List
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/lua.html b/docs/generators/lua.html
new file mode 100644
index 00000000000..aef41ae3d1f
--- /dev/null
+++ b/docs/generators/lua.html
@@ -0,0 +1,18 @@
+generators/lua · OpenAPI Generator
id: generator-opts-client-lua
+title: Config Options for lua
+sidebar_label: lua
+
+
+
+
Option
Description
Values
Default
+
+
+
packageName
Lua package name (convention: single word).
openapiclient
+
packageVersion
Lua package version.
1.0.0-1
+
hideGenerationTimestamp
Hides the generation timestamp when files are generated.
true
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/lua/index.html b/docs/generators/lua/index.html
new file mode 100644
index 00000000000..aef41ae3d1f
--- /dev/null
+++ b/docs/generators/lua/index.html
@@ -0,0 +1,18 @@
+generators/lua · OpenAPI Generator
id: generator-opts-client-lua
+title: Config Options for lua
+sidebar_label: lua
+
+
+
+
Option
Description
Values
Default
+
+
+
packageName
Lua package name (convention: single word).
openapiclient
+
packageVersion
Lua package version.
1.0.0-1
+
hideGenerationTimestamp
Hides the generation timestamp when files are generated.
true
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/mysql-schema.html b/docs/generators/mysql-schema.html
new file mode 100644
index 00000000000..0c38af8741c
--- /dev/null
+++ b/docs/generators/mysql-schema.html
@@ -0,0 +1,17 @@
+generators/mysql-schema · OpenAPI Generator
id: generator-opts-schema-mysql-schema
+title: Config Options for mysql-schema
+sidebar_label: mysql-schema
+
+
+
+
Option
Description
Values
Default
+
+
+
defaultDatabaseName
Default database name for all MySQL queries
+
jsonDataTypeEnabled
Use special JSON MySQL data type for complex model properties. Requires MySQL version 5.7.8. Generates TEXT data type when disabled
true
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/mysql-schema/index.html b/docs/generators/mysql-schema/index.html
new file mode 100644
index 00000000000..0c38af8741c
--- /dev/null
+++ b/docs/generators/mysql-schema/index.html
@@ -0,0 +1,17 @@
+generators/mysql-schema · OpenAPI Generator
id: generator-opts-schema-mysql-schema
+title: Config Options for mysql-schema
+sidebar_label: mysql-schema
+
+
+
+
Option
Description
Values
Default
+
+
+
defaultDatabaseName
Default database name for all MySQL queries
+
jsonDataTypeEnabled
Use special JSON MySQL data type for complex model properties. Requires MySQL version 5.7.8. Generates TEXT data type when disabled
true
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/nodejs-server.html b/docs/generators/nodejs-server.html
new file mode 100644
index 00000000000..82ed04988d8
--- /dev/null
+++ b/docs/generators/nodejs-server.html
@@ -0,0 +1,22 @@
+generators/nodejs-server · OpenAPI Generator
id: generator-opts-server-nodejs-server
+title: Config Options for nodejs-server
+sidebar_label: nodejs-server
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
googleCloudFunctions
When specified, it will generate the code which runs within Google Cloud Functions instead of standalone Node.JS server. See https://cloud.google.com/functions/docs/quickstart for the details of how to deploy the generated code.
false
+
exportedName
When the generated code will be deployed to Google Cloud Functions, this option can be used to update the name of the exported function. By default, it refers to the basePath. This does not affect normal standalone nodejs server code.
null
+
serverPort
TCP port to listen on.
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/nodejs-server/index.html b/docs/generators/nodejs-server/index.html
new file mode 100644
index 00000000000..82ed04988d8
--- /dev/null
+++ b/docs/generators/nodejs-server/index.html
@@ -0,0 +1,22 @@
+generators/nodejs-server · OpenAPI Generator
id: generator-opts-server-nodejs-server
+title: Config Options for nodejs-server
+sidebar_label: nodejs-server
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
googleCloudFunctions
When specified, it will generate the code which runs within Google Cloud Functions instead of standalone Node.JS server. See https://cloud.google.com/functions/docs/quickstart for the details of how to deploy the generated code.
false
+
exportedName
When the generated code will be deployed to Google Cloud Functions, this option can be used to update the name of the exported function. By default, it refers to the basePath. This does not affect normal standalone nodejs server code.
null
+
serverPort
TCP port to listen on.
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/objc.html b/docs/generators/objc.html
new file mode 100644
index 00000000000..095c14f64ba
--- /dev/null
+++ b/docs/generators/objc.html
@@ -0,0 +1,23 @@
+generators/objc · OpenAPI Generator
Hides the generation timestamp when files are generated.
true
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/objc/index.html b/docs/generators/objc/index.html
new file mode 100644
index 00000000000..095c14f64ba
--- /dev/null
+++ b/docs/generators/objc/index.html
@@ -0,0 +1,23 @@
+generators/objc · OpenAPI Generator
Hides the generation timestamp when files are generated.
true
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/openapi-yaml.html b/docs/generators/openapi-yaml.html
new file mode 100644
index 00000000000..b25ebc1adbc
--- /dev/null
+++ b/docs/generators/openapi-yaml.html
@@ -0,0 +1,20 @@
+generators/openapi-yaml · OpenAPI Generator
id: generator-opts-documentation-openapi-yaml
+title: Config Options for openapi-yaml
+sidebar_label: openapi-yaml
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
outputFile
output filename
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/openapi-yaml/index.html b/docs/generators/openapi-yaml/index.html
new file mode 100644
index 00000000000..b25ebc1adbc
--- /dev/null
+++ b/docs/generators/openapi-yaml/index.html
@@ -0,0 +1,20 @@
+generators/openapi-yaml · OpenAPI Generator
id: generator-opts-documentation-openapi-yaml
+title: Config Options for openapi-yaml
+sidebar_label: openapi-yaml
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
outputFile
output filename
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/openapi.html b/docs/generators/openapi.html
new file mode 100644
index 00000000000..3c0d58a4d61
--- /dev/null
+++ b/docs/generators/openapi.html
@@ -0,0 +1,19 @@
+generators/openapi · OpenAPI Generator
id: generator-opts-documentation-openapi
+title: Config Options for openapi
+sidebar_label: openapi
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/openapi/index.html b/docs/generators/openapi/index.html
new file mode 100644
index 00000000000..3c0d58a4d61
--- /dev/null
+++ b/docs/generators/openapi/index.html
@@ -0,0 +1,19 @@
+generators/openapi · OpenAPI Generator
id: generator-opts-documentation-openapi
+title: Config Options for openapi
+sidebar_label: openapi
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/perl.html b/docs/generators/perl.html
new file mode 100644
index 00000000000..7aa5dd21353
--- /dev/null
+++ b/docs/generators/perl.html
@@ -0,0 +1,21 @@
+generators/perl · OpenAPI Generator
id: generator-opts-client-perl
+title: Config Options for perl
+sidebar_label: perl
+
+
+
+
Option
Description
Values
Default
+
+
+
moduleName
Perl module name (convention: CamelCase or Long::Module).
OpenAPIClient
+
moduleVersion
Perl module version.
1.0.0
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
hideGenerationTimestamp
Hides the generation timestamp when files are generated.
true
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/perl/index.html b/docs/generators/perl/index.html
new file mode 100644
index 00000000000..7aa5dd21353
--- /dev/null
+++ b/docs/generators/perl/index.html
@@ -0,0 +1,21 @@
+generators/perl · OpenAPI Generator
id: generator-opts-client-perl
+title: Config Options for perl
+sidebar_label: perl
+
+
+
+
Option
Description
Values
Default
+
+
+
moduleName
Perl module name (convention: CamelCase or Long::Module).
OpenAPIClient
+
moduleVersion
Perl module version.
1.0.0
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
hideGenerationTimestamp
Hides the generation timestamp when files are generated.
true
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/php-laravel.html b/docs/generators/php-laravel.html
new file mode 100644
index 00000000000..268cb34978c
--- /dev/null
+++ b/docs/generators/php-laravel.html
@@ -0,0 +1,28 @@
+generators/php-laravel · OpenAPI Generator
id: generator-opts-server-php-laravel
+title: Config Options for php-laravel
+sidebar_label: php-laravel
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
variableNamingConvention
naming convention of variable name, e.g. camelCase.
snake_case
+
invokerPackage
The main namespace to use for all classes. e.g. Yay\Pets
null
+
packageName
The main package name for classes. e.g. GeneratedPetstore
null
+
srcBasePath
The directory to serve as source root.
null
+
gitUserId
Git user ID, e.g. openapitools.
null
+
gitRepoId
Git repo ID, e.g. openapi-generator.
null
+
artifactVersion
The version to use in the composer package version field. e.g. 1.2.3
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/php-laravel/index.html b/docs/generators/php-laravel/index.html
new file mode 100644
index 00000000000..268cb34978c
--- /dev/null
+++ b/docs/generators/php-laravel/index.html
@@ -0,0 +1,28 @@
+generators/php-laravel · OpenAPI Generator
id: generator-opts-server-php-laravel
+title: Config Options for php-laravel
+sidebar_label: php-laravel
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
variableNamingConvention
naming convention of variable name, e.g. camelCase.
snake_case
+
invokerPackage
The main namespace to use for all classes. e.g. Yay\Pets
null
+
packageName
The main package name for classes. e.g. GeneratedPetstore
null
+
srcBasePath
The directory to serve as source root.
null
+
gitUserId
Git user ID, e.g. openapitools.
null
+
gitRepoId
Git repo ID, e.g. openapi-generator.
null
+
artifactVersion
The version to use in the composer package version field. e.g. 1.2.3
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/php-lumen.html b/docs/generators/php-lumen.html
new file mode 100644
index 00000000000..62e3e418e34
--- /dev/null
+++ b/docs/generators/php-lumen.html
@@ -0,0 +1,28 @@
+generators/php-lumen · OpenAPI Generator
id: generator-opts-server-php-lumen
+title: Config Options for php-lumen
+sidebar_label: php-lumen
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
variableNamingConvention
naming convention of variable name, e.g. camelCase.
snake_case
+
invokerPackage
The main namespace to use for all classes. e.g. Yay\Pets
null
+
packageName
The main package name for classes. e.g. GeneratedPetstore
null
+
srcBasePath
The directory to serve as source root.
null
+
gitUserId
Git user ID, e.g. openapitools.
null
+
gitRepoId
Git repo ID, e.g. openapi-generator.
null
+
artifactVersion
The version to use in the composer package version field. e.g. 1.2.3
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/php-lumen/index.html b/docs/generators/php-lumen/index.html
new file mode 100644
index 00000000000..62e3e418e34
--- /dev/null
+++ b/docs/generators/php-lumen/index.html
@@ -0,0 +1,28 @@
+generators/php-lumen · OpenAPI Generator
id: generator-opts-server-php-lumen
+title: Config Options for php-lumen
+sidebar_label: php-lumen
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
variableNamingConvention
naming convention of variable name, e.g. camelCase.
snake_case
+
invokerPackage
The main namespace to use for all classes. e.g. Yay\Pets
null
+
packageName
The main package name for classes. e.g. GeneratedPetstore
null
+
srcBasePath
The directory to serve as source root.
null
+
gitUserId
Git user ID, e.g. openapitools.
null
+
gitRepoId
Git repo ID, e.g. openapi-generator.
null
+
artifactVersion
The version to use in the composer package version field. e.g. 1.2.3
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/php-silex.html b/docs/generators/php-silex.html
new file mode 100644
index 00000000000..553f7b0a0b0
--- /dev/null
+++ b/docs/generators/php-silex.html
@@ -0,0 +1,19 @@
+generators/php-silex · OpenAPI Generator
id: generator-opts-server-php-silex
+title: Config Options for php-silex
+sidebar_label: php-silex
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/php-silex/index.html b/docs/generators/php-silex/index.html
new file mode 100644
index 00000000000..553f7b0a0b0
--- /dev/null
+++ b/docs/generators/php-silex/index.html
@@ -0,0 +1,19 @@
+generators/php-silex · OpenAPI Generator
id: generator-opts-server-php-silex
+title: Config Options for php-silex
+sidebar_label: php-silex
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/php-slim.html b/docs/generators/php-slim.html
new file mode 100644
index 00000000000..880d2602465
--- /dev/null
+++ b/docs/generators/php-slim.html
@@ -0,0 +1,28 @@
+generators/php-slim · OpenAPI Generator
id: generator-opts-server-php-slim
+title: Config Options for php-slim
+sidebar_label: php-slim
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
variableNamingConvention
naming convention of variable name, e.g. camelCase.
camelCase
+
invokerPackage
The main namespace to use for all classes. e.g. Yay\Pets
null
+
packageName
The main package name for classes. e.g. GeneratedPetstore
null
+
srcBasePath
The directory to serve as source root.
null
+
gitUserId
Git user ID, e.g. openapitools.
null
+
gitRepoId
Git repo ID, e.g. openapi-generator.
null
+
artifactVersion
The version to use in the composer package version field. e.g. 1.2.3
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/php-slim/index.html b/docs/generators/php-slim/index.html
new file mode 100644
index 00000000000..880d2602465
--- /dev/null
+++ b/docs/generators/php-slim/index.html
@@ -0,0 +1,28 @@
+generators/php-slim · OpenAPI Generator
id: generator-opts-server-php-slim
+title: Config Options for php-slim
+sidebar_label: php-slim
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
variableNamingConvention
naming convention of variable name, e.g. camelCase.
camelCase
+
invokerPackage
The main namespace to use for all classes. e.g. Yay\Pets
null
+
packageName
The main package name for classes. e.g. GeneratedPetstore
null
+
srcBasePath
The directory to serve as source root.
null
+
gitUserId
Git user ID, e.g. openapitools.
null
+
gitRepoId
Git repo ID, e.g. openapi-generator.
null
+
artifactVersion
The version to use in the composer package version field. e.g. 1.2.3
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/php-symfony.html b/docs/generators/php-symfony.html
new file mode 100644
index 00000000000..7dd7c002791
--- /dev/null
+++ b/docs/generators/php-symfony.html
@@ -0,0 +1,33 @@
+generators/php-symfony · OpenAPI Generator
id: generator-opts-server-php-symfony
+title: Config Options for php-symfony
+sidebar_label: php-symfony
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
variableNamingConvention
naming convention of variable name, e.g. camelCase.
snake_case
+
invokerPackage
The main namespace to use for all classes. e.g. Yay\Pets
null
+
packageName
The main package name for classes. e.g. GeneratedPetstore
null
+
srcBasePath
The directory to serve as source root.
null
+
gitUserId
Git user ID, e.g. openapitools.
null
+
gitRepoId
Git repo ID, e.g. openapi-generator.
null
+
artifactVersion
The version to use in the composer package version field. e.g. 1.2.3
null
+
composerVendorName
The vendor name used in the composer package name. The template uses {{composerVendorName}}/{{composerProjectName}} for the composer package name. e.g. yaypets
null
+
bundleName
The name of the Symfony bundle. The template uses {{bundleName}}
null
+
composerProjectName
The project name used in the composer package name. The template uses {{composerVendorName}}/{{composerProjectName}} for the composer package name. e.g. petstore-client
null
+
hideGenerationTimestamp
Hides the generation timestamp when files are generated.
true
+
phpLegacySupport
Should the generated code be compatible with PHP 5.x?
true
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/php-symfony/index.html b/docs/generators/php-symfony/index.html
new file mode 100644
index 00000000000..7dd7c002791
--- /dev/null
+++ b/docs/generators/php-symfony/index.html
@@ -0,0 +1,33 @@
+generators/php-symfony · OpenAPI Generator
id: generator-opts-server-php-symfony
+title: Config Options for php-symfony
+sidebar_label: php-symfony
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
variableNamingConvention
naming convention of variable name, e.g. camelCase.
snake_case
+
invokerPackage
The main namespace to use for all classes. e.g. Yay\Pets
null
+
packageName
The main package name for classes. e.g. GeneratedPetstore
null
+
srcBasePath
The directory to serve as source root.
null
+
gitUserId
Git user ID, e.g. openapitools.
null
+
gitRepoId
Git repo ID, e.g. openapi-generator.
null
+
artifactVersion
The version to use in the composer package version field. e.g. 1.2.3
null
+
composerVendorName
The vendor name used in the composer package name. The template uses {{composerVendorName}}/{{composerProjectName}} for the composer package name. e.g. yaypets
null
+
bundleName
The name of the Symfony bundle. The template uses {{bundleName}}
null
+
composerProjectName
The project name used in the composer package name. The template uses {{composerVendorName}}/{{composerProjectName}} for the composer package name. e.g. petstore-client
null
+
hideGenerationTimestamp
Hides the generation timestamp when files are generated.
true
+
phpLegacySupport
Should the generated code be compatible with PHP 5.x?
true
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/php-ze-ph.html b/docs/generators/php-ze-ph.html
new file mode 100644
index 00000000000..ad3c7ce5723
--- /dev/null
+++ b/docs/generators/php-ze-ph.html
@@ -0,0 +1,28 @@
+generators/php-ze-ph · OpenAPI Generator
id: generator-opts-server-php-ze-ph
+title: Config Options for php-ze-ph
+sidebar_label: php-ze-ph
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
variableNamingConvention
naming convention of variable name, e.g. camelCase.
snake_case
+
invokerPackage
The main namespace to use for all classes. e.g. Yay\Pets
null
+
packageName
The main package name for classes. e.g. GeneratedPetstore
null
+
srcBasePath
The directory to serve as source root.
null
+
gitUserId
Git user ID, e.g. openapitools.
null
+
gitRepoId
Git repo ID, e.g. openapi-generator.
null
+
artifactVersion
The version to use in the composer package version field. e.g. 1.2.3
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/php-ze-ph/index.html b/docs/generators/php-ze-ph/index.html
new file mode 100644
index 00000000000..ad3c7ce5723
--- /dev/null
+++ b/docs/generators/php-ze-ph/index.html
@@ -0,0 +1,28 @@
+generators/php-ze-ph · OpenAPI Generator
id: generator-opts-server-php-ze-ph
+title: Config Options for php-ze-ph
+sidebar_label: php-ze-ph
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
variableNamingConvention
naming convention of variable name, e.g. camelCase.
snake_case
+
invokerPackage
The main namespace to use for all classes. e.g. Yay\Pets
null
+
packageName
The main package name for classes. e.g. GeneratedPetstore
null
+
srcBasePath
The directory to serve as source root.
null
+
gitUserId
Git user ID, e.g. openapitools.
null
+
gitRepoId
Git repo ID, e.g. openapi-generator.
null
+
artifactVersion
The version to use in the composer package version field. e.g. 1.2.3
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/php.html b/docs/generators/php.html
new file mode 100644
index 00000000000..5225c4da8ab
--- /dev/null
+++ b/docs/generators/php.html
@@ -0,0 +1,31 @@
+generators/php · OpenAPI Generator
id: generator-opts-client-php
+title: Config Options for php
+sidebar_label: php
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
variableNamingConvention
naming convention of variable name, e.g. camelCase.
snake_case
+
invokerPackage
The main namespace to use for all classes. e.g. Yay\Pets
null
+
packageName
The main package name for classes. e.g. GeneratedPetstore
null
+
srcBasePath
The directory to serve as source root.
null
+
gitUserId
Git user ID, e.g. openapitools.
null
+
gitRepoId
Git repo ID, e.g. openapi-generator.
null
+
artifactVersion
The version to use in the composer package version field. e.g. 1.2.3
null
+
composerVendorName
The vendor name used in the composer package name. The template uses {{composerVendorName}}/{{composerProjectName}} for the composer package name. e.g. yaypets. IMPORTANT NOTE (2016/03): composerVendorName will be deprecated and replaced by gitUserId in the next openapi-generator release
null
+
composerProjectName
The project name used in the composer package name. The template uses {{composerVendorName}}/{{composerProjectName}} for the composer package name. e.g. petstore-client. IMPORTANT NOTE (2016/03): composerProjectName will be deprecated and replaced by gitRepoId in the next openapi-generator release
null
+
hideGenerationTimestamp
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
true
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/php/index.html b/docs/generators/php/index.html
new file mode 100644
index 00000000000..5225c4da8ab
--- /dev/null
+++ b/docs/generators/php/index.html
@@ -0,0 +1,31 @@
+generators/php · OpenAPI Generator
id: generator-opts-client-php
+title: Config Options for php
+sidebar_label: php
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
variableNamingConvention
naming convention of variable name, e.g. camelCase.
snake_case
+
invokerPackage
The main namespace to use for all classes. e.g. Yay\Pets
null
+
packageName
The main package name for classes. e.g. GeneratedPetstore
null
+
srcBasePath
The directory to serve as source root.
null
+
gitUserId
Git user ID, e.g. openapitools.
null
+
gitRepoId
Git repo ID, e.g. openapi-generator.
null
+
artifactVersion
The version to use in the composer package version field. e.g. 1.2.3
null
+
composerVendorName
The vendor name used in the composer package name. The template uses {{composerVendorName}}/{{composerProjectName}} for the composer package name. e.g. yaypets. IMPORTANT NOTE (2016/03): composerVendorName will be deprecated and replaced by gitUserId in the next openapi-generator release
null
+
composerProjectName
The project name used in the composer package name. The template uses {{composerVendorName}}/{{composerProjectName}} for the composer package name. e.g. petstore-client. IMPORTANT NOTE (2016/03): composerProjectName will be deprecated and replaced by gitRepoId in the next openapi-generator release
null
+
hideGenerationTimestamp
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
true
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/powershell.html b/docs/generators/powershell.html
new file mode 100644
index 00000000000..47732248136
--- /dev/null
+++ b/docs/generators/powershell.html
@@ -0,0 +1,18 @@
+generators/powershell · OpenAPI Generator
id: generator-opts-client-powershell
+title: Config Options for powershell
+sidebar_label: powershell
+
+
+
+
Option
Description
Values
Default
+
+
+
packageName
Client package name (e.g. org.openapitools.client).
Org.OpenAPITools
+
packageGuid
GUID for PowerShell module (e.g. a27b908d-2a20-467f-bc32-af6f3a654ac5). A random GUID will be generated by default.
null
+
csharpClientPath
Path to the C# API client generated by OpenAPI Generator, e.g. $ScriptDir..\csharp\OpenAPIClient where $ScriptDir is the current directory. NOTE: you will need to generate the C# API client separately.
$ScriptDir\csharp\OpenAPIClient
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/powershell/index.html b/docs/generators/powershell/index.html
new file mode 100644
index 00000000000..47732248136
--- /dev/null
+++ b/docs/generators/powershell/index.html
@@ -0,0 +1,18 @@
+generators/powershell · OpenAPI Generator
id: generator-opts-client-powershell
+title: Config Options for powershell
+sidebar_label: powershell
+
+
+
+
Option
Description
Values
Default
+
+
+
packageName
Client package name (e.g. org.openapitools.client).
Org.OpenAPITools
+
packageGuid
GUID for PowerShell module (e.g. a27b908d-2a20-467f-bc32-af6f3a654ac5). A random GUID will be generated by default.
null
+
csharpClientPath
Path to the C# API client generated by OpenAPI Generator, e.g. $ScriptDir..\csharp\OpenAPIClient where $ScriptDir is the current directory. NOTE: you will need to generate the C# API client separately.
$ScriptDir\csharp\OpenAPIClient
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/python-flask.html b/docs/generators/python-flask.html
new file mode 100644
index 00000000000..36029c26ef6
--- /dev/null
+++ b/docs/generators/python-flask.html
@@ -0,0 +1,25 @@
+generators/python-flask · OpenAPI Generator
id: generator-opts-server-python-flask
+title: Config Options for python-flask
+sidebar_label: python-flask
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
packageName
python package name (convention: snake_case).
openapi_server
+
packageVersion
python package version.
1.0.0
+
controllerPackage
controller package
controllers
+
defaultController
default controller
default_controller
+
supportPython2
support python2
false
+
serverPort
TCP port to listen to in app.run
8080
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/python-flask/index.html b/docs/generators/python-flask/index.html
new file mode 100644
index 00000000000..36029c26ef6
--- /dev/null
+++ b/docs/generators/python-flask/index.html
@@ -0,0 +1,25 @@
+generators/python-flask · OpenAPI Generator
id: generator-opts-server-python-flask
+title: Config Options for python-flask
+sidebar_label: python-flask
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
packageName
python package name (convention: snake_case).
openapi_server
+
packageVersion
python package version.
1.0.0
+
controllerPackage
controller package
controllers
+
defaultController
default controller
default_controller
+
supportPython2
support python2
false
+
serverPort
TCP port to listen to in app.run
8080
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/python.html b/docs/generators/python.html
new file mode 100644
index 00000000000..3f175e7e9b1
--- /dev/null
+++ b/docs/generators/python.html
@@ -0,0 +1,23 @@
+generators/python · OpenAPI Generator
id: generator-opts-client-python
+title: Config Options for python
+sidebar_label: python
+
+
+
+
Option
Description
Values
Default
+
+
+
packageName
python package name (convention: snake_case).
openapi_client
+
projectName
python project name in setup.py (e.g. petstore-api).
null
+
packageVersion
python package version.
1.0.0
+
packageUrl
python package URL.
null
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
hideGenerationTimestamp
Hides the generation timestamp when files are generated.
true
+
generateSourceCodeOnly
Specifies that only a library source code is to be generated.
false
+
library
library template (sub-template) to use: asyncio, tornado, urllib3
urllib3
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/python/index.html b/docs/generators/python/index.html
new file mode 100644
index 00000000000..3f175e7e9b1
--- /dev/null
+++ b/docs/generators/python/index.html
@@ -0,0 +1,23 @@
+generators/python · OpenAPI Generator
id: generator-opts-client-python
+title: Config Options for python
+sidebar_label: python
+
+
+
+
Option
Description
Values
Default
+
+
+
packageName
python package name (convention: snake_case).
openapi_client
+
projectName
python project name in setup.py (e.g. petstore-api).
null
+
packageVersion
python package version.
1.0.0
+
packageUrl
python package URL.
null
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
hideGenerationTimestamp
Hides the generation timestamp when files are generated.
true
+
generateSourceCodeOnly
Specifies that only a library source code is to be generated.
false
+
library
library template (sub-template) to use: asyncio, tornado, urllib3
urllib3
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/r.html b/docs/generators/r.html
new file mode 100644
index 00000000000..fb3cbb2138b
--- /dev/null
+++ b/docs/generators/r.html
@@ -0,0 +1,18 @@
+generators/r · OpenAPI Generator
id: generator-opts-client-r
+title: Config Options for r
+sidebar_label: r
+
+
+
+
Option
Description
Values
Default
+
+
+
packageName
R package name (convention: lowercase).
openapi
+
packageVersion
R package version.
1.0.0
+
hideGenerationTimestamp
Hides the generation timestamp when files are generated.
true
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/r/index.html b/docs/generators/r/index.html
new file mode 100644
index 00000000000..fb3cbb2138b
--- /dev/null
+++ b/docs/generators/r/index.html
@@ -0,0 +1,18 @@
+generators/r · OpenAPI Generator
id: generator-opts-client-r
+title: Config Options for r
+sidebar_label: r
+
+
+
+
Option
Description
Values
Default
+
+
+
packageName
R package name (convention: lowercase).
openapi
+
packageVersion
R package version.
1.0.0
+
hideGenerationTimestamp
Hides the generation timestamp when files are generated.
true
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/ruby-on-rails.html b/docs/generators/ruby-on-rails.html
new file mode 100644
index 00000000000..f63f8298e16
--- /dev/null
+++ b/docs/generators/ruby-on-rails.html
@@ -0,0 +1,16 @@
+generators/ruby-on-rails · OpenAPI Generator
id: generator-opts-server-ruby-on-rails
+title: Config Options for ruby-on-rails
+sidebar_label: ruby-on-rails
+
+
+
+
Option
Description
Values
Default
+
+
+
databaseAdapter
The adapter for database (e.g. mysql, sqlite). Default: sqlite
sqlite
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/ruby-on-rails/index.html b/docs/generators/ruby-on-rails/index.html
new file mode 100644
index 00000000000..f63f8298e16
--- /dev/null
+++ b/docs/generators/ruby-on-rails/index.html
@@ -0,0 +1,16 @@
+generators/ruby-on-rails · OpenAPI Generator
id: generator-opts-server-ruby-on-rails
+title: Config Options for ruby-on-rails
+sidebar_label: ruby-on-rails
+
+
+
+
Option
Description
Values
Default
+
+
+
databaseAdapter
The adapter for database (e.g. mysql, sqlite). Default: sqlite
sqlite
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/ruby-sinatra.html b/docs/generators/ruby-sinatra.html
new file mode 100644
index 00000000000..eff0d3e800b
--- /dev/null
+++ b/docs/generators/ruby-sinatra.html
@@ -0,0 +1,15 @@
+generators/ruby-sinatra · OpenAPI Generator
id: generator-opts-server-ruby-sinatra
+title: Config Options for ruby-sinatra
+sidebar_label: ruby-sinatra
+
+
+
+
Option
Description
Values
Default
+
+
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/ruby-sinatra/index.html b/docs/generators/ruby-sinatra/index.html
new file mode 100644
index 00000000000..eff0d3e800b
--- /dev/null
+++ b/docs/generators/ruby-sinatra/index.html
@@ -0,0 +1,15 @@
+generators/ruby-sinatra · OpenAPI Generator
id: generator-opts-server-ruby-sinatra
+title: Config Options for ruby-sinatra
+sidebar_label: ruby-sinatra
+
+
+
+
Option
Description
Values
Default
+
+
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/ruby.html b/docs/generators/ruby.html
new file mode 100644
index 00000000000..4796681a9cb
--- /dev/null
+++ b/docs/generators/ruby.html
@@ -0,0 +1,30 @@
+generators/ruby · OpenAPI Generator
Hides the generation timestamp when files are generated.
true
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/ruby/index.html b/docs/generators/ruby/index.html
new file mode 100644
index 00000000000..4796681a9cb
--- /dev/null
+++ b/docs/generators/ruby/index.html
@@ -0,0 +1,30 @@
+generators/ruby · OpenAPI Generator
Hides the generation timestamp when files are generated.
true
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/rust-server.html b/docs/generators/rust-server.html
new file mode 100644
index 00000000000..8bbd4c7177b
--- /dev/null
+++ b/docs/generators/rust-server.html
@@ -0,0 +1,17 @@
+generators/rust-server · OpenAPI Generator
id: generator-opts-server-rust-server
+title: Config Options for rust-server
+sidebar_label: rust-server
+
+
+
+
Option
Description
Values
Default
+
+
+
packageName
Rust crate name (convention: snake_case).
openapi_client
+
packageVersion
Rust crate version.
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/rust-server/index.html b/docs/generators/rust-server/index.html
new file mode 100644
index 00000000000..8bbd4c7177b
--- /dev/null
+++ b/docs/generators/rust-server/index.html
@@ -0,0 +1,17 @@
+generators/rust-server · OpenAPI Generator
id: generator-opts-server-rust-server
+title: Config Options for rust-server
+sidebar_label: rust-server
+
+
+
+
Option
Description
Values
Default
+
+
+
packageName
Rust crate name (convention: snake_case).
openapi_client
+
packageVersion
Rust crate version.
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/rust.html b/docs/generators/rust.html
new file mode 100644
index 00000000000..44731f691f4
--- /dev/null
+++ b/docs/generators/rust.html
@@ -0,0 +1,19 @@
+generators/rust · OpenAPI Generator
id: generator-opts-client-rust
+title: Config Options for rust
+sidebar_label: rust
+
+
+
+
Option
Description
Values
Default
+
+
+
packageName
Rust package name (convention: lowercase).
openapi
+
packageVersion
Rust package version.
1.0.0
+
hideGenerationTimestamp
Hides the generation timestamp when files are generated.
true
+
library
library template (sub-template) to use.
hyper
HTTP client: Hyper.
reqwest
HTTP client: Reqwest.
hyper
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/rust/index.html b/docs/generators/rust/index.html
new file mode 100644
index 00000000000..44731f691f4
--- /dev/null
+++ b/docs/generators/rust/index.html
@@ -0,0 +1,19 @@
+generators/rust · OpenAPI Generator
id: generator-opts-client-rust
+title: Config Options for rust
+sidebar_label: rust
+
+
+
+
Option
Description
Values
Default
+
+
+
packageName
Rust package name (convention: lowercase).
openapi
+
packageVersion
Rust package version.
1.0.0
+
hideGenerationTimestamp
Hides the generation timestamp when files are generated.
true
+
library
library template (sub-template) to use.
hyper
HTTP client: Hyper.
reqwest
HTTP client: Reqwest.
hyper
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/scala-akka.html b/docs/generators/scala-akka.html
new file mode 100644
index 00000000000..d5bc0ecbb9f
--- /dev/null
+++ b/docs/generators/scala-akka.html
@@ -0,0 +1,23 @@
+generators/scala-akka · OpenAPI Generator
id: generator-opts-client-scala-akka
+title: Config Options for scala-akka
+sidebar_label: scala-akka
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
sourceFolder
source folder for generated code
null
+
mainPackage
Top-level package name, which defines 'apiPackage', 'modelPackage', 'invokerPackage'
org.openapitools.client
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/scala-akka/index.html b/docs/generators/scala-akka/index.html
new file mode 100644
index 00000000000..d5bc0ecbb9f
--- /dev/null
+++ b/docs/generators/scala-akka/index.html
@@ -0,0 +1,23 @@
+generators/scala-akka · OpenAPI Generator
id: generator-opts-client-scala-akka
+title: Config Options for scala-akka
+sidebar_label: scala-akka
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
sourceFolder
source folder for generated code
null
+
mainPackage
Top-level package name, which defines 'apiPackage', 'modelPackage', 'invokerPackage'
org.openapitools.client
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/scala-finch.html b/docs/generators/scala-finch.html
new file mode 100644
index 00000000000..b66b013e01a
--- /dev/null
+++ b/docs/generators/scala-finch.html
@@ -0,0 +1,18 @@
+generators/scala-finch · OpenAPI Generator
id: generator-opts-server-scala-finch
+title: Config Options for scala-finch
+sidebar_label: scala-finch
+
+
+
+
Option
Description
Values
Default
+
+
+
packageName
Finch package name (e.g. org.openapitools).
org.openapitools
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/scala-finch/index.html b/docs/generators/scala-finch/index.html
new file mode 100644
index 00000000000..b66b013e01a
--- /dev/null
+++ b/docs/generators/scala-finch/index.html
@@ -0,0 +1,18 @@
+generators/scala-finch · OpenAPI Generator
id: generator-opts-server-scala-finch
+title: Config Options for scala-finch
+sidebar_label: scala-finch
+
+
+
+
Option
Description
Values
Default
+
+
+
packageName
Finch package name (e.g. org.openapitools).
org.openapitools
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/scala-gatling.html b/docs/generators/scala-gatling.html
new file mode 100644
index 00000000000..008eaa2fb1f
--- /dev/null
+++ b/docs/generators/scala-gatling.html
@@ -0,0 +1,22 @@
+generators/scala-gatling · OpenAPI Generator
id: generator-opts-client-scala-gatling
+title: Config Options for scala-gatling
+sidebar_label: scala-gatling
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
sourceFolder
source folder for generated code
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/scala-gatling/index.html b/docs/generators/scala-gatling/index.html
new file mode 100644
index 00000000000..008eaa2fb1f
--- /dev/null
+++ b/docs/generators/scala-gatling/index.html
@@ -0,0 +1,22 @@
+generators/scala-gatling · OpenAPI Generator
id: generator-opts-client-scala-gatling
+title: Config Options for scala-gatling
+sidebar_label: scala-gatling
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
sourceFolder
source folder for generated code
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/scala-httpclient.html b/docs/generators/scala-httpclient.html
new file mode 100644
index 00000000000..ea135bc6c5f
--- /dev/null
+++ b/docs/generators/scala-httpclient.html
@@ -0,0 +1,23 @@
+generators/scala-httpclient · OpenAPI Generator
id: generator-opts-client-scala-httpclient
+title: Config Options for scala-httpclient
+sidebar_label: scala-httpclient
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
sourceFolder
source folder for generated code
null
+
modelPropertyNaming
Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name
camelCase
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/scala-httpclient/index.html b/docs/generators/scala-httpclient/index.html
new file mode 100644
index 00000000000..ea135bc6c5f
--- /dev/null
+++ b/docs/generators/scala-httpclient/index.html
@@ -0,0 +1,23 @@
+generators/scala-httpclient · OpenAPI Generator
id: generator-opts-client-scala-httpclient
+title: Config Options for scala-httpclient
+sidebar_label: scala-httpclient
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
sourceFolder
source folder for generated code
null
+
modelPropertyNaming
Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name
camelCase
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/scala-lagom-server.html b/docs/generators/scala-lagom-server.html
new file mode 100644
index 00000000000..ea0dbaf5b58
--- /dev/null
+++ b/docs/generators/scala-lagom-server.html
@@ -0,0 +1,23 @@
+generators/scala-lagom-server · OpenAPI Generator
id: generator-opts-server-scala-lagom-server
+title: Config Options for scala-lagom-server
+sidebar_label: scala-lagom-server
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
sourceFolder
source folder for generated code
null
+
modelPropertyNaming
Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name
camelCase
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/scala-lagom-server/index.html b/docs/generators/scala-lagom-server/index.html
new file mode 100644
index 00000000000..ea0dbaf5b58
--- /dev/null
+++ b/docs/generators/scala-lagom-server/index.html
@@ -0,0 +1,23 @@
+generators/scala-lagom-server · OpenAPI Generator
id: generator-opts-server-scala-lagom-server
+title: Config Options for scala-lagom-server
+sidebar_label: scala-lagom-server
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
sourceFolder
source folder for generated code
null
+
modelPropertyNaming
Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name
camelCase
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/scalatra.html b/docs/generators/scalatra.html
new file mode 100644
index 00000000000..5292054cdcb
--- /dev/null
+++ b/docs/generators/scalatra.html
@@ -0,0 +1,22 @@
+generators/scalatra · OpenAPI Generator
id: generator-opts-server-scalatra
+title: Config Options for scalatra
+sidebar_label: scalatra
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
sourceFolder
source folder for generated code
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/scalatra/index.html b/docs/generators/scalatra/index.html
new file mode 100644
index 00000000000..5292054cdcb
--- /dev/null
+++ b/docs/generators/scalatra/index.html
@@ -0,0 +1,22 @@
+generators/scalatra · OpenAPI Generator
id: generator-opts-server-scalatra
+title: Config Options for scalatra
+sidebar_label: scalatra
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
sourceFolder
source folder for generated code
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/scalaz.html b/docs/generators/scalaz.html
new file mode 100644
index 00000000000..f270026e411
--- /dev/null
+++ b/docs/generators/scalaz.html
@@ -0,0 +1,23 @@
+generators/scalaz · OpenAPI Generator
id: generator-opts-client-scalaz
+title: Config Options for scalaz
+sidebar_label: scalaz
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
sourceFolder
source folder for generated code
null
+
modelPropertyNaming
Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name
camelCase
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/scalaz/index.html b/docs/generators/scalaz/index.html
new file mode 100644
index 00000000000..f270026e411
--- /dev/null
+++ b/docs/generators/scalaz/index.html
@@ -0,0 +1,23 @@
+generators/scalaz · OpenAPI Generator
id: generator-opts-client-scalaz
+title: Config Options for scalaz
+sidebar_label: scalaz
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
sourceFolder
source folder for generated code
null
+
modelPropertyNaming
Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name
camelCase
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/spring.html b/docs/generators/spring.html
new file mode 100644
index 00000000000..17390a39b30
--- /dev/null
+++ b/docs/generators/spring.html
@@ -0,0 +1,71 @@
+generators/spring · OpenAPI Generator
id: generator-opts-server-spring
+title: Config Options for spring
+sidebar_label: spring
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
invokerPackage
root package for generated code
null
+
groupId
groupId in generated pom.xml
null
+
artifactId
artifactId in generated pom.xml
null
+
artifactVersion
artifact version in generated pom.xml
null
+
artifactUrl
artifact URL in generated pom.xml
null
+
artifactDescription
artifact description in generated pom.xml
null
+
scmConnection
SCM connection in generated pom.xml
null
+
scmDeveloperConnection
SCM developer connection in generated pom.xml
null
+
scmUrl
SCM URL in generated pom.xml
null
+
developerName
developer name in generated pom.xml
null
+
developerEmail
developer email in generated pom.xml
null
+
developerOrganization
developer organization in generated pom.xml
null
+
developerOrganizationUrl
developer organization URL in generated pom.xml
null
+
licenseName
The name of the license
null
+
licenseUrl
The URL of the license
null
+
sourceFolder
source folder for generated code
null
+
localVariablePrefix
prefix for generated code members and local variables
null
+
serializableModel
boolean - toggle "implements Serializable" for generated models
false
+
bigDecimalAsString
Treat BigDecimal values as Strings to avoid precision loss.
false
+
fullJavaUtil
whether to use fully qualified name for classes under java.util. This option only works for Java API client
false
+
hideGenerationTimestamp
hides the timestamp when files were generated
null
+
withXml
whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)
false
+
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)
null
+
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
null
+
disableHtmlEscaping
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)
false
+
booleanGetterPrefix
Set booleanGetterPrefix (default value 'get')
null
+
parentGroupId
parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentArtifactId
parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentVersion
parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
title
server title name or client service name
null
+
configPackage
configuration package for generated code
null
+
basePackage
base package (invokerPackage) for generated code
null
+
interfaceOnly
Whether to generate only API interface stubs without the server files.
false
+
delegatePattern
Whether to generate the server files using the delegate pattern
false
+
singleContentTypes
Whether to select only one produces/consumes content-type by operation.
false
+
java8
use java8 default interface
true
+
async
use async Callable controllers
false
+
reactive
wrap responses in Mono/Flux Reactor types (spring-boot only)
false
+
responseWrapper
wrap the responses in given type (Future,Callable,CompletableFuture,ListenableFuture,DeferredResult,HystrixCommand,RxObservable,RxSingle or fully qualified type)
use tags for creating interface and controller classnames
false
+
useBeanValidation
Use BeanValidation API annotations
true
+
performBeanValidation
Use Bean Validation Impl. to perform BeanValidation
false
+
implicitHeaders
Use of @ApiImplicitParams for headers.
false
+
swaggerDocketConfig
Generate Spring OpenAPI Docket configuration class.
false
+
apiFirst
Generate the API from the OAI spec at server compile time (API first approach)
false
+
useOptional
Use Optional container for optional parameters
false
+
hateoas
Use Spring HATEOAS library to allow adding HATEOAS links
false
+
returnSuccessCode
Generated server returns 2xx code
false
+
library
library template (sub-template) to use
spring-boot
Spring-boot Server application using the SpringFox integration.
spring-mvc
Spring-MVC Server application using the SpringFox integration.
spring-cloud
Spring-Cloud-Feign client with Spring-Boot auto-configured settings.
spring-boot
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/spring/index.html b/docs/generators/spring/index.html
new file mode 100644
index 00000000000..17390a39b30
--- /dev/null
+++ b/docs/generators/spring/index.html
@@ -0,0 +1,71 @@
+generators/spring · OpenAPI Generator
id: generator-opts-server-spring
+title: Config Options for spring
+sidebar_label: spring
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPackage
package for generated models
null
+
apiPackage
package for generated api classes
null
+
invokerPackage
root package for generated code
null
+
groupId
groupId in generated pom.xml
null
+
artifactId
artifactId in generated pom.xml
null
+
artifactVersion
artifact version in generated pom.xml
null
+
artifactUrl
artifact URL in generated pom.xml
null
+
artifactDescription
artifact description in generated pom.xml
null
+
scmConnection
SCM connection in generated pom.xml
null
+
scmDeveloperConnection
SCM developer connection in generated pom.xml
null
+
scmUrl
SCM URL in generated pom.xml
null
+
developerName
developer name in generated pom.xml
null
+
developerEmail
developer email in generated pom.xml
null
+
developerOrganization
developer organization in generated pom.xml
null
+
developerOrganizationUrl
developer organization URL in generated pom.xml
null
+
licenseName
The name of the license
null
+
licenseUrl
The URL of the license
null
+
sourceFolder
source folder for generated code
null
+
localVariablePrefix
prefix for generated code members and local variables
null
+
serializableModel
boolean - toggle "implements Serializable" for generated models
false
+
bigDecimalAsString
Treat BigDecimal values as Strings to avoid precision loss.
false
+
fullJavaUtil
whether to use fully qualified name for classes under java.util. This option only works for Java API client
false
+
hideGenerationTimestamp
hides the timestamp when files were generated
null
+
withXml
whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)
false
+
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)
null
+
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
null
+
disableHtmlEscaping
Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)
false
+
booleanGetterPrefix
Set booleanGetterPrefix (default value 'get')
null
+
parentGroupId
parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentArtifactId
parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
parentVersion
parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect
null
+
title
server title name or client service name
null
+
configPackage
configuration package for generated code
null
+
basePackage
base package (invokerPackage) for generated code
null
+
interfaceOnly
Whether to generate only API interface stubs without the server files.
false
+
delegatePattern
Whether to generate the server files using the delegate pattern
false
+
singleContentTypes
Whether to select only one produces/consumes content-type by operation.
false
+
java8
use java8 default interface
true
+
async
use async Callable controllers
false
+
reactive
wrap responses in Mono/Flux Reactor types (spring-boot only)
false
+
responseWrapper
wrap the responses in given type (Future,Callable,CompletableFuture,ListenableFuture,DeferredResult,HystrixCommand,RxObservable,RxSingle or fully qualified type)
use tags for creating interface and controller classnames
false
+
useBeanValidation
Use BeanValidation API annotations
true
+
performBeanValidation
Use Bean Validation Impl. to perform BeanValidation
false
+
implicitHeaders
Use of @ApiImplicitParams for headers.
false
+
swaggerDocketConfig
Generate Spring OpenAPI Docket configuration class.
false
+
apiFirst
Generate the API from the OAI spec at server compile time (API first approach)
false
+
useOptional
Use Optional container for optional parameters
false
+
hateoas
Use Spring HATEOAS library to allow adding HATEOAS links
false
+
returnSuccessCode
Generated server returns 2xx code
false
+
library
library template (sub-template) to use
spring-boot
Spring-boot Server application using the SpringFox integration.
spring-mvc
Spring-MVC Server application using the SpringFox integration.
spring-cloud
Spring-Cloud-Feign client with Spring-Boot auto-configured settings.
spring-boot
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/swift2-deprecated.html b/docs/generators/swift2-deprecated.html
new file mode 100644
index 00000000000..7f368637e0d
--- /dev/null
+++ b/docs/generators/swift2-deprecated.html
@@ -0,0 +1,35 @@
+generators/swift2-deprecated · OpenAPI Generator
id: generator-opts-client-swift2-deprecated
+title: Config Options for swift2-deprecated
+sidebar_label: swift2-deprecated
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
projectName
Project name in Xcode
null
+
responseAs
Optionally use libraries to manage response. Currently PromiseKit, RxSwift are available.
null
+
unwrapRequired
Treat 'required' properties in response as non-optional (which would crash the app if api returns null as opposed to required option specified in json schema
null
+
podSource
Source information used for Podspec
null
+
podVersion
Version used for Podspec
null
+
podAuthors
Authors used for Podspec
null
+
podSocialMediaURL
Social Media URL used for Podspec
null
+
podDocsetURL
Docset URL used for Podspec
null
+
podLicense
License used for Podspec
null
+
podHomepage
Homepage used for Podspec
null
+
podSummary
Summary used for Podspec
null
+
podDescription
Description used for Podspec
null
+
podScreenshots
Screenshots used for Podspec
null
+
podDocumentationURL
Documentation URL used for Podspec
null
+
swiftUseApiNamespace
Flag to make all the API classes inner-class of {{projectName}}API
null
+
hideGenerationTimestamp
Hides the generation timestamp when files are generated.
true
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/swift2-deprecated/index.html b/docs/generators/swift2-deprecated/index.html
new file mode 100644
index 00000000000..7f368637e0d
--- /dev/null
+++ b/docs/generators/swift2-deprecated/index.html
@@ -0,0 +1,35 @@
+generators/swift2-deprecated · OpenAPI Generator
id: generator-opts-client-swift2-deprecated
+title: Config Options for swift2-deprecated
+sidebar_label: swift2-deprecated
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
projectName
Project name in Xcode
null
+
responseAs
Optionally use libraries to manage response. Currently PromiseKit, RxSwift are available.
null
+
unwrapRequired
Treat 'required' properties in response as non-optional (which would crash the app if api returns null as opposed to required option specified in json schema
null
+
podSource
Source information used for Podspec
null
+
podVersion
Version used for Podspec
null
+
podAuthors
Authors used for Podspec
null
+
podSocialMediaURL
Social Media URL used for Podspec
null
+
podDocsetURL
Docset URL used for Podspec
null
+
podLicense
License used for Podspec
null
+
podHomepage
Homepage used for Podspec
null
+
podSummary
Summary used for Podspec
null
+
podDescription
Description used for Podspec
null
+
podScreenshots
Screenshots used for Podspec
null
+
podDocumentationURL
Documentation URL used for Podspec
null
+
swiftUseApiNamespace
Flag to make all the API classes inner-class of {{projectName}}API
null
+
hideGenerationTimestamp
Hides the generation timestamp when files are generated.
true
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/swift3-deprecated.html b/docs/generators/swift3-deprecated.html
new file mode 100644
index 00000000000..000be33d95b
--- /dev/null
+++ b/docs/generators/swift3-deprecated.html
@@ -0,0 +1,37 @@
+generators/swift3-deprecated · OpenAPI Generator
id: generator-opts-client-swift3-deprecated
+title: Config Options for swift3-deprecated
+sidebar_label: swift3-deprecated
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
projectName
Project name in Xcode
null
+
responseAs
Optionally use libraries to manage response. Currently PromiseKit, RxSwift are available.
null
+
unwrapRequired
Treat 'required' properties in response as non-optional (which would crash the app if api returns null as opposed to required option specified in json schema
null
+
objcCompatible
Add additional properties and methods for Objective-C compatibility (default: false)
null
+
podSource
Source information used for Podspec
null
+
podVersion
Version used for Podspec
null
+
podAuthors
Authors used for Podspec
null
+
podSocialMediaURL
Social Media URL used for Podspec
null
+
podDocsetURL
Docset URL used for Podspec
null
+
podLicense
License used for Podspec
null
+
podHomepage
Homepage used for Podspec
null
+
podSummary
Summary used for Podspec
null
+
podDescription
Description used for Podspec
null
+
podScreenshots
Screenshots used for Podspec
null
+
podDocumentationURL
Documentation URL used for Podspec
null
+
swiftUseApiNamespace
Flag to make all the API classes inner-class of {{projectName}}API
null
+
hideGenerationTimestamp
Hides the generation timestamp when files are generated.
true
+
lenientTypeCast
Accept and cast values for simple types (string->bool, string->int, int->string)
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/swift3-deprecated/index.html b/docs/generators/swift3-deprecated/index.html
new file mode 100644
index 00000000000..000be33d95b
--- /dev/null
+++ b/docs/generators/swift3-deprecated/index.html
@@ -0,0 +1,37 @@
+generators/swift3-deprecated · OpenAPI Generator
id: generator-opts-client-swift3-deprecated
+title: Config Options for swift3-deprecated
+sidebar_label: swift3-deprecated
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
projectName
Project name in Xcode
null
+
responseAs
Optionally use libraries to manage response. Currently PromiseKit, RxSwift are available.
null
+
unwrapRequired
Treat 'required' properties in response as non-optional (which would crash the app if api returns null as opposed to required option specified in json schema
null
+
objcCompatible
Add additional properties and methods for Objective-C compatibility (default: false)
null
+
podSource
Source information used for Podspec
null
+
podVersion
Version used for Podspec
null
+
podAuthors
Authors used for Podspec
null
+
podSocialMediaURL
Social Media URL used for Podspec
null
+
podDocsetURL
Docset URL used for Podspec
null
+
podLicense
License used for Podspec
null
+
podHomepage
Homepage used for Podspec
null
+
podSummary
Summary used for Podspec
null
+
podDescription
Description used for Podspec
null
+
podScreenshots
Screenshots used for Podspec
null
+
podDocumentationURL
Documentation URL used for Podspec
null
+
swiftUseApiNamespace
Flag to make all the API classes inner-class of {{projectName}}API
null
+
hideGenerationTimestamp
Hides the generation timestamp when files are generated.
true
+
lenientTypeCast
Accept and cast values for simple types (string->bool, string->int, int->string)
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/swift4.html b/docs/generators/swift4.html
new file mode 100644
index 00000000000..7ab5541e218
--- /dev/null
+++ b/docs/generators/swift4.html
@@ -0,0 +1,37 @@
+generators/swift4 · OpenAPI Generator
id: generator-opts-client-swift4
+title: Config Options for swift4
+sidebar_label: swift4
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
projectName
Project name in Xcode
null
+
responseAs
Optionally use libraries to manage response. Currently PromiseKit, RxSwift are available.
null
+
unwrapRequired
Treat 'required' properties in response as non-optional (which would crash the app if api returns null as opposed to required option specified in json schema
null
+
objcCompatible
Add additional properties and methods for Objective-C compatibility (default: false)
null
+
podSource
Source information used for Podspec
null
+
podVersion
Version used for Podspec
null
+
podAuthors
Authors used for Podspec
null
+
podSocialMediaURL
Social Media URL used for Podspec
null
+
podDocsetURL
Docset URL used for Podspec
null
+
podLicense
License used for Podspec
null
+
podHomepage
Homepage used for Podspec
null
+
podSummary
Summary used for Podspec
null
+
podDescription
Description used for Podspec
null
+
podScreenshots
Screenshots used for Podspec
null
+
podDocumentationURL
Documentation URL used for Podspec
null
+
swiftUseApiNamespace
Flag to make all the API classes inner-class of {{projectName}}API
null
+
hideGenerationTimestamp
Hides the generation timestamp when files are generated.
true
+
lenientTypeCast
Accept and cast values for simple types (string->bool, string->int, int->string)
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/swift4/index.html b/docs/generators/swift4/index.html
new file mode 100644
index 00000000000..7ab5541e218
--- /dev/null
+++ b/docs/generators/swift4/index.html
@@ -0,0 +1,37 @@
+generators/swift4 · OpenAPI Generator
id: generator-opts-client-swift4
+title: Config Options for swift4
+sidebar_label: swift4
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
projectName
Project name in Xcode
null
+
responseAs
Optionally use libraries to manage response. Currently PromiseKit, RxSwift are available.
null
+
unwrapRequired
Treat 'required' properties in response as non-optional (which would crash the app if api returns null as opposed to required option specified in json schema
null
+
objcCompatible
Add additional properties and methods for Objective-C compatibility (default: false)
null
+
podSource
Source information used for Podspec
null
+
podVersion
Version used for Podspec
null
+
podAuthors
Authors used for Podspec
null
+
podSocialMediaURL
Social Media URL used for Podspec
null
+
podDocsetURL
Docset URL used for Podspec
null
+
podLicense
License used for Podspec
null
+
podHomepage
Homepage used for Podspec
null
+
podSummary
Summary used for Podspec
null
+
podDescription
Description used for Podspec
null
+
podScreenshots
Screenshots used for Podspec
null
+
podDocumentationURL
Documentation URL used for Podspec
null
+
swiftUseApiNamespace
Flag to make all the API classes inner-class of {{projectName}}API
null
+
hideGenerationTimestamp
Hides the generation timestamp when files are generated.
true
+
lenientTypeCast
Accept and cast values for simple types (string->bool, string->int, int->string)
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/typescript-angular.html b/docs/generators/typescript-angular.html
new file mode 100644
index 00000000000..6bc5717a6e6
--- /dev/null
+++ b/docs/generators/typescript-angular.html
@@ -0,0 +1,34 @@
+generators/typescript-angular · OpenAPI Generator
id: generator-opts-client-typescript-angular
+title: Config Options for typescript-angular
+sidebar_label: typescript-angular
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPropertyNaming
Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name
camelCase
+
supportsES6
Generate code that conforms to ES6.
false
+
npmName
The name under which you want to publish generated npm package. Required to generate a full angular package
null
+
npmVersion
The version of your npm package. Default is '1.0.0'
null
+
npmRepository
Use this property to set an url your private npmRepo in the package.json
null
+
snapshot
When setting this property to true the version will be suffixed with -SNAPSHOT.yyyyMMddHHmm
false
+
withInterfaces
Setting this property to true will generate interfaces next to the default class implementations.
false
+
taggedUnions
Use discriminators to create tagged unions instead of extending interfaces.
false
+
providedInRoot
Use this property to provide Injectables in root (it is only valid in angular version greater or equal to 6.0.0).
false
+
ngVersion
The version of Angular. Default is '4.3'
null
+
serviceSuffix
The suffix of the generated service. Default is 'Service'.
null
+
serviceFileSuffix
The suffix of the file of the generated service (service<suffix>.ts). Default is '.service'.
null
+
modelSuffix
The suffix of the generated model. Default is ''.
null
+
modelFileSuffix
The suffix of the file of the generated model (model<suffix>.ts). Default is ''.
null
+
fileNaming
Naming convention for the output files: 'camelCase', 'kebab-case'. Default is 'camelCase'.
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/typescript-angular/index.html b/docs/generators/typescript-angular/index.html
new file mode 100644
index 00000000000..6bc5717a6e6
--- /dev/null
+++ b/docs/generators/typescript-angular/index.html
@@ -0,0 +1,34 @@
+generators/typescript-angular · OpenAPI Generator
id: generator-opts-client-typescript-angular
+title: Config Options for typescript-angular
+sidebar_label: typescript-angular
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPropertyNaming
Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name
camelCase
+
supportsES6
Generate code that conforms to ES6.
false
+
npmName
The name under which you want to publish generated npm package. Required to generate a full angular package
null
+
npmVersion
The version of your npm package. Default is '1.0.0'
null
+
npmRepository
Use this property to set an url your private npmRepo in the package.json
null
+
snapshot
When setting this property to true the version will be suffixed with -SNAPSHOT.yyyyMMddHHmm
false
+
withInterfaces
Setting this property to true will generate interfaces next to the default class implementations.
false
+
taggedUnions
Use discriminators to create tagged unions instead of extending interfaces.
false
+
providedInRoot
Use this property to provide Injectables in root (it is only valid in angular version greater or equal to 6.0.0).
false
+
ngVersion
The version of Angular. Default is '4.3'
null
+
serviceSuffix
The suffix of the generated service. Default is 'Service'.
null
+
serviceFileSuffix
The suffix of the file of the generated service (service<suffix>.ts). Default is '.service'.
null
+
modelSuffix
The suffix of the generated model. Default is ''.
null
+
modelFileSuffix
The suffix of the file of the generated model (model<suffix>.ts). Default is ''.
null
+
fileNaming
Naming convention for the output files: 'camelCase', 'kebab-case'. Default is 'camelCase'.
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/typescript-angularjs.html b/docs/generators/typescript-angularjs.html
new file mode 100644
index 00000000000..d19e7b99d8d
--- /dev/null
+++ b/docs/generators/typescript-angularjs.html
@@ -0,0 +1,21 @@
+generators/typescript-angularjs · OpenAPI Generator
id: generator-opts-client-typescript-angularjs
+title: Config Options for typescript-angularjs
+sidebar_label: typescript-angularjs
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPropertyNaming
Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name
camelCase
+
supportsES6
Generate code that conforms to ES6.
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/typescript-angularjs/index.html b/docs/generators/typescript-angularjs/index.html
new file mode 100644
index 00000000000..d19e7b99d8d
--- /dev/null
+++ b/docs/generators/typescript-angularjs/index.html
@@ -0,0 +1,21 @@
+generators/typescript-angularjs · OpenAPI Generator
id: generator-opts-client-typescript-angularjs
+title: Config Options for typescript-angularjs
+sidebar_label: typescript-angularjs
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPropertyNaming
Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name
camelCase
+
supportsES6
Generate code that conforms to ES6.
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/typescript-aurelia.html b/docs/generators/typescript-aurelia.html
new file mode 100644
index 00000000000..90172a2143e
--- /dev/null
+++ b/docs/generators/typescript-aurelia.html
@@ -0,0 +1,23 @@
+generators/typescript-aurelia · OpenAPI Generator
id: generator-opts-client-typescript-aurelia
+title: Config Options for typescript-aurelia
+sidebar_label: typescript-aurelia
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPropertyNaming
Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name
camelCase
+
supportsES6
Generate code that conforms to ES6.
false
+
npmName
The name under which you want to publish generated npm package
null
+
npmVersion
The version of your npm package
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/typescript-aurelia/index.html b/docs/generators/typescript-aurelia/index.html
new file mode 100644
index 00000000000..90172a2143e
--- /dev/null
+++ b/docs/generators/typescript-aurelia/index.html
@@ -0,0 +1,23 @@
+generators/typescript-aurelia · OpenAPI Generator
id: generator-opts-client-typescript-aurelia
+title: Config Options for typescript-aurelia
+sidebar_label: typescript-aurelia
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPropertyNaming
Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name
camelCase
+
supportsES6
Generate code that conforms to ES6.
false
+
npmName
The name under which you want to publish generated npm package
null
+
npmVersion
The version of your npm package
null
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/typescript-axios.html b/docs/generators/typescript-axios.html
new file mode 100644
index 00000000000..9fd327ac7da
--- /dev/null
+++ b/docs/generators/typescript-axios.html
@@ -0,0 +1,26 @@
+generators/typescript-axios · OpenAPI Generator
id: generator-opts-client-typescript-axios
+title: Config Options for typescript-axios
+sidebar_label: typescript-axios
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPropertyNaming
Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name
camelCase
+
supportsES6
Generate code that conforms to ES6.
false
+
npmName
The name under which you want to publish generated npm package
null
+
npmVersion
The version of your npm package
null
+
npmRepository
Use this property to set an url your private npmRepo in the package.json
null
+
snapshot
When setting this property to true the version will be suffixed with -SNAPSHOT.yyyyMMddHHmm
false
+
withInterfaces
Setting this property to true will generate interfaces next to the default class implementations.
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/typescript-axios/index.html b/docs/generators/typescript-axios/index.html
new file mode 100644
index 00000000000..9fd327ac7da
--- /dev/null
+++ b/docs/generators/typescript-axios/index.html
@@ -0,0 +1,26 @@
+generators/typescript-axios · OpenAPI Generator
id: generator-opts-client-typescript-axios
+title: Config Options for typescript-axios
+sidebar_label: typescript-axios
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPropertyNaming
Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name
camelCase
+
supportsES6
Generate code that conforms to ES6.
false
+
npmName
The name under which you want to publish generated npm package
null
+
npmVersion
The version of your npm package
null
+
npmRepository
Use this property to set an url your private npmRepo in the package.json
null
+
snapshot
When setting this property to true the version will be suffixed with -SNAPSHOT.yyyyMMddHHmm
false
+
withInterfaces
Setting this property to true will generate interfaces next to the default class implementations.
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/typescript-fetch.html b/docs/generators/typescript-fetch.html
new file mode 100644
index 00000000000..670986e2b4c
--- /dev/null
+++ b/docs/generators/typescript-fetch.html
@@ -0,0 +1,26 @@
+generators/typescript-fetch · OpenAPI Generator
id: generator-opts-client-typescript-fetch
+title: Config Options for typescript-fetch
+sidebar_label: typescript-fetch
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPropertyNaming
Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name
camelCase
+
supportsES6
Generate code that conforms to ES6.
false
+
npmName
The name under which you want to publish generated npm package
null
+
npmVersion
The version of your npm package
null
+
npmRepository
Use this property to set an url your private npmRepo in the package.json
null
+
snapshot
When setting this property to true the version will be suffixed with -SNAPSHOT.yyyyMMddHHmm
false
+
withInterfaces
Setting this property to true will generate interfaces next to the default class implementations.
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/typescript-fetch/index.html b/docs/generators/typescript-fetch/index.html
new file mode 100644
index 00000000000..670986e2b4c
--- /dev/null
+++ b/docs/generators/typescript-fetch/index.html
@@ -0,0 +1,26 @@
+generators/typescript-fetch · OpenAPI Generator
id: generator-opts-client-typescript-fetch
+title: Config Options for typescript-fetch
+sidebar_label: typescript-fetch
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPropertyNaming
Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name
camelCase
+
supportsES6
Generate code that conforms to ES6.
false
+
npmName
The name under which you want to publish generated npm package
null
+
npmVersion
The version of your npm package
null
+
npmRepository
Use this property to set an url your private npmRepo in the package.json
null
+
snapshot
When setting this property to true the version will be suffixed with -SNAPSHOT.yyyyMMddHHmm
false
+
withInterfaces
Setting this property to true will generate interfaces next to the default class implementations.
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/typescript-inversify.html b/docs/generators/typescript-inversify.html
new file mode 100644
index 00000000000..f400d552d9b
--- /dev/null
+++ b/docs/generators/typescript-inversify.html
@@ -0,0 +1,28 @@
+generators/typescript-inversify · OpenAPI Generator
id: generator-opts-client-typescript-inversify
+title: Config Options for typescript-inversify
+sidebar_label: typescript-inversify
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPropertyNaming
Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name
camelCase
+
supportsES6
Generate code that conforms to ES6.
false
+
npmName
The name under which you want to publish generated npm package
null
+
npmVersion
The version of your npm package
null
+
npmRepository
Use this property to set an url your private npmRepo in the package.json
null
+
snapshot
When setting this property to true the version will be suffixed with -SNAPSHOT.yyyyMMddHHmm
false
+
withInterfaces
Setting this property to true will generate interfaces next to the default class implementations.
false
+
usePromise
Setting this property to use promise instead of observable inside every service.
false
+
taggedUnions
Use discriminators to create tagged unions instead of extending interfaces.
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/typescript-inversify/index.html b/docs/generators/typescript-inversify/index.html
new file mode 100644
index 00000000000..f400d552d9b
--- /dev/null
+++ b/docs/generators/typescript-inversify/index.html
@@ -0,0 +1,28 @@
+generators/typescript-inversify · OpenAPI Generator
id: generator-opts-client-typescript-inversify
+title: Config Options for typescript-inversify
+sidebar_label: typescript-inversify
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPropertyNaming
Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name
camelCase
+
supportsES6
Generate code that conforms to ES6.
false
+
npmName
The name under which you want to publish generated npm package
null
+
npmVersion
The version of your npm package
null
+
npmRepository
Use this property to set an url your private npmRepo in the package.json
null
+
snapshot
When setting this property to true the version will be suffixed with -SNAPSHOT.yyyyMMddHHmm
false
+
withInterfaces
Setting this property to true will generate interfaces next to the default class implementations.
false
+
usePromise
Setting this property to use promise instead of observable inside every service.
false
+
taggedUnions
Use discriminators to create tagged unions instead of extending interfaces.
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/typescript-jquery.html b/docs/generators/typescript-jquery.html
new file mode 100644
index 00000000000..25114fe4f3c
--- /dev/null
+++ b/docs/generators/typescript-jquery.html
@@ -0,0 +1,26 @@
+generators/typescript-jquery · OpenAPI Generator
id: generator-opts-client-typescript-jquery
+title: Config Options for typescript-jquery
+sidebar_label: typescript-jquery
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPropertyNaming
Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name
camelCase
+
supportsES6
Generate code that conforms to ES6.
false
+
npmName
The name under which you want to publish generated npm package
null
+
npmVersion
The version of your npm package
null
+
npmRepository
Use this property to set an url your private npmRepo in the package.json
null
+
snapshot
When setting this property to true the version will be suffixed with -SNAPSHOT.yyyyMMddHHmm
false
+
jqueryAlreadyImported
When using this in legacy app using mix of typescript and javascript, this will only declare jquery and not import it
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/typescript-jquery/index.html b/docs/generators/typescript-jquery/index.html
new file mode 100644
index 00000000000..25114fe4f3c
--- /dev/null
+++ b/docs/generators/typescript-jquery/index.html
@@ -0,0 +1,26 @@
+generators/typescript-jquery · OpenAPI Generator
id: generator-opts-client-typescript-jquery
+title: Config Options for typescript-jquery
+sidebar_label: typescript-jquery
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPropertyNaming
Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name
camelCase
+
supportsES6
Generate code that conforms to ES6.
false
+
npmName
The name under which you want to publish generated npm package
null
+
npmVersion
The version of your npm package
null
+
npmRepository
Use this property to set an url your private npmRepo in the package.json
null
+
snapshot
When setting this property to true the version will be suffixed with -SNAPSHOT.yyyyMMddHHmm
false
+
jqueryAlreadyImported
When using this in legacy app using mix of typescript and javascript, this will only declare jquery and not import it
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/typescript-node.html b/docs/generators/typescript-node.html
new file mode 100644
index 00000000000..939686d2b26
--- /dev/null
+++ b/docs/generators/typescript-node.html
@@ -0,0 +1,25 @@
+generators/typescript-node · OpenAPI Generator
id: generator-opts-client-typescript-node
+title: Config Options for typescript-node
+sidebar_label: typescript-node
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPropertyNaming
Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name
camelCase
+
supportsES6
Generate code that conforms to ES6.
false
+
npmName
The name under which you want to publish generated npm package
null
+
npmVersion
The version of your npm package
null
+
npmRepository
Use this property to set an url your private npmRepo in the package.json
null
+
snapshot
When setting this property to true the version will be suffixed with -SNAPSHOT.yyyyMMddHHmm
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/generators/typescript-node/index.html b/docs/generators/typescript-node/index.html
new file mode 100644
index 00000000000..939686d2b26
--- /dev/null
+++ b/docs/generators/typescript-node/index.html
@@ -0,0 +1,25 @@
+generators/typescript-node · OpenAPI Generator
id: generator-opts-client-typescript-node
+title: Config Options for typescript-node
+sidebar_label: typescript-node
+
+
+
+
Option
Description
Values
Default
+
+
+
sortParamsByRequiredFlag
Sort method arguments to place required parameters before optional parameters.
true
+
ensureUniqueParams
Whether to ensure parameter names are unique in an operation (rename parameters that are not).
true
+
allowUnicodeIdentifiers
boolean, toggles whether unicode identifiers are allowed in names or not, default is false
false
+
prependFormOrBodyParameters
Add form or body parameters to the beginning of the parameter list.
false
+
modelPropertyNaming
Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name
camelCase
+
supportsES6
Generate code that conforms to ES6.
false
+
npmName
The name under which you want to publish generated npm package
null
+
npmVersion
The version of your npm package
null
+
npmRepository
Use this property to set an url your private npmRepo in the package.json
null
+
snapshot
When setting this property to true the version will be suffixed with -SNAPSHOT.yyyyMMddHHmm
false
+
+
+
Last updated on 2019-1-18
\ No newline at end of file
diff --git a/docs/installation.html b/docs/installation.html
new file mode 100644
index 00000000000..1fa2d282886
--- /dev/null
+++ b/docs/installation.html
@@ -0,0 +1,129 @@
+CLI Installation · OpenAPI Generator
There are a number of ways to use OpenAPI Generator. This page documents how to install the CLI artifact.
+Installing OpenAPI Generator's CLI tool allows users to generate all available generators from the command line.
+
Some of the following are cross-platform options and some are not, these are called out where possible.
+
NPM
+
+
Platform(s): Linux, macOS, Windows
+
+
The NPM package wrapper is cross-platform wrapper around the .jar artifact. It works by providing a CLI wrapper atop the JAR's command line options. This gives a simple interface layer which normalizes usage of the command line across operating systems, removing some differences in how options or switches are passed to the tool (depending on OS).
+Install the latest version of the tool globally, exposing the CLI on the command line:
npx will execute a globally available openapi-generator, and if not found it will fall back to project-local commands. The result is that the above command will work regardless of which installation method you've chosen.
The OpenAPI Generator Docker image acts as a standalone executable. It can be used as an alternative to installing via homebrew, or for developers who are unable to install Java or upgrade the installed version.
+
To generate code from a valid petstore.yaml doc with this image, you'll need to mount a local location as a volume.
+You'll then need to output the generated code to this mapped volume. Everything else works the same as if you ran the command on your host machine.
After downloading the JAR, run java -jar openapi-generator-cli.jar help to show the usage.
+
For Mac users, please make sure Java 8 is installed (Tips: run java -version to check the version), and export JAVA_HOME in order to use the supported Java version:
One downside to manual JAR downloads is that you don't keep up-to-date with the latest released version. We have a Bash launcher script at bin/utils/openapi-generator.cli.sh which solves this problem.
+
To install the launcher script, copy the contents of the script to a location on your path and make the script executable.
+
An example of setting this up (NOTE: Always evaluate scripts curled from external systems before executing them).
Now, openapi-generator-cli is "installed". On invocation, it will query the GitHub repository for the most recently released version. If this matches the last downloaded jar,
+it will execute as normal. If a newer version is found, the script will download the latest release and execute it.
+
If you need to invoke an older version of the generator, you can define the variable OPENAPI_GENERATOR_VERSION either ad hoc or globally. You can export this variable if you'd like to persist a specific release version.
+
Examples:
+
# Execute latest released openapi-generator-cli
+openapi-generator-cli version
+
+# Execute version 3.1.0 for the current invocation, regardless of the latest released version
+OPENAPI_GENERATOR_VERSION=3.1.0 openapi-generator-cli version
+
+# Execute version 3.1.0-SNAPSHOT for the current invocation
+OPENAPI_GENERATOR_VERSION=3.1.0-SNAPSHOT openapi-generator-cli version
+
+# Execute version 3.0.2 for every invocation in the current shell session
+export OPENAPI_GENERATOR_VERSION=3.0.2
+openapi-generator-cli version # is 3.0.2
+openapi-generator-cli version # is also 3.0.2
+
+# To "install" a specific version, set the variable in .bashrc/.bash_profile
+echo"export OPENAPI_GENERATOR_VERSION=3.0.2" >> ~/.bashrc
+source ~/.bashrc
+openapi-generator-cli version # is always 3.0.2, unless any of the above overrides are done ad hoc
+
\ No newline at end of file
diff --git a/docs/installation/index.html b/docs/installation/index.html
new file mode 100644
index 00000000000..1fa2d282886
--- /dev/null
+++ b/docs/installation/index.html
@@ -0,0 +1,129 @@
+CLI Installation · OpenAPI Generator
There are a number of ways to use OpenAPI Generator. This page documents how to install the CLI artifact.
+Installing OpenAPI Generator's CLI tool allows users to generate all available generators from the command line.
+
Some of the following are cross-platform options and some are not, these are called out where possible.
+
NPM
+
+
Platform(s): Linux, macOS, Windows
+
+
The NPM package wrapper is cross-platform wrapper around the .jar artifact. It works by providing a CLI wrapper atop the JAR's command line options. This gives a simple interface layer which normalizes usage of the command line across operating systems, removing some differences in how options or switches are passed to the tool (depending on OS).
+Install the latest version of the tool globally, exposing the CLI on the command line:
npx will execute a globally available openapi-generator, and if not found it will fall back to project-local commands. The result is that the above command will work regardless of which installation method you've chosen.
The OpenAPI Generator Docker image acts as a standalone executable. It can be used as an alternative to installing via homebrew, or for developers who are unable to install Java or upgrade the installed version.
+
To generate code from a valid petstore.yaml doc with this image, you'll need to mount a local location as a volume.
+You'll then need to output the generated code to this mapped volume. Everything else works the same as if you ran the command on your host machine.
After downloading the JAR, run java -jar openapi-generator-cli.jar help to show the usage.
+
For Mac users, please make sure Java 8 is installed (Tips: run java -version to check the version), and export JAVA_HOME in order to use the supported Java version:
One downside to manual JAR downloads is that you don't keep up-to-date with the latest released version. We have a Bash launcher script at bin/utils/openapi-generator.cli.sh which solves this problem.
+
To install the launcher script, copy the contents of the script to a location on your path and make the script executable.
+
An example of setting this up (NOTE: Always evaluate scripts curled from external systems before executing them).
Now, openapi-generator-cli is "installed". On invocation, it will query the GitHub repository for the most recently released version. If this matches the last downloaded jar,
+it will execute as normal. If a newer version is found, the script will download the latest release and execute it.
+
If you need to invoke an older version of the generator, you can define the variable OPENAPI_GENERATOR_VERSION either ad hoc or globally. You can export this variable if you'd like to persist a specific release version.
+
Examples:
+
# Execute latest released openapi-generator-cli
+openapi-generator-cli version
+
+# Execute version 3.1.0 for the current invocation, regardless of the latest released version
+OPENAPI_GENERATOR_VERSION=3.1.0 openapi-generator-cli version
+
+# Execute version 3.1.0-SNAPSHOT for the current invocation
+OPENAPI_GENERATOR_VERSION=3.1.0-SNAPSHOT openapi-generator-cli version
+
+# Execute version 3.0.2 for every invocation in the current shell session
+export OPENAPI_GENERATOR_VERSION=3.0.2
+openapi-generator-cli version # is 3.0.2
+openapi-generator-cli version # is also 3.0.2
+
+# To "install" a specific version, set the variable in .bashrc/.bash_profile
+echo"export OPENAPI_GENERATOR_VERSION=3.0.2" >> ~/.bashrc
+source ~/.bashrc
+openapi-generator-cli version # is always 3.0.2, unless any of the above overrides are done ad hoc
+
\ No newline at end of file
diff --git a/docs/integrations.html b/docs/integrations.html
new file mode 100644
index 00000000000..341a60398eb
--- /dev/null
+++ b/docs/integrations.html
@@ -0,0 +1,64 @@
+Workflow Integrations · OpenAPI Generator
\ No newline at end of file
diff --git a/docs/integrations/index.html b/docs/integrations/index.html
new file mode 100644
index 00000000000..341a60398eb
--- /dev/null
+++ b/docs/integrations/index.html
@@ -0,0 +1,64 @@
+Workflow Integrations · OpenAPI Generator
\ No newline at end of file
diff --git a/docs/new-generator.html b/docs/new-generator.html
new file mode 100644
index 00000000000..88f64397c30
--- /dev/null
+++ b/docs/new-generator.html
@@ -0,0 +1,358 @@
+Create a New Generator · OpenAPI Generator
Creating a new generator which will become a part of the officially supported generators in OpenAPI Generator is pretty simple. We've created a helper script to bootstrap the operation. Let's look at the files necessary to create a new generator, then an example of bootstrapping a generator using the new.sh script in the root of the repository.
+
Required Files
+
The minimum set of files required to create a new generator are:
+
+
A "Codegen" file
+
+
exists under modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/
+
defines language options
+
defines framework options
+
determines OpenAPI feature set
+
extends the generation workflow
+
+
SPI registration
+
+
Above class must be referenced in modules/openapi-generator/src/main/resources/META-INF/services/org.openapitools.codegen.CodegenConfig
+
Tells the generator that this class exists
+
Allows for classpath extension (addition) of generators
+
+
A minimal template
+
+
Should include a README explaining usage
+
Must include an api.mustache
+
Exists under modules/openapi-generator/src/main/resources/ (plus embeddedTemplate dir value, see below)
+
+
Sample scripts under ./bin and ./bin/windows
+
+
Gives users a "real life" example of generated output
+
Samples are used by CI to verify generators and test for regressions in some cases
+
+
+
Now, let's generate an example generator and then walk through the pieces. At the end, we'll touch on some known sticking points for new generator authors and provide some suggestions.
+
new.sh
+
The new.sh script in the root of the project is meant to simplify this process. Run ./new.sh --help.
+
Stubs out files for new generators
+
+Usage:
+./new.sh [options]
+ Options:
+ -n Required. Specify generator name, should be kebab-cased.
+ -c Create a client generator
+ -s Create a server generator
+ -d Create a documentation generator
+ -t When specified, creates test file(s) for the generator.
+ -h Display help.
+
+Examples:
+ Create a server generator for ktor:
+ ./new.sh -n kotlin -s
+
+ Creates:
+ modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/KotlinServerCodegen.java
+ modules/openapi-generator/src/main/resources/kotlin-server/README.mustache
+ modules/openapi-generator/src/main/resources/kotlin-server/model.mustache
+ modules/openapi-generator/src/main/resources/kotlin-server/api.mustache
+ bin/windows/kotlin-server-petstore.bat
+ bin/kotlin-server-petstore.sh
+
+ Create a generic C# server generator:
+ ./new.sh -n csharp -s -t
+ Creates:
+ modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/CsharpServerCodegen.java
+ modules/openapi-generator/src/main/resources/csharp-server/README.mustache
+ modules/openapi-generator/src/main/resources/csharp-server/model.mustache
+ modules/openapi-generator/src/main/resources/csharp-server/api.mustache
+ bin/windows/csharp-server-petstore.bat
+ bin/csharp-server-petstore.sh
+ modules/openapi-generator/src/test/java/org/openapitools/codegen/csharp/CsharpServerCodegenTest.java
+ modules/openapi-generator/src/test/java/org/openapitools/codegen/csharp/CsharpServerCodegenModelTest.java
+ modules/openapi-generator/src/test/java/org/openapitools/codegen/csharp/CsharpServerCodegenOptionsTest.java
+ modules/openapi-generator/src/test/java/org/openapitools/codegen/options/CsharpServerCodegenOptionsProvider.java
+
+
This script allows us to define a client, server, schema, or documentation generator. We'll focus on the simplest generator (documentation). The other generator types may require heavy extension of the "Config" base class, and these docs could very quickly become outdated. When creating a new generator, please review existing generators as a guideline for implementation.
This is the default output location. This will be generated-code/markdown on non-Windows machines and generated-code\markdown on Windows. You may change this to any value you'd like, but a user will almost always provide an output directory.
The model.mustache file is registered as the template for model generation. The new.sh script doesn't have a way to know your intended file extension, so we default to a .zz extension. This must be changed (unless your generator's target extension is .zz). For this example, you'd change .zz to .md or .markdown, depending on your preference.
+
This model template registration will use model.mustache to generate a new file for every model defined in your API's specification document.
+
The path is considered relative to embeddedTemplateDir, templateDir, or a library subdirectory (refer to the Java client generator implementation for a prime example).
+
apiTemplateFiles.put("api.mustache", ".zz");
+
+
This is the template used for generating API related files. Similar to the above model template, you'll want to change .zz to .md or .markdown.
+
The path is considered relative to embeddedTemplateDir, templateDir, or a library subdirectory (refer to the Java client generator implementation for a prime example).
This line sets the embedded and template directories to markdown-documentation. The embeddedTemplateDir refers to the directory which will exist under modules/openapi-generator/src/main/resources and will be published with every release in which your new generator is present.
+
The templateDir variable refers to the "current" template directory setting, as defined by the user. That is, the user may invoke with -t or --template-directory (or plugin option variants), and override this directory.
+
Both of these variables exist because the generator will fallback to files under embeddedTemplateDir if they are not defined in the user's custom template directory.
+
apiPackage = File.separator + "Apis";
+
+
This sets the "package" location for anything considered an API document. You might want to change this setting if, for instance, your language doesn't support uppercase letters in the path. We don't need to worry about that here.
+
Every templated output from api.mustache (registered via apiTemplateFiles above) will end up in the directory defined by apiPackage here.
+
modelPackage = File.separator + "Models";
+
+
Similarly, this sets the packasge for Models.
+
Every templated output from model.mustache (registered via modelTemplateFiles above) will end up in the directory defined by modelPackage here.
A "supporting file" is an extra file which isn't created once for every operation or model defined in your specification document. It is a single file which may or may not be templated (determined by the extension of the filename).
+
A supporting file only passes through the Markdown template processor if the filename ends in .mustache.
+
The path is considered relative to embeddedTemplateDir, templateDir, or a library subdirectory (refer to the Java client generator implementation for a prime example).
+
+
If you want your readme to be generic (not templated), just rename the file to README.md and change README.mustache to README.md above.
+
+
Create templates
+
The new.sh created our three required files. Let's start filling out each of these files.
+
README.mustache
+
# Documentation for {{appName}}
+
+{{#generateApiDocs}}
+<aname="documentation-for-api-endpoints"></a>
+## Documentation for API Endpoints
+
+All URIs are relative to *{{{basePath}}}*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}*{{classname}}* | [**{{operationId}}**](Apis/{{apiDocPath}}{{classname}}.md#{{operationIdLowerCase}}) | **{{httpMethod}}** {{path}} | {{#summary}}{{{summary}}}{{/summary}}
+{{/operation}}{{/operations}}{{/apis}}{{/apiInfo}}
+{{/generateApiDocs}}
+
+{{#generateModelDocs}}
+<aname="documentation-for-models"></a>
+## Documentation for Models
+
+{{#modelPackage}}
+{{#models}}{{#model}} - [{{{modelPackage}}}.{{{classname}}}](Models/{{modelDocPath}}{{{classname}}}.md)
+{{/model}}{{/models}}
+{{/modelPackage}}
+{{^modelPackage}}
+No model defined in this package
+{{/modelPackage}}
+{{/generateModelDocs}}
+
+<aname="documentation-for-authorization"></a>{{! TODO: optional documentation for authorization? }}
+## Documentation for Authorization
+
+{{^authMethods}}
+All endpoints do not require authorization.
+{{/authMethods}}
+{{#authMethods}}
+{{#last}}
+Authentication schemes defined for the API:
+{{/last}}
+{{/authMethods}}
+{{#authMethods}}
+<aname="{{name}}"></a>
+### {{name}}
+
+{{#isApiKey}}- **Type**: API key
+- **API key parameter name**: {{keyParamName}}
+- **Location**: {{#isKeyInQuery}}URL query string{{/isKeyInQuery}}{{#isKeyInHeader}}HTTP header{{/isKeyInHeader}}
+{{/isApiKey}}
+{{#isBasic}}- **Type**: HTTP basic authentication
+{{/isBasic}}
+{{#isOAuth}}- **Type**: OAuth
+- **Flow**: {{flow}}
+- **Authorization URL**: {{authorizationUrl}}
+- **Scopes**: {{^scopes}}N/A{{/scopes}}
+{{#scopes}} - {{scope}}: {{description}}
+{{/scopes}}
+{{/isOAuth}}
+
+{{/authMethods}}
+
+
Let's not focus too much on the contents of this file. You may refer to templating for more details on the variables bound to these files and to debugging how to debug the structures. Of note here is that we're generating structures in markdown as defined by the objects constructed by our new "Config" class.
This script is often used to apply default options for generation. A common option in most of these script is to define the template directory as the generator's directory under resources. This allows template maintainers to modify and test out template changes which don't require recompilation of the entire project. You'd still need to recompile the project in full if you add or modify behaviors to the generator (such as adding a CliOption).
+
Add -t modules/openapi-generator/src/main/resources/markdown-documentation to ags line to simplify the evaluation of template-only modifications:
Creating a new generator will be an iterative task. Once you've generated the sample, you'll want to try it out. For compiled client/server outputs, this would mean running the code or creating a small sample project to consume your artifact just to make sure it works.
+
For markdown, you can open in Visual Studio Code or any other editor with a markdown preview. Not all editors support relative links to other markdown documents. To test the output in this guide, install markserv:
+
npm install --global markserv
+
+
Now, you can serve the output directory directly and test your links:
\ No newline at end of file
diff --git a/docs/new-generator/index.html b/docs/new-generator/index.html
new file mode 100644
index 00000000000..88f64397c30
--- /dev/null
+++ b/docs/new-generator/index.html
@@ -0,0 +1,358 @@
+Create a New Generator · OpenAPI Generator
Creating a new generator which will become a part of the officially supported generators in OpenAPI Generator is pretty simple. We've created a helper script to bootstrap the operation. Let's look at the files necessary to create a new generator, then an example of bootstrapping a generator using the new.sh script in the root of the repository.
+
Required Files
+
The minimum set of files required to create a new generator are:
+
+
A "Codegen" file
+
+
exists under modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/
+
defines language options
+
defines framework options
+
determines OpenAPI feature set
+
extends the generation workflow
+
+
SPI registration
+
+
Above class must be referenced in modules/openapi-generator/src/main/resources/META-INF/services/org.openapitools.codegen.CodegenConfig
+
Tells the generator that this class exists
+
Allows for classpath extension (addition) of generators
+
+
A minimal template
+
+
Should include a README explaining usage
+
Must include an api.mustache
+
Exists under modules/openapi-generator/src/main/resources/ (plus embeddedTemplate dir value, see below)
+
+
Sample scripts under ./bin and ./bin/windows
+
+
Gives users a "real life" example of generated output
+
Samples are used by CI to verify generators and test for regressions in some cases
+
+
+
Now, let's generate an example generator and then walk through the pieces. At the end, we'll touch on some known sticking points for new generator authors and provide some suggestions.
+
new.sh
+
The new.sh script in the root of the project is meant to simplify this process. Run ./new.sh --help.
+
Stubs out files for new generators
+
+Usage:
+./new.sh [options]
+ Options:
+ -n Required. Specify generator name, should be kebab-cased.
+ -c Create a client generator
+ -s Create a server generator
+ -d Create a documentation generator
+ -t When specified, creates test file(s) for the generator.
+ -h Display help.
+
+Examples:
+ Create a server generator for ktor:
+ ./new.sh -n kotlin -s
+
+ Creates:
+ modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/KotlinServerCodegen.java
+ modules/openapi-generator/src/main/resources/kotlin-server/README.mustache
+ modules/openapi-generator/src/main/resources/kotlin-server/model.mustache
+ modules/openapi-generator/src/main/resources/kotlin-server/api.mustache
+ bin/windows/kotlin-server-petstore.bat
+ bin/kotlin-server-petstore.sh
+
+ Create a generic C# server generator:
+ ./new.sh -n csharp -s -t
+ Creates:
+ modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/CsharpServerCodegen.java
+ modules/openapi-generator/src/main/resources/csharp-server/README.mustache
+ modules/openapi-generator/src/main/resources/csharp-server/model.mustache
+ modules/openapi-generator/src/main/resources/csharp-server/api.mustache
+ bin/windows/csharp-server-petstore.bat
+ bin/csharp-server-petstore.sh
+ modules/openapi-generator/src/test/java/org/openapitools/codegen/csharp/CsharpServerCodegenTest.java
+ modules/openapi-generator/src/test/java/org/openapitools/codegen/csharp/CsharpServerCodegenModelTest.java
+ modules/openapi-generator/src/test/java/org/openapitools/codegen/csharp/CsharpServerCodegenOptionsTest.java
+ modules/openapi-generator/src/test/java/org/openapitools/codegen/options/CsharpServerCodegenOptionsProvider.java
+
+
This script allows us to define a client, server, schema, or documentation generator. We'll focus on the simplest generator (documentation). The other generator types may require heavy extension of the "Config" base class, and these docs could very quickly become outdated. When creating a new generator, please review existing generators as a guideline for implementation.
This is the default output location. This will be generated-code/markdown on non-Windows machines and generated-code\markdown on Windows. You may change this to any value you'd like, but a user will almost always provide an output directory.
The model.mustache file is registered as the template for model generation. The new.sh script doesn't have a way to know your intended file extension, so we default to a .zz extension. This must be changed (unless your generator's target extension is .zz). For this example, you'd change .zz to .md or .markdown, depending on your preference.
+
This model template registration will use model.mustache to generate a new file for every model defined in your API's specification document.
+
The path is considered relative to embeddedTemplateDir, templateDir, or a library subdirectory (refer to the Java client generator implementation for a prime example).
+
apiTemplateFiles.put("api.mustache", ".zz");
+
+
This is the template used for generating API related files. Similar to the above model template, you'll want to change .zz to .md or .markdown.
+
The path is considered relative to embeddedTemplateDir, templateDir, or a library subdirectory (refer to the Java client generator implementation for a prime example).
This line sets the embedded and template directories to markdown-documentation. The embeddedTemplateDir refers to the directory which will exist under modules/openapi-generator/src/main/resources and will be published with every release in which your new generator is present.
+
The templateDir variable refers to the "current" template directory setting, as defined by the user. That is, the user may invoke with -t or --template-directory (or plugin option variants), and override this directory.
+
Both of these variables exist because the generator will fallback to files under embeddedTemplateDir if they are not defined in the user's custom template directory.
+
apiPackage = File.separator + "Apis";
+
+
This sets the "package" location for anything considered an API document. You might want to change this setting if, for instance, your language doesn't support uppercase letters in the path. We don't need to worry about that here.
+
Every templated output from api.mustache (registered via apiTemplateFiles above) will end up in the directory defined by apiPackage here.
+
modelPackage = File.separator + "Models";
+
+
Similarly, this sets the packasge for Models.
+
Every templated output from model.mustache (registered via modelTemplateFiles above) will end up in the directory defined by modelPackage here.
A "supporting file" is an extra file which isn't created once for every operation or model defined in your specification document. It is a single file which may or may not be templated (determined by the extension of the filename).
+
A supporting file only passes through the Markdown template processor if the filename ends in .mustache.
+
The path is considered relative to embeddedTemplateDir, templateDir, or a library subdirectory (refer to the Java client generator implementation for a prime example).
+
+
If you want your readme to be generic (not templated), just rename the file to README.md and change README.mustache to README.md above.
+
+
Create templates
+
The new.sh created our three required files. Let's start filling out each of these files.
+
README.mustache
+
# Documentation for {{appName}}
+
+{{#generateApiDocs}}
+<aname="documentation-for-api-endpoints"></a>
+## Documentation for API Endpoints
+
+All URIs are relative to *{{{basePath}}}*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}*{{classname}}* | [**{{operationId}}**](Apis/{{apiDocPath}}{{classname}}.md#{{operationIdLowerCase}}) | **{{httpMethod}}** {{path}} | {{#summary}}{{{summary}}}{{/summary}}
+{{/operation}}{{/operations}}{{/apis}}{{/apiInfo}}
+{{/generateApiDocs}}
+
+{{#generateModelDocs}}
+<aname="documentation-for-models"></a>
+## Documentation for Models
+
+{{#modelPackage}}
+{{#models}}{{#model}} - [{{{modelPackage}}}.{{{classname}}}](Models/{{modelDocPath}}{{{classname}}}.md)
+{{/model}}{{/models}}
+{{/modelPackage}}
+{{^modelPackage}}
+No model defined in this package
+{{/modelPackage}}
+{{/generateModelDocs}}
+
+<aname="documentation-for-authorization"></a>{{! TODO: optional documentation for authorization? }}
+## Documentation for Authorization
+
+{{^authMethods}}
+All endpoints do not require authorization.
+{{/authMethods}}
+{{#authMethods}}
+{{#last}}
+Authentication schemes defined for the API:
+{{/last}}
+{{/authMethods}}
+{{#authMethods}}
+<aname="{{name}}"></a>
+### {{name}}
+
+{{#isApiKey}}- **Type**: API key
+- **API key parameter name**: {{keyParamName}}
+- **Location**: {{#isKeyInQuery}}URL query string{{/isKeyInQuery}}{{#isKeyInHeader}}HTTP header{{/isKeyInHeader}}
+{{/isApiKey}}
+{{#isBasic}}- **Type**: HTTP basic authentication
+{{/isBasic}}
+{{#isOAuth}}- **Type**: OAuth
+- **Flow**: {{flow}}
+- **Authorization URL**: {{authorizationUrl}}
+- **Scopes**: {{^scopes}}N/A{{/scopes}}
+{{#scopes}} - {{scope}}: {{description}}
+{{/scopes}}
+{{/isOAuth}}
+
+{{/authMethods}}
+
+
Let's not focus too much on the contents of this file. You may refer to templating for more details on the variables bound to these files and to debugging how to debug the structures. Of note here is that we're generating structures in markdown as defined by the objects constructed by our new "Config" class.
This script is often used to apply default options for generation. A common option in most of these script is to define the template directory as the generator's directory under resources. This allows template maintainers to modify and test out template changes which don't require recompilation of the entire project. You'd still need to recompile the project in full if you add or modify behaviors to the generator (such as adding a CliOption).
+
Add -t modules/openapi-generator/src/main/resources/markdown-documentation to ags line to simplify the evaluation of template-only modifications:
Creating a new generator will be an iterative task. Once you've generated the sample, you'll want to try it out. For compiled client/server outputs, this would mean running the code or creating a small sample project to consume your artifact just to make sure it works.
+
For markdown, you can open in Visual Studio Code or any other editor with a markdown preview. Not all editors support relative links to other markdown documents. To test the output in this guide, install markserv:
+
npm install --global markserv
+
+
Now, you can serve the output directory directly and test your links:
\ No newline at end of file
diff --git a/docs/online.html b/docs/online.html
new file mode 100644
index 00000000000..2d7a6689e17
--- /dev/null
+++ b/docs/online.html
@@ -0,0 +1,143 @@
+Online · OpenAPI Generator
These services are beta and do not have any guarantee on service level
+
Docker Image
+
The openapi-generator-online Docker image can act as a self-hosted web application and API for generating code. This container can be incorporated into a CI pipeline, and requires at least two HTTP requests and some docker orchestration to access generated code.
+
Example usage:
+
# Start container at port 8888 and save the container id
+CID=$(docker run -d -p 8888:8080 \
+ -e GENERATOR_HOST=http://localhost:8888 \
+ openapitools/openapi-generator-online)
+
+# allow for startup
+sleep 10
+
+# Get the IP of the running container (optional)
+GEN_IP=$(docker inspect --format '{{.NetworkSettings.IPAddress}}'${CID})
+
+# Execute an HTTP request to generate a Ruby client
+curl -X POST --header 'Content-Type: application/json' \
+ --header 'Accept: application/json' \
+ -d '{"openAPIUrl": "https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/2_0/petstore.yaml"}' \
+ 'http://localhost:8888/api/gen/clients/ruby'
+
+# Example output:
+# {"code":"c2d483.3.4672-40e9-91df-b9ffd18d22b8","link":"http://localhost:8888/api/gen/download/c2d483.3.4672-40e9-91df-b9ffd18d22b8"}
+
+# Download the generated zip file (using "code" provided from your output)
+wget http://localhost:8888/api/gen/download/c2d483.3.4672-40e9-91df-b9ffd18d22b8
+
+# Unzip the file
+unzip c2d483.3.4672-40e9-91df-b9ffd18d22b8
+
+# Shutdown the openapi generator image
+docker stop ${CID} && docker rm ${CID}
+
+
Local/Self-hosting
+
If you prefer to run the service locally, here are the steps:
\ No newline at end of file
diff --git a/docs/online/index.html b/docs/online/index.html
new file mode 100644
index 00000000000..2d7a6689e17
--- /dev/null
+++ b/docs/online/index.html
@@ -0,0 +1,143 @@
+Online · OpenAPI Generator
These services are beta and do not have any guarantee on service level
+
Docker Image
+
The openapi-generator-online Docker image can act as a self-hosted web application and API for generating code. This container can be incorporated into a CI pipeline, and requires at least two HTTP requests and some docker orchestration to access generated code.
+
Example usage:
+
# Start container at port 8888 and save the container id
+CID=$(docker run -d -p 8888:8080 \
+ -e GENERATOR_HOST=http://localhost:8888 \
+ openapitools/openapi-generator-online)
+
+# allow for startup
+sleep 10
+
+# Get the IP of the running container (optional)
+GEN_IP=$(docker inspect --format '{{.NetworkSettings.IPAddress}}'${CID})
+
+# Execute an HTTP request to generate a Ruby client
+curl -X POST --header 'Content-Type: application/json' \
+ --header 'Accept: application/json' \
+ -d '{"openAPIUrl": "https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/2_0/petstore.yaml"}' \
+ 'http://localhost:8888/api/gen/clients/ruby'
+
+# Example output:
+# {"code":"c2d483.3.4672-40e9-91df-b9ffd18d22b8","link":"http://localhost:8888/api/gen/download/c2d483.3.4672-40e9-91df-b9ffd18d22b8"}
+
+# Download the generated zip file (using "code" provided from your output)
+wget http://localhost:8888/api/gen/download/c2d483.3.4672-40e9-91df-b9ffd18d22b8
+
+# Unzip the file
+unzip c2d483.3.4672-40e9-91df-b9ffd18d22b8
+
+# Shutdown the openapi generator image
+docker stop ${CID} && docker rm ${CID}
+
+
Local/Self-hosting
+
If you prefer to run the service locally, here are the steps:
\ No newline at end of file
diff --git a/docs/plugins.html b/docs/plugins.html
new file mode 100644
index 00000000000..eccaaa760f1
--- /dev/null
+++ b/docs/plugins.html
@@ -0,0 +1,108 @@
+Plugins · OpenAPI Generator
For full details of all options, see the plugin README.
+
Gradle
+
This gradle plugin offers a declarative DSL via extensions (these are Gradle project extensions). These map almost fully 1:1 with the options you’d pass to the CLI or Maven plugin. The plugin maps the extensions to a task of the same name to provide a clean API. If you’re interested in the extension/task mapping concept from a high-level, you can check out Gradle’s docs.
+
To include in your project, add the following to build.gradle:
Generate code via Open API Tools Generator for Open API 2.0 or 3.x specification documents.
+
openApiGenerators
Lists generators available via Open API Generators.
+
openApiMeta
Generates a new generator to be consumed via Open API Generator.
+
openApiValidate
Validates an Open API 2.0 or 3.x specification document.
+
+
+
+
The plugin implements the above tasks as project extensions of the same name. If you’d like to declare these tasks as dependencies to other tasks (using dependsOn), you’ll need a task reference. e.g.:
+
compileJava.dependsOn tasks.openApiGenerate
+
+
+
For full details of all options, see the plugin README.
\ No newline at end of file
diff --git a/docs/plugins/index.html b/docs/plugins/index.html
new file mode 100644
index 00000000000..eccaaa760f1
--- /dev/null
+++ b/docs/plugins/index.html
@@ -0,0 +1,108 @@
+Plugins · OpenAPI Generator
For full details of all options, see the plugin README.
+
Gradle
+
This gradle plugin offers a declarative DSL via extensions (these are Gradle project extensions). These map almost fully 1:1 with the options you’d pass to the CLI or Maven plugin. The plugin maps the extensions to a task of the same name to provide a clean API. If you’re interested in the extension/task mapping concept from a high-level, you can check out Gradle’s docs.
+
To include in your project, add the following to build.gradle:
Generate code via Open API Tools Generator for Open API 2.0 or 3.x specification documents.
+
openApiGenerators
Lists generators available via Open API Generators.
+
openApiMeta
Generates a new generator to be consumed via Open API Generator.
+
openApiValidate
Validates an Open API 2.0 or 3.x specification document.
+
+
+
+
The plugin implements the above tasks as project extensions of the same name. If you’d like to declare these tasks as dependencies to other tasks (using dependsOn), you’ll need a task reference. e.g.:
+
compileJava.dependsOn tasks.openApiGenerate
+
+
+
For full details of all options, see the plugin README.
\ No newline at end of file
diff --git a/docs/release-summary.html b/docs/release-summary.html
new file mode 100644
index 00000000000..e6ee799d911
--- /dev/null
+++ b/docs/release-summary.html
@@ -0,0 +1,47 @@
+Release Summary · OpenAPI Generator
\ No newline at end of file
diff --git a/docs/release-summary/index.html b/docs/release-summary/index.html
new file mode 100644
index 00000000000..e6ee799d911
--- /dev/null
+++ b/docs/release-summary/index.html
@@ -0,0 +1,47 @@
+Release Summary · OpenAPI Generator
\ No newline at end of file
diff --git a/docs/roadmap.html b/docs/roadmap.html
new file mode 100644
index 00000000000..01b799c8c95
--- /dev/null
+++ b/docs/roadmap.html
@@ -0,0 +1,119 @@
+Roadmap · OpenAPI Generator
This document lists short-term, medium-term, and long-term goals for the project.
+
+
NOTE
+
These are goals, not necessarily commitments. The sections are not intended to represent exclusive focus during these terms. For example, when you start at a college or university you may have a long-term goal to graduate and a short-term goal to find a job for supplemental income. We will similarly work toward many of our medium-term and long-term goals in the near future as we move toward meeting our short-term goals.
+
+
Short-term
+
+
Usability, stability, and marketing.
+
+
Short term are focused on improving contributor and user productivity (part of this is getting the word out).
+
+
CLI improvements
+
+
Search functionality (e.g. what generators support retrofit, what generators are available for kotlin)
+
+
Build automation improvements
+
Discuss consolidating current third-party build systems
+
Investigate custom docker containerization for prepared build environments
+
Automated release stability
+
General
+
OAS3.0 features support: anyOf, oneOf, callbacks, etc
+
Consider opt-in telemetry about generators being used, limited to a counter of invocations by generator name). This would allow us to make prioritization decisions based on statistics.
+
Code clean up
+
+
centralize build scripts
+
organize samples/bin scripts according to new generator names
Static pages, preferably on gh-pages, devoted to each generator
+
Explain generator options
+
Centralized docs on generated code usage/examples/configuration
+
+
Medium-term
+
+
Feature set, well-defined API (code and templates), and extensibility improvements.
+
+
API
+
+
Typed representation of the model bound to our templates. As it is, everything is treated an an Object, and this can lead to changes in the interface which might be unexpected from the template perspective.
+
Feature set (potential generators to add; not an exhaustive list)
+
Unit-testing templates (to previously mentioned explicit type as an interface to the template)
+
Reduce coupling
+
Make types extending CodegenConfig become the generation entrypoint
+
Allow current CodegenConfig types to define templating engine
+
Allow current CodegenConfig types to modify workflow (currently encapsulated in DefaultGenerator and tightly coupled to the template engine
+
Clearer reuse of "language" features, outside of "generator" types. That is, rather than enforcing polymorphic sharing of "language" which currently allows the super type to redefine framework-specific mapping functionality, generators could compose one or more language support types.
+
Define template deprecation/removal process
+
+
Long-term
+
+
Expanding tooling offered, integrations, potentially SaaS offering to partially fund efforts.
+
+
+
Generator UI wrappers
+
+
Move jimschubert/intellij-swagger-codegen plugin under the org, and rename
+
Look into an Eclipse UI wrapper around the generator
+
Look at Visual Studio Code (and/or Atom, sublime text) integration
+
+
Provide a native GUI for viewing/editing specs. Most tools are currently geared toward developers, but often times it may be non-technical business users who are interested in an API.
+
A paid service (SaaS) for generation may be enticing for some users. Such a service would allow for statistics (mentioned earlier in telemetry)
\ No newline at end of file
diff --git a/docs/roadmap/index.html b/docs/roadmap/index.html
new file mode 100644
index 00000000000..01b799c8c95
--- /dev/null
+++ b/docs/roadmap/index.html
@@ -0,0 +1,119 @@
+Roadmap · OpenAPI Generator
This document lists short-term, medium-term, and long-term goals for the project.
+
+
NOTE
+
These are goals, not necessarily commitments. The sections are not intended to represent exclusive focus during these terms. For example, when you start at a college or university you may have a long-term goal to graduate and a short-term goal to find a job for supplemental income. We will similarly work toward many of our medium-term and long-term goals in the near future as we move toward meeting our short-term goals.
+
+
Short-term
+
+
Usability, stability, and marketing.
+
+
Short term are focused on improving contributor and user productivity (part of this is getting the word out).
+
+
CLI improvements
+
+
Search functionality (e.g. what generators support retrofit, what generators are available for kotlin)
+
+
Build automation improvements
+
Discuss consolidating current third-party build systems
+
Investigate custom docker containerization for prepared build environments
+
Automated release stability
+
General
+
OAS3.0 features support: anyOf, oneOf, callbacks, etc
+
Consider opt-in telemetry about generators being used, limited to a counter of invocations by generator name). This would allow us to make prioritization decisions based on statistics.
+
Code clean up
+
+
centralize build scripts
+
organize samples/bin scripts according to new generator names
Static pages, preferably on gh-pages, devoted to each generator
+
Explain generator options
+
Centralized docs on generated code usage/examples/configuration
+
+
Medium-term
+
+
Feature set, well-defined API (code and templates), and extensibility improvements.
+
+
API
+
+
Typed representation of the model bound to our templates. As it is, everything is treated an an Object, and this can lead to changes in the interface which might be unexpected from the template perspective.
+
Feature set (potential generators to add; not an exhaustive list)
+
Unit-testing templates (to previously mentioned explicit type as an interface to the template)
+
Reduce coupling
+
Make types extending CodegenConfig become the generation entrypoint
+
Allow current CodegenConfig types to define templating engine
+
Allow current CodegenConfig types to modify workflow (currently encapsulated in DefaultGenerator and tightly coupled to the template engine
+
Clearer reuse of "language" features, outside of "generator" types. That is, rather than enforcing polymorphic sharing of "language" which currently allows the super type to redefine framework-specific mapping functionality, generators could compose one or more language support types.
+
Define template deprecation/removal process
+
+
Long-term
+
+
Expanding tooling offered, integrations, potentially SaaS offering to partially fund efforts.
+
+
+
Generator UI wrappers
+
+
Move jimschubert/intellij-swagger-codegen plugin under the org, and rename
+
Look into an Eclipse UI wrapper around the generator
+
Look at Visual Studio Code (and/or Atom, sublime text) integration
+
+
Provide a native GUI for viewing/editing specs. Most tools are currently geared toward developers, but often times it may be non-technical business users who are interested in an API.
+
A paid service (SaaS) for generation may be enticing for some users. Such a service would allow for statistics (mentioned earlier in telemetry)
\ No newline at end of file
diff --git a/docs/spec-info.html b/docs/spec-info.html
new file mode 100644
index 00000000000..f5df302b0f5
--- /dev/null
+++ b/docs/spec-info.html
@@ -0,0 +1,9 @@
+Spec Info · OpenAPI Generator
Tags basically group endpoints into the same API class file. For example, an endpoint with the store tag will be generated in the StoreApi class file in most generators.
\ No newline at end of file
diff --git a/docs/spec-info/index.html b/docs/spec-info/index.html
new file mode 100644
index 00000000000..f5df302b0f5
--- /dev/null
+++ b/docs/spec-info/index.html
@@ -0,0 +1,9 @@
+Spec Info · OpenAPI Generator
Tags basically group endpoints into the same API class file. For example, an endpoint with the store tag will be generated in the StoreApi class file in most generators.
\ No newline at end of file
diff --git a/docs/swagger-codegen-migration.html b/docs/swagger-codegen-migration.html
new file mode 100644
index 00000000000..3aa9cf1e4d9
--- /dev/null
+++ b/docs/swagger-codegen-migration.html
@@ -0,0 +1,212 @@
+Migrating from Swagger Codegen · OpenAPI Generator
OpenAPI Generator is a fork of swagger-codegen between version 2.3.1 and 2.4.0.
+This community-driven version called "OpenAPI Generator" provides similar functionalities and can be used as drop-in replacement.
+This guide explains the major differences in order to help you with the migration.
OpenAPI Generator 3.0.0 has introduced <generatorName> and deprecated <language>, because this refers to generator names which embed more than just "language".
+
If both options are present, you'll be presented with an error. If only <language> is provided, you'll be presented instructions for updating to the new config.
+
New generators names
+
When you run OpenAPI Generator, you need to select a target generator (-g option in the cli).
+All languages of swagger-codegen have been migrated to openapi-generator, but some names were changed, in order to be more consistent.
+
+
+
name in swagger-codegen
name in openapi-generator
+
+
+
akka-scala
scala-akka
+
scala
scala-httpclient
+
jaxrs
jaxrs-jersey
+
qt5cpp
cpp-qt5
+
cpprest
cpp-restsdk
+
tizen
cpp-tizen
+
sinatra
ruby-sinatra
+
swift
swift2-deprecated
+
lumen
php-lumen
+
slim
php-slim
+
ze-ph
php-ze-ph
+
nancyfx
csharp-nancyfx
+
+
+
We provide a temporary mapping in code for these old values. You'll receive a warning with instructions to migrate to the new names.
+
New parameters name
+
Some parameters were renamed.
+Often you need to replace "Swagger", with "OpenAPI".
+Some examples:
+
+
+
name in swagger-codegen
name in openapi-generator
+
+
+
debugSwagger
debugOpenAPI
+
GenerateSwaggerMetadata
GenerateOpenAPIMetadata
+
swagger.codegen.undertow.apipackage
openapi.codegen.undertow.apipackage
+
swagger.codegen.undertow.modelpackage
openapi.codegen.undertow.modelpackage
+
+
+
Renamed Mustache Template Variables
+
The template variable {{datatype}} was renamed to {{dataType}} for consistency reason.
+Corresponding java code: CodegenProperty.datatype is renamed to CodegenProperty.dataType.
+
(If you're not using customized templates with the -t option, you can ignore the mustache variable renaming above.)
+
Ignore file
+
.swagger-codegen-ignore is replaced by .openapi-generator-ignore.
+The syntax inside the file stays the same.
+
You don't need to rename the file manually, OpenAPI Generator will do it when your run it against an existing output directory.
+(When there is no .openapi-generator-ignore in a folder, if a .swagger-codegen-ignore file is present it will be considered and renamed to .openapi-generator-ignore).
+
Metadata folder
+
The metatata folder (to store the VERSION file for example) is now called .openapi-generator/ instead of .swagger-codegen/.
+
New default values for the generated code
+
If you use a generator without specifying each parameter, you might see some differences in the generated code.
+As example the default package name used in the generated code has changed.
+You need to have a look at the specific value, depending of your target language, but often Swagger îs replaced by OpenAPITools and io.swagger is replaced by org.openapitools.
+Concretely if you did not specify anything when you are generating java code, a file org/openapitools/api/PetApi.java might be generated instead of io/swagger/api/PetApi.java.
+
If this is a problem for you, you need to explicitly set the the parameter value in order to match with the swagger-codgen default value (apiPackage == io.swagger in the previous example with the java generator).
+
New fully qualified name for the classes
+
If you have extended some generators in your project, and you are looking for a specific class, replace the io.swagger.codegen package (old name) with org.openapitools.codegen package (new name).
In OpenAPI spec v3, there's no body parameter, which is replaced by Request Body Object. The parameter name for Request Body is named automatically based on the model name (e.g. User). To control how the "Request Body" parameter is named, please add the vendor extension x-codegen-request-body-name to the operation:
If your API client is using named parameters in the function call (e.g. Perl required & optional parameters, Ruby optional parameters), you will need to add x-codegen-request-body-name to the spec to restore the original body parameter name.
\ No newline at end of file
diff --git a/docs/swagger-codegen-migration/index.html b/docs/swagger-codegen-migration/index.html
new file mode 100644
index 00000000000..3aa9cf1e4d9
--- /dev/null
+++ b/docs/swagger-codegen-migration/index.html
@@ -0,0 +1,212 @@
+Migrating from Swagger Codegen · OpenAPI Generator
OpenAPI Generator is a fork of swagger-codegen between version 2.3.1 and 2.4.0.
+This community-driven version called "OpenAPI Generator" provides similar functionalities and can be used as drop-in replacement.
+This guide explains the major differences in order to help you with the migration.
OpenAPI Generator 3.0.0 has introduced <generatorName> and deprecated <language>, because this refers to generator names which embed more than just "language".
+
If both options are present, you'll be presented with an error. If only <language> is provided, you'll be presented instructions for updating to the new config.
+
New generators names
+
When you run OpenAPI Generator, you need to select a target generator (-g option in the cli).
+All languages of swagger-codegen have been migrated to openapi-generator, but some names were changed, in order to be more consistent.
+
+
+
name in swagger-codegen
name in openapi-generator
+
+
+
akka-scala
scala-akka
+
scala
scala-httpclient
+
jaxrs
jaxrs-jersey
+
qt5cpp
cpp-qt5
+
cpprest
cpp-restsdk
+
tizen
cpp-tizen
+
sinatra
ruby-sinatra
+
swift
swift2-deprecated
+
lumen
php-lumen
+
slim
php-slim
+
ze-ph
php-ze-ph
+
nancyfx
csharp-nancyfx
+
+
+
We provide a temporary mapping in code for these old values. You'll receive a warning with instructions to migrate to the new names.
+
New parameters name
+
Some parameters were renamed.
+Often you need to replace "Swagger", with "OpenAPI".
+Some examples:
+
+
+
name in swagger-codegen
name in openapi-generator
+
+
+
debugSwagger
debugOpenAPI
+
GenerateSwaggerMetadata
GenerateOpenAPIMetadata
+
swagger.codegen.undertow.apipackage
openapi.codegen.undertow.apipackage
+
swagger.codegen.undertow.modelpackage
openapi.codegen.undertow.modelpackage
+
+
+
Renamed Mustache Template Variables
+
The template variable {{datatype}} was renamed to {{dataType}} for consistency reason.
+Corresponding java code: CodegenProperty.datatype is renamed to CodegenProperty.dataType.
+
(If you're not using customized templates with the -t option, you can ignore the mustache variable renaming above.)
+
Ignore file
+
.swagger-codegen-ignore is replaced by .openapi-generator-ignore.
+The syntax inside the file stays the same.
+
You don't need to rename the file manually, OpenAPI Generator will do it when your run it against an existing output directory.
+(When there is no .openapi-generator-ignore in a folder, if a .swagger-codegen-ignore file is present it will be considered and renamed to .openapi-generator-ignore).
+
Metadata folder
+
The metatata folder (to store the VERSION file for example) is now called .openapi-generator/ instead of .swagger-codegen/.
+
New default values for the generated code
+
If you use a generator without specifying each parameter, you might see some differences in the generated code.
+As example the default package name used in the generated code has changed.
+You need to have a look at the specific value, depending of your target language, but often Swagger îs replaced by OpenAPITools and io.swagger is replaced by org.openapitools.
+Concretely if you did not specify anything when you are generating java code, a file org/openapitools/api/PetApi.java might be generated instead of io/swagger/api/PetApi.java.
+
If this is a problem for you, you need to explicitly set the the parameter value in order to match with the swagger-codgen default value (apiPackage == io.swagger in the previous example with the java generator).
+
New fully qualified name for the classes
+
If you have extended some generators in your project, and you are looking for a specific class, replace the io.swagger.codegen package (old name) with org.openapitools.codegen package (new name).
In OpenAPI spec v3, there's no body parameter, which is replaced by Request Body Object. The parameter name for Request Body is named automatically based on the model name (e.g. User). To control how the "Request Body" parameter is named, please add the vendor extension x-codegen-request-body-name to the operation:
If your API client is using named parameters in the function call (e.g. Perl required & optional parameters, Ruby optional parameters), you will need to add x-codegen-request-body-name to the spec to restore the original body parameter name.
\ No newline at end of file
diff --git a/docs/templating.html b/docs/templating.html
new file mode 100644
index 00000000000..7e2cb9695ef
--- /dev/null
+++ b/docs/templating.html
@@ -0,0 +1,653 @@
+Using Templates · OpenAPI Generator
The generator workflow has transforming logic as well as templates for each generation of code.
+
Each generator will create a data structure from the OpenAPI document; OpenAPI 2.0 and OpenAPI 3.x documents are normalized into the same API model within the generator. This model is then applied to the templates. While generators do not need to perform transformations, it's often necessary in order to add more advanced support for your language or framework. You may need to refer to the generator implementation to understand some of the logic while creating or customizing templates (see FinchServerCodegen.java for an advanced example).
+
The transform logic needs to implement CodegenConfig.java and is most easily done by extending DefaultCodegen.java. Take a look at the various implementations as a guideline while the instructions get more complete.
+
Modifying Templates
+
+
OpenAPI Generator applies user-defined templates via options:
+
+
CLI: -t/--template CLI options
+
Maven Plugin: templateDirectory
+
Gradle Plugin: templateDir
+
+
+
Built-in templates are written in Mustache and processed by jmustache. We plan to eventually support Handlebars and user-defined template engines via plugins.
+
OpenAPI Generator supports user-defined templates. This approach is often the easiest when creating a custom template. Our generators implement a combination of language and framework features, and it's fully possible to use an existing generator to implement a custom template for a different framework. Suppose you have internal utilities which you'd like to incorporate into generated code (e.g. logging, monitoring, fault-handling)... this is easy to add via custom templates.
+
+
Note: You cannot use this approach to create new templates, only override existing ones. If you'd like to create a new generator to contribute back to the project, see new.sh in the repository root. If you'd like to create a private generator for more templating control, see the customization docs.
+
+
Custom Logic
+
For this example, let's modify a Java client to use AOP via jcabi/jcabi-aspects. We'll log API method execution at the INFO level. The jcabi-aspects project could also be used to implement method retries on failures; this would be a great exercise to further play around with templating.
+
The Java generator supports a library option. This option works by defining base templates, then applying library-specific template overrides. This allows for template reuse for libraries sharing the same programming language. Templates defined as a library need only modify or extend the templates concerning the library, and generation falls back to the root templates (the "defaults") when not extended by the library. Generators which support the library option will only support the libraries known by the generator at compile time, and will throw a runtime error if you try to provide a custom library name.
+
To get started, we will need to copy our target generator's directory in full. The directory will be located under modules/opeanpi-generator/src/main/resources/{generator}. In general, the generator directory matches the generator name (what you would pass to the generator option), but this is not a requirement-- if you are having a hard time finding the template directory, look at the embeddedTemplateDir option in your target generator's implementation.
+
If you've already cloned openapi-generator, find and copy the modules/opeanpi-generator/src/main/resources/Java directory. If you have the Refined GitHub Chrome or Firefox Extension, you can navigate to this directory on GitHub and click the "Download" button. Or, to pull the directory from latest master:
Optional: Before modifying your templates, you may want to git init && git add . && git commit -am 'initial' so you can easily revert to the base templates.
+
At this point, you have every Java library's template locally. Let's delete all libraries except the resteasy library we'll be extending:
Execute tree in this Java directory and inspect the mustache files and directory structure. You'll notice there are quite a few templates in the directory root, but extending this root to support resteasy only requires modifying a handful of files:
NOTE: Some generators may be sensitive to which files exist. If you're concerned with redundant files like pom.mustache and build.sbt.mustache, you can try deleting them. If the generator you're customizing fails at runtime, just touch these files to create an empty file.
+
+
First, let's add our new dependency to libraries/resteasy/build.gradle.mustache:
Next, we'll find the code which generates API methods. You'll see {{#operations}}{{#operation}} which is a mustache "loop" which executes the template logic if the model applied to the template has an operations array, and a non-null operation instance in that array. You can pass -DdebugOpenAPI when generating via CLI to inspect the full object model.
+
Further down in api.mustache, find implementation of the method call, and add the @Loggable annotation. This template is easy because it has a single method implementation.
NOTE: This example includes log4j-slf4j-impl to demonstrate that our new code is working. Generally you'll want to leave logging implementations up to your consumers.
+
+
And because the java client generates with an outdated Gradle 2.6, let's update the gradle version in the default template (Java/gradle-wrapper.properties.mustache):
Now we're ready to generate the client with our simple changes. When we pass the template directory option to our toolset, we must pass the generator's root directory and not the library-only directory.
Execute ./gradlew build and then cat target/rolling/rollingtest.log. You should see messages logged for every call in PetApi with a stubbed unit test.
+
Congratulations! You've now modified one of the built-in templates to meet your client code's needs.
+
Adding/modifying template logic simply requires a little bit of mustache, for which you can use existing templates as a guide.
+
Structures
+
Aside from transforming an API document, the implementing class gets to decide how to apply the data structure to templates. We can decide which data structure to apply to which template files. You have the following structures at your disposal.
+
Examples for the following structures will be presented using the following spec document:
+
swagger:"2.0"
+ info:
+ version:"1.0.0"
+ title:"Swagger Petstore"
+ description:"A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification"
+ termsOfService:"http://swagger.io/terms/"
+ contact:
+ name:"Swagger API Team"
+ license:
+ name:"MIT"
+ host:"petstore.swagger.io"
+ basePath:"/api"
+ schemes:
+ -"http"
+ consumes:
+ -"application/json"
+ produces:
+ -"application/json"
+ paths:
+ /pets:
+ get:
+ description:"Returns all pets from the system that the user has access to"
+ produces:
+ -"application/json"
+ responses:
+ "200":
+ description:"A list of pets."
+ schema:
+ type:"array"
+ items:
+ $ref:"#/definitions/Pet"
+ definitions:
+ Pet:
+ type:"object"
+ required:
+ -"id"
+ -"name"
+ properties:
+ id:
+ type:"integer"
+ format:"int64"
+ name:
+ type:"string"
+ tag:
+ type:"string"
+
+
+
Operations
+
+
Inspect operation structures passed to templates with system property -DdebugOpenAPI
+
Example:
+
openapi-generator generate -g go \
+ -o out \
+ -i petstore-minimal.yaml \
+ -DdebugOpenAPI
+
+
+
There is a data structure which represents all the operations that are defined in the OpenAPI specification. A single API file is created for each OperationGroup, which is essentially a grouping of different operations. See the addOperationToGroup in DefaultCodegen.java for details on this operation.
+
You can have many files created for each OperationGroup by processing multiple templates and assigning a different file naming pattern to them. So for a single file per operation:
+
// process the `api.mustache` template and output a single file with suffix `.java`:
+apiTemplateFiles.put("api.mustache", ".java");
+
+
For C-like languages which also require header files, you may create two files per operation.
+
// create a header and implementation for each operation group:
+apiTemplateFiles.put("api-header.mustache", ".h");
+apiTemplateFiles.put("api-body.mustache", ".m");
+
+
Here, an Operation with tag Pet will generate two files: SWGPetApi.h and SWGPetApi.m. The SWG prefix and Api suffix are options specific to the Objective-C geneator.
+
Models
+
+
Inspect models passed to templates with system property -DdebugModels
+
Execute:
+
openapi-generator generate -g go \
+ -o out \
+ -i petstore-minimal.yaml \
+ -DdebugModels
+
+
+
Each model identified inside the generator will be passed into the Models data structure and will generate a new model file (or files) for each model.
+
A Pet model with three properties will provide a lot of information about the type and properties. The output from -DdebugModels is presented in truncated format here.
Templates are passed redundant properties, depending on the semantics of the array. For example:
+
+
vars lists all defined model properties
+
requiredVars lists all model properties marked with required in the spec document
+
optionalVars lists all model properties not marked with required in the spec document
+
readWriteVars lists all model properties not marked with readonly in the spec document
+
readOnlyVars lists all model properties marked with readonly in the spec document
+
allVars lists all model properties. This may include the same set as vars, but may also include generator-defined properties
+
+
We expose the same properties in multiple sets because this allows us to conditionally iterate over properties based on some condition ("is it required" or "is it readonly"). This is driven by the use of the logic-less Mustache templates. It is possible that models passed to the templating engine may be cleaned up as we support more template engines, but such an effort will go through a deprecation phase and would be communicated at runtime through log messages.
+
supportingFiles
+
+
Inspect supportingFiles passed to templates with system property -DdebugSupportingFiles
+
Execute:
+
openapi-generator generate -g go \
+ -o out \
+ -i petstore-minimal.yaml \
+ -DdebugSupportingFiles
+
+
+
This is a "catch-all" which gives you the entire structure--operations, model, etc--so you can create "single-file" code from them.
+
Supporting files can either be processed through the templating engine or copied as-is. When creating your own templates, you're limited to the files and extensions expected by the generator implementation. For more control over the supporting files produced by a generator, see our customization documentation.
+
Variables
+
+
This is a very limited list of variable name explanations. Feel free to open a pull request to add to this documentation!
+
+
+
complexType: stores the name of the model (e.g. Pet)
+
isContainer: true if the parameter or property is an array or a map.
+
isPrimitiveType: true if the parameter or property type is a primitive type (e.g. string, integer, etc) as defined in the spec.
+
+
Extensions
+
OpenAPI supports a concept called "Extensions". These are called "Specification Extensions" in 3.x and "Vendor Extensions" in 2.0.
+You'll see them referred to as "Vendor Extensions" in most places in this project.
+
Vendor extensions allow you to provide vendor-specific configurations to your specification document.
+
For example, suppose you use your specification document for code generation with a (hypothetical) C# OpenAPI generator supporting a desired operationId prefix where the extension is x-csharp-operationid, you can define this property alongside the object you'd like to extend (which would be a Path Object in this case). You could then apply additional extensions alongside this property, whether they're for another language or other tooling.
+
+
Well-defined vendor extensions don't cause conflicts with other tooling.
+
+
+
The following are vendor extensions supported by OpenAPI Generator. The list may not be up-to-date, the best way is to look for "x-" in the built-in mustache templates.
+
ObjC
+
x-objc-operationId
+
To customize the method name, you can provide a different name in x-objc-operationId, e.g.
MySQL schema generator creates vendor extensions based on openapi dataType and dataFormat. When user defined extensions with same key already exists codegen accepts those as is. It means it won't validate properties or correct it for you. Every model in definitions can contain table related and column related extensions like in example below:
There are properties that are not implemented by now(tblStorageEngine), but you can see how generator can be enhanced in future.
+
+
Mustache Tips
+
Here are a few tips we've found useful for new template authors.
+For more details on Mustache see mustache.5. See also samskivert/jmustache for implementation-specific details.
+
First/Last
+
To access the first or last element in a list using Mustache:
+
{{#vars}}{{#-first}} this is the first element {{.}} {{/-first}}{{/vars}}
+{{#vars}}{{#-last}} this is the last element {{.}} {{/-last}}{{/vars}}
+
+
This
+
Mustache evaluates template variables contextually. If the variable isn't found in the immediate object, mustache will search the parent. This is similar to JavaScript's prototype object (if you're familiar with the concept).
+
You can inspect this entire context by outputting {{this}}. For example:
+
{{#operations}}{{this}}{{/operations}}
+
+
Index
+
If you'd like a 1-based index in your array traversal, you can use {{-index}}:
\ No newline at end of file
diff --git a/docs/templating/index.html b/docs/templating/index.html
new file mode 100644
index 00000000000..7e2cb9695ef
--- /dev/null
+++ b/docs/templating/index.html
@@ -0,0 +1,653 @@
+Using Templates · OpenAPI Generator
The generator workflow has transforming logic as well as templates for each generation of code.
+
Each generator will create a data structure from the OpenAPI document; OpenAPI 2.0 and OpenAPI 3.x documents are normalized into the same API model within the generator. This model is then applied to the templates. While generators do not need to perform transformations, it's often necessary in order to add more advanced support for your language or framework. You may need to refer to the generator implementation to understand some of the logic while creating or customizing templates (see FinchServerCodegen.java for an advanced example).
+
The transform logic needs to implement CodegenConfig.java and is most easily done by extending DefaultCodegen.java. Take a look at the various implementations as a guideline while the instructions get more complete.
+
Modifying Templates
+
+
OpenAPI Generator applies user-defined templates via options:
+
+
CLI: -t/--template CLI options
+
Maven Plugin: templateDirectory
+
Gradle Plugin: templateDir
+
+
+
Built-in templates are written in Mustache and processed by jmustache. We plan to eventually support Handlebars and user-defined template engines via plugins.
+
OpenAPI Generator supports user-defined templates. This approach is often the easiest when creating a custom template. Our generators implement a combination of language and framework features, and it's fully possible to use an existing generator to implement a custom template for a different framework. Suppose you have internal utilities which you'd like to incorporate into generated code (e.g. logging, monitoring, fault-handling)... this is easy to add via custom templates.
+
+
Note: You cannot use this approach to create new templates, only override existing ones. If you'd like to create a new generator to contribute back to the project, see new.sh in the repository root. If you'd like to create a private generator for more templating control, see the customization docs.
+
+
Custom Logic
+
For this example, let's modify a Java client to use AOP via jcabi/jcabi-aspects. We'll log API method execution at the INFO level. The jcabi-aspects project could also be used to implement method retries on failures; this would be a great exercise to further play around with templating.
+
The Java generator supports a library option. This option works by defining base templates, then applying library-specific template overrides. This allows for template reuse for libraries sharing the same programming language. Templates defined as a library need only modify or extend the templates concerning the library, and generation falls back to the root templates (the "defaults") when not extended by the library. Generators which support the library option will only support the libraries known by the generator at compile time, and will throw a runtime error if you try to provide a custom library name.
+
To get started, we will need to copy our target generator's directory in full. The directory will be located under modules/opeanpi-generator/src/main/resources/{generator}. In general, the generator directory matches the generator name (what you would pass to the generator option), but this is not a requirement-- if you are having a hard time finding the template directory, look at the embeddedTemplateDir option in your target generator's implementation.
+
If you've already cloned openapi-generator, find and copy the modules/opeanpi-generator/src/main/resources/Java directory. If you have the Refined GitHub Chrome or Firefox Extension, you can navigate to this directory on GitHub and click the "Download" button. Or, to pull the directory from latest master:
Optional: Before modifying your templates, you may want to git init && git add . && git commit -am 'initial' so you can easily revert to the base templates.
+
At this point, you have every Java library's template locally. Let's delete all libraries except the resteasy library we'll be extending:
Execute tree in this Java directory and inspect the mustache files and directory structure. You'll notice there are quite a few templates in the directory root, but extending this root to support resteasy only requires modifying a handful of files:
NOTE: Some generators may be sensitive to which files exist. If you're concerned with redundant files like pom.mustache and build.sbt.mustache, you can try deleting them. If the generator you're customizing fails at runtime, just touch these files to create an empty file.
+
+
First, let's add our new dependency to libraries/resteasy/build.gradle.mustache:
Next, we'll find the code which generates API methods. You'll see {{#operations}}{{#operation}} which is a mustache "loop" which executes the template logic if the model applied to the template has an operations array, and a non-null operation instance in that array. You can pass -DdebugOpenAPI when generating via CLI to inspect the full object model.
+
Further down in api.mustache, find implementation of the method call, and add the @Loggable annotation. This template is easy because it has a single method implementation.
NOTE: This example includes log4j-slf4j-impl to demonstrate that our new code is working. Generally you'll want to leave logging implementations up to your consumers.
+
+
And because the java client generates with an outdated Gradle 2.6, let's update the gradle version in the default template (Java/gradle-wrapper.properties.mustache):
Now we're ready to generate the client with our simple changes. When we pass the template directory option to our toolset, we must pass the generator's root directory and not the library-only directory.
Execute ./gradlew build and then cat target/rolling/rollingtest.log. You should see messages logged for every call in PetApi with a stubbed unit test.
+
Congratulations! You've now modified one of the built-in templates to meet your client code's needs.
+
Adding/modifying template logic simply requires a little bit of mustache, for which you can use existing templates as a guide.
+
Structures
+
Aside from transforming an API document, the implementing class gets to decide how to apply the data structure to templates. We can decide which data structure to apply to which template files. You have the following structures at your disposal.
+
Examples for the following structures will be presented using the following spec document:
+
swagger:"2.0"
+ info:
+ version:"1.0.0"
+ title:"Swagger Petstore"
+ description:"A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification"
+ termsOfService:"http://swagger.io/terms/"
+ contact:
+ name:"Swagger API Team"
+ license:
+ name:"MIT"
+ host:"petstore.swagger.io"
+ basePath:"/api"
+ schemes:
+ -"http"
+ consumes:
+ -"application/json"
+ produces:
+ -"application/json"
+ paths:
+ /pets:
+ get:
+ description:"Returns all pets from the system that the user has access to"
+ produces:
+ -"application/json"
+ responses:
+ "200":
+ description:"A list of pets."
+ schema:
+ type:"array"
+ items:
+ $ref:"#/definitions/Pet"
+ definitions:
+ Pet:
+ type:"object"
+ required:
+ -"id"
+ -"name"
+ properties:
+ id:
+ type:"integer"
+ format:"int64"
+ name:
+ type:"string"
+ tag:
+ type:"string"
+
+
+
Operations
+
+
Inspect operation structures passed to templates with system property -DdebugOpenAPI
+
Example:
+
openapi-generator generate -g go \
+ -o out \
+ -i petstore-minimal.yaml \
+ -DdebugOpenAPI
+
+
+
There is a data structure which represents all the operations that are defined in the OpenAPI specification. A single API file is created for each OperationGroup, which is essentially a grouping of different operations. See the addOperationToGroup in DefaultCodegen.java for details on this operation.
+
You can have many files created for each OperationGroup by processing multiple templates and assigning a different file naming pattern to them. So for a single file per operation:
+
// process the `api.mustache` template and output a single file with suffix `.java`:
+apiTemplateFiles.put("api.mustache", ".java");
+
+
For C-like languages which also require header files, you may create two files per operation.
+
// create a header and implementation for each operation group:
+apiTemplateFiles.put("api-header.mustache", ".h");
+apiTemplateFiles.put("api-body.mustache", ".m");
+
+
Here, an Operation with tag Pet will generate two files: SWGPetApi.h and SWGPetApi.m. The SWG prefix and Api suffix are options specific to the Objective-C geneator.
+
Models
+
+
Inspect models passed to templates with system property -DdebugModels
+
Execute:
+
openapi-generator generate -g go \
+ -o out \
+ -i petstore-minimal.yaml \
+ -DdebugModels
+
+
+
Each model identified inside the generator will be passed into the Models data structure and will generate a new model file (or files) for each model.
+
A Pet model with three properties will provide a lot of information about the type and properties. The output from -DdebugModels is presented in truncated format here.
Templates are passed redundant properties, depending on the semantics of the array. For example:
+
+
vars lists all defined model properties
+
requiredVars lists all model properties marked with required in the spec document
+
optionalVars lists all model properties not marked with required in the spec document
+
readWriteVars lists all model properties not marked with readonly in the spec document
+
readOnlyVars lists all model properties marked with readonly in the spec document
+
allVars lists all model properties. This may include the same set as vars, but may also include generator-defined properties
+
+
We expose the same properties in multiple sets because this allows us to conditionally iterate over properties based on some condition ("is it required" or "is it readonly"). This is driven by the use of the logic-less Mustache templates. It is possible that models passed to the templating engine may be cleaned up as we support more template engines, but such an effort will go through a deprecation phase and would be communicated at runtime through log messages.
+
supportingFiles
+
+
Inspect supportingFiles passed to templates with system property -DdebugSupportingFiles
+
Execute:
+
openapi-generator generate -g go \
+ -o out \
+ -i petstore-minimal.yaml \
+ -DdebugSupportingFiles
+
+
+
This is a "catch-all" which gives you the entire structure--operations, model, etc--so you can create "single-file" code from them.
+
Supporting files can either be processed through the templating engine or copied as-is. When creating your own templates, you're limited to the files and extensions expected by the generator implementation. For more control over the supporting files produced by a generator, see our customization documentation.
+
Variables
+
+
This is a very limited list of variable name explanations. Feel free to open a pull request to add to this documentation!
+
+
+
complexType: stores the name of the model (e.g. Pet)
+
isContainer: true if the parameter or property is an array or a map.
+
isPrimitiveType: true if the parameter or property type is a primitive type (e.g. string, integer, etc) as defined in the spec.
+
+
Extensions
+
OpenAPI supports a concept called "Extensions". These are called "Specification Extensions" in 3.x and "Vendor Extensions" in 2.0.
+You'll see them referred to as "Vendor Extensions" in most places in this project.
+
Vendor extensions allow you to provide vendor-specific configurations to your specification document.
+
For example, suppose you use your specification document for code generation with a (hypothetical) C# OpenAPI generator supporting a desired operationId prefix where the extension is x-csharp-operationid, you can define this property alongside the object you'd like to extend (which would be a Path Object in this case). You could then apply additional extensions alongside this property, whether they're for another language or other tooling.
+
+
Well-defined vendor extensions don't cause conflicts with other tooling.
+
+
+
The following are vendor extensions supported by OpenAPI Generator. The list may not be up-to-date, the best way is to look for "x-" in the built-in mustache templates.
+
ObjC
+
x-objc-operationId
+
To customize the method name, you can provide a different name in x-objc-operationId, e.g.
MySQL schema generator creates vendor extensions based on openapi dataType and dataFormat. When user defined extensions with same key already exists codegen accepts those as is. It means it won't validate properties or correct it for you. Every model in definitions can contain table related and column related extensions like in example below:
There are properties that are not implemented by now(tblStorageEngine), but you can see how generator can be enhanced in future.
+
+
Mustache Tips
+
Here are a few tips we've found useful for new template authors.
+For more details on Mustache see mustache.5. See also samskivert/jmustache for implementation-specific details.
+
First/Last
+
To access the first or last element in a list using Mustache:
+
{{#vars}}{{#-first}} this is the first element {{.}} {{/-first}}{{/vars}}
+{{#vars}}{{#-last}} this is the last element {{.}} {{/-last}}{{/vars}}
+
+
This
+
Mustache evaluates template variables contextually. If the variable isn't found in the immediate object, mustache will search the parent. This is similar to JavaScript's prototype object (if you're familiar with the concept).
+
You can inspect this entire context by outputting {{this}}. For example:
+
{{#operations}}{{this}}{{/operations}}
+
+
Index
+
If you'd like a 1-based index in your array traversal, you can use {{-index}}:
\ No newline at end of file
diff --git a/docs/usage.html b/docs/usage.html
new file mode 100644
index 00000000000..50250594037
--- /dev/null
+++ b/docs/usage.html
@@ -0,0 +1,434 @@
+Usage · OpenAPI Generator
Options for OpenAPI Generator are the same whether you're using the CLI, Maven/Gradle Plugins, or Online generation options.
+This page demonstrates navigating the options via CLI. Commands are presented here in a logical progression as a tutorial, but you're welcome to skip directly to the generate command.
+
help
+
The help option lists all commands available to the CLI.
+
openapi-generator help
+usage: openapi-generator-cli <command> [<args>]
+
+The most commonly used openapi-generator-cli commands are:
+ config-help Config helpfor chosen lang
+ generate Generate code with the specified generator.
+ help Display help information
+ list Lists the available generators
+ meta MetaGenerator. Generator for creating a new template set and configuration for Codegen. The output will be based on the language you specify, and includes default templates to include.
+ validate Validate specification
+ version Show version information
+
+See 'openapi-generator-cli help <command>'for more information on a specific
+command.
+
+
+
list
+
The list command outputs a formatted list of every available generator. Pass the -s/--short option if you would like a CSV output for easy parsing.
+
openapi-generator help list
+NAME
+ openapi-generator-cli list - Lists the available generators
+
+SYNOPSIS
+ openapi-generator-cli list [(-s | --short)]
+
+OPTIONS
+ -s, --short
+ shortened output (suitable for scripting)
+
+
+
Example:
+
openapi-generator list -s | tr ',''\n'
+
+
For the full list of generators, refer to the Generators List.
+
config-help
+
The config-help option provides details about
+
openapi-generator help config-help
+NAME
+ openapi-generator-cli config-help - Config helpfor chosen lang
+
+SYNOPSIS
+ openapi-generator-cli config-help
+ [(-f <output format> | --format <output format>)]
+ [(-g <generator name> | --generator-name <generator name>)]
+ [--markdown-header] [--named-header]
+ [(-o <output location> | --output <output location>)]
+
+OPTIONS
+ -f <output format>, --format <output format>
+ Write output files in the desired format. Options are 'text' and
+ 'markdown'. Default is 'text'.
+
+ -g <generator name>, --generator-name <generator name>
+ generator to get config helpfor
+
+ --markdown-header
+ When format=markdown, include this option to write out markdown
+ headers (e.g. for docusaurus).
+
+ --named-header
+ Header includes the generator name, for clarity in output
+
+ -o <output location>, --output <output location>
+ Optionally write help to this location, otherwise default is
+ standard output
+
+
+
The option of note is -g/--generator-name (other options are exposed for tooling).
+
You may pass any generator name (see list command) to -g, and options specific to that generator will be displayed. Some generators have many options, while others may have only a few.
+
Example:
+
openapi-generator config-help -g go
+
+
Outputs:
+
CONFIG OPTIONS
+ 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)
+
+
To pass these go client generator-specific options to the generate command for a go client, use the --additional-properties option. See the generate command section for an example.
+
meta
+
The meta command creates a new Java class and template files, used for creating your own custom templates.
+
openapi-generator help meta
+NAME
+ openapi-generator-cli meta - MetaGenerator. Generator for creating a new
+ template set and configuration for Codegen. The output will be based on
+ the language you specify, and includes default templates to include.
+
+SYNOPSIS
+ openapi-generator-cli meta [(-n <name> | --name <name>)]
+ [(-o <output directory> | --output <output directory>)]
+ [(-p <package> | --package <package>)] [(-t <type> | --type <type>)]
+
+OPTIONS
+ -n <name>, --name <name>
+ the human-readable name of the generator
+
+ -o <output directory>, --output <output directory>
+ where to write the generated files (current dir by default)
+
+ -p <package>, --package <package>
+ the package to put the main class into (defaults to
+ org.openapitools.codegen)
+
+ -t <type>, --type <type>
+ the type of generator that is created
+
+
For an in-depth example of using the meta command, see Customization.
+
validate
+
The validate command allows you to validate an input specification, optionally providing recommendations for error fixes or other improvements (if available).
+
openapi-generator help validate
+NAME
+ openapi-generator-cli validate - Validate specification
+
+SYNOPSIS
+ openapi-generator-cli validate
+ (-i <spec file> | --input-spec <spec file>) [--recommend]
+
+OPTIONS
+ -i <spec file>, --input-spec <spec file>
+ location of the OpenAPI spec, as URL or file (required)
+
+ --recommend
+
+
The generate command is the workhorse of the generator toolset. As such, it has many more options and the previous commands. The options are abbreviated below, but you may expand the full descriptions.
OPTIONS
+ -a <authorization>, --auth <authorization>
+ adds authorization headers when fetching the OpenAPI definitions
+ remotely. Pass in a URL-encoded string of name:header with a comma
+ separating multiple values
+
+ --additional-properties <additional properties>
+ sets additional properties that can be referenced by the mustache
+ templates in the format of name=value,name=value. You can also have
+ multiple occurrences of this option.
+
+ --api-package <api package>
+ package for generated api classes
+
+ --artifact-id <artifact id>
+ artifactId in generated pom.xml
+
+ --artifact-version <artifact version>
+ artifact version in generated pom.xml
+
+ -c <configuration file>, --config <configuration file>
+ Path to json configuration file. File content should be in a json
+ format {"optionKey":"optionValue", "optionKey1":"optionValue1"...}
+ Supported options can be different for each language. Run
+ config-help -g {generator name} commandfor language specific config
+ options.
+
+ -D <system properties>
+ sets specified system properties in the format of
+ name=value,name=value (or multiple options, each with name=value)
+
+ --enable-post-process-file
+ enablePostProcessFile
+
+ -g <generator name>, --generator-name <generator name>
+ generator to use (see langs commandfor list)
+
+ --git-repo-id <git repo id>
+ Git repo ID, e.g. openapi-generator.
+
+ --git-user-id <git user id>
+ Git user ID, e.g. openapitools.
+
+ --group-id <group id>
+ groupId in generated pom.xml
+
+ --http-user-agent <http user agent>
+ HTTP user agent, e.g. codegen_csharp_api_client, default to
+ 'OpenAPI-Generator/{packageVersion}}/{language}'
+
+ -i <spec file>, --input-spec <spec file>
+ location of the OpenAPI spec, as URL or file (required)
+
+ --ignore-file-override <ignore file override location>
+ Specifies an override location for the .openapi-generator-ignore
+ file. Most useful on initial generation.
+
+ --import-mappings <import mappings>
+ specifies mappings between a given class and the import that should
+ be used for that class in the format of type=import,type=import. You
+ can also have multiple occurrences of this option.
+
+ --instantiation-types <instantiation types>
+ sets instantiation type mappings in the format of
+ type=instantiatedType,type=instantiatedType.For example (in Java):
+ array=ArrayList,map=HashMap. In other words array types will get
+ instantiated as ArrayList in generated code. You can also have
+ multiple occurrences of this option.
+
+ --invoker-package <invoker package>
+ root package for generated code
+
+ --language-specific-primitives <language specific primitives>
+ specifies additional language specific primitive types in the format
+ of type1,type2,type3,type3. For example:
+ String,boolean,Boolean,Double. You can also have multiple
+ occurrences of this option.
+
+ --library <library>
+ library template (sub-template)
+
+ --log-to-stderr
+ write all log messages (not just errors) to STDOUT. Useful for
+ piping the JSON output of debug options (e.g. `-DdebugOperations`)
+ to an external parser directly while testing a generator.
+
+ --model-name-prefix <model name prefix>
+ Prefix that will be prepended to all model names. Default is the
+ empty string.
+
+ --model-name-suffix <model name suffix>
+ Suffix that will be appended to all model names. Default is the
+ empty string.
+
+ --model-package <model package>
+ package for generated models
+
+ -o <output directory>, --output <output directory>
+ where to write the generated files (current dir by default)
+
+ --release-note <release note>
+ Release note, default to 'Minor update'.
+
+ --remove-operation-id-prefix
+ Remove prefix of operationId, e.g. config_getId => getId
+
+ --reserved-words-mappings <reserved word mappings>
+ specifies how a reserved name should be escaped to. Otherwise, the
+ default _<name> is used. For example id=identifier. You can also
+ have multiple occurrences of this option.
+
+ -s, --skip-overwrite
+ specifies if the existing files should be overwritten during the
+ generation.
+
+ --skip-validate-spec
+ Skips the default behavior of validating an input specification.
+
+ -t <template directory>, --template-dir <template directory>
+ folder containing the template files
+
+ --type-mappings <type mappings>
+ sets mappings between OpenAPI spec types and generated code types in
+ the format of OpenaAPIType=generatedType,OpenAPIType=generatedType.
+ For example: array=List,map=Map,string=String. You can also have
+ multiple occurrences of this option.
+
+ -v, --verbose
+ verbose mode
+
+
+
+
At a minimum, generate requires:
+
+
-g to specify the generator
+
-o to specify a meaningful output directory (defaults to the current directory!)
Generator-specific options should be passed as --additional-properties:
+
openapi-generator generate -g go --additional-properties=prependFormOrBodyParameters=true \
+ -o out -i petstore.yaml
+
+
To pass more than one generator property, these can be combined via comma:
+
--additional-properties=key1=value1,key2=value2
+
+
Type Mappings and Import Mappings
+
Most generators allow for types bound to the OpenAPI Specification's types to be remapped to a user's desired types. Not all type mappings can be reassigned, as some generators define mappings which are tightly coupled to the built-in templates.
+
If you're not using your own templates with star/glob package imports, you will most likely need to combine --type-mappings and --import-mappings together.
+
+
--type-mappings Defines the user's target type
+
--import-mappings Informs the template of the type to be imported
+
+
Here's how one might change the kotlin-spring server generator's default of OffsetDateTime to LocalDateTime:
NOTE: mappings are applied to DateTime, as this is the representation of the primitive type. See DefaultCodegen.
+
+
Target External Models
+
Sometimes you don't want the codegen to make a model for you--you might want to just include one that already exists in your codebase. Say you already have a User object and want to reuse that, which has a different model package from the other generated files:
+
First, indicate that the class is already included by default. This will keep the codegen from trying to generate the class.
+
--language-specific-primitives=Pet
+
+
This command line option will tell the generator to consider Pet a "primitive" type.
+
Next, if the Pet class is a different package, add an --import-mapping to tell the generator to include that import wherever Pet is used:
\ No newline at end of file
diff --git a/docs/usage/index.html b/docs/usage/index.html
new file mode 100644
index 00000000000..50250594037
--- /dev/null
+++ b/docs/usage/index.html
@@ -0,0 +1,434 @@
+Usage · OpenAPI Generator
Options for OpenAPI Generator are the same whether you're using the CLI, Maven/Gradle Plugins, or Online generation options.
+This page demonstrates navigating the options via CLI. Commands are presented here in a logical progression as a tutorial, but you're welcome to skip directly to the generate command.
+
help
+
The help option lists all commands available to the CLI.
+
openapi-generator help
+usage: openapi-generator-cli <command> [<args>]
+
+The most commonly used openapi-generator-cli commands are:
+ config-help Config helpfor chosen lang
+ generate Generate code with the specified generator.
+ help Display help information
+ list Lists the available generators
+ meta MetaGenerator. Generator for creating a new template set and configuration for Codegen. The output will be based on the language you specify, and includes default templates to include.
+ validate Validate specification
+ version Show version information
+
+See 'openapi-generator-cli help <command>'for more information on a specific
+command.
+
+
+
list
+
The list command outputs a formatted list of every available generator. Pass the -s/--short option if you would like a CSV output for easy parsing.
+
openapi-generator help list
+NAME
+ openapi-generator-cli list - Lists the available generators
+
+SYNOPSIS
+ openapi-generator-cli list [(-s | --short)]
+
+OPTIONS
+ -s, --short
+ shortened output (suitable for scripting)
+
+
+
Example:
+
openapi-generator list -s | tr ',''\n'
+
+
For the full list of generators, refer to the Generators List.
+
config-help
+
The config-help option provides details about
+
openapi-generator help config-help
+NAME
+ openapi-generator-cli config-help - Config helpfor chosen lang
+
+SYNOPSIS
+ openapi-generator-cli config-help
+ [(-f <output format> | --format <output format>)]
+ [(-g <generator name> | --generator-name <generator name>)]
+ [--markdown-header] [--named-header]
+ [(-o <output location> | --output <output location>)]
+
+OPTIONS
+ -f <output format>, --format <output format>
+ Write output files in the desired format. Options are 'text' and
+ 'markdown'. Default is 'text'.
+
+ -g <generator name>, --generator-name <generator name>
+ generator to get config helpfor
+
+ --markdown-header
+ When format=markdown, include this option to write out markdown
+ headers (e.g. for docusaurus).
+
+ --named-header
+ Header includes the generator name, for clarity in output
+
+ -o <output location>, --output <output location>
+ Optionally write help to this location, otherwise default is
+ standard output
+
+
+
The option of note is -g/--generator-name (other options are exposed for tooling).
+
You may pass any generator name (see list command) to -g, and options specific to that generator will be displayed. Some generators have many options, while others may have only a few.
+
Example:
+
openapi-generator config-help -g go
+
+
Outputs:
+
CONFIG OPTIONS
+ 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)
+
+
To pass these go client generator-specific options to the generate command for a go client, use the --additional-properties option. See the generate command section for an example.
+
meta
+
The meta command creates a new Java class and template files, used for creating your own custom templates.
+
openapi-generator help meta
+NAME
+ openapi-generator-cli meta - MetaGenerator. Generator for creating a new
+ template set and configuration for Codegen. The output will be based on
+ the language you specify, and includes default templates to include.
+
+SYNOPSIS
+ openapi-generator-cli meta [(-n <name> | --name <name>)]
+ [(-o <output directory> | --output <output directory>)]
+ [(-p <package> | --package <package>)] [(-t <type> | --type <type>)]
+
+OPTIONS
+ -n <name>, --name <name>
+ the human-readable name of the generator
+
+ -o <output directory>, --output <output directory>
+ where to write the generated files (current dir by default)
+
+ -p <package>, --package <package>
+ the package to put the main class into (defaults to
+ org.openapitools.codegen)
+
+ -t <type>, --type <type>
+ the type of generator that is created
+
+
For an in-depth example of using the meta command, see Customization.
+
validate
+
The validate command allows you to validate an input specification, optionally providing recommendations for error fixes or other improvements (if available).
+
openapi-generator help validate
+NAME
+ openapi-generator-cli validate - Validate specification
+
+SYNOPSIS
+ openapi-generator-cli validate
+ (-i <spec file> | --input-spec <spec file>) [--recommend]
+
+OPTIONS
+ -i <spec file>, --input-spec <spec file>
+ location of the OpenAPI spec, as URL or file (required)
+
+ --recommend
+
+
The generate command is the workhorse of the generator toolset. As such, it has many more options and the previous commands. The options are abbreviated below, but you may expand the full descriptions.
OPTIONS
+ -a <authorization>, --auth <authorization>
+ adds authorization headers when fetching the OpenAPI definitions
+ remotely. Pass in a URL-encoded string of name:header with a comma
+ separating multiple values
+
+ --additional-properties <additional properties>
+ sets additional properties that can be referenced by the mustache
+ templates in the format of name=value,name=value. You can also have
+ multiple occurrences of this option.
+
+ --api-package <api package>
+ package for generated api classes
+
+ --artifact-id <artifact id>
+ artifactId in generated pom.xml
+
+ --artifact-version <artifact version>
+ artifact version in generated pom.xml
+
+ -c <configuration file>, --config <configuration file>
+ Path to json configuration file. File content should be in a json
+ format {"optionKey":"optionValue", "optionKey1":"optionValue1"...}
+ Supported options can be different for each language. Run
+ config-help -g {generator name} commandfor language specific config
+ options.
+
+ -D <system properties>
+ sets specified system properties in the format of
+ name=value,name=value (or multiple options, each with name=value)
+
+ --enable-post-process-file
+ enablePostProcessFile
+
+ -g <generator name>, --generator-name <generator name>
+ generator to use (see langs commandfor list)
+
+ --git-repo-id <git repo id>
+ Git repo ID, e.g. openapi-generator.
+
+ --git-user-id <git user id>
+ Git user ID, e.g. openapitools.
+
+ --group-id <group id>
+ groupId in generated pom.xml
+
+ --http-user-agent <http user agent>
+ HTTP user agent, e.g. codegen_csharp_api_client, default to
+ 'OpenAPI-Generator/{packageVersion}}/{language}'
+
+ -i <spec file>, --input-spec <spec file>
+ location of the OpenAPI spec, as URL or file (required)
+
+ --ignore-file-override <ignore file override location>
+ Specifies an override location for the .openapi-generator-ignore
+ file. Most useful on initial generation.
+
+ --import-mappings <import mappings>
+ specifies mappings between a given class and the import that should
+ be used for that class in the format of type=import,type=import. You
+ can also have multiple occurrences of this option.
+
+ --instantiation-types <instantiation types>
+ sets instantiation type mappings in the format of
+ type=instantiatedType,type=instantiatedType.For example (in Java):
+ array=ArrayList,map=HashMap. In other words array types will get
+ instantiated as ArrayList in generated code. You can also have
+ multiple occurrences of this option.
+
+ --invoker-package <invoker package>
+ root package for generated code
+
+ --language-specific-primitives <language specific primitives>
+ specifies additional language specific primitive types in the format
+ of type1,type2,type3,type3. For example:
+ String,boolean,Boolean,Double. You can also have multiple
+ occurrences of this option.
+
+ --library <library>
+ library template (sub-template)
+
+ --log-to-stderr
+ write all log messages (not just errors) to STDOUT. Useful for
+ piping the JSON output of debug options (e.g. `-DdebugOperations`)
+ to an external parser directly while testing a generator.
+
+ --model-name-prefix <model name prefix>
+ Prefix that will be prepended to all model names. Default is the
+ empty string.
+
+ --model-name-suffix <model name suffix>
+ Suffix that will be appended to all model names. Default is the
+ empty string.
+
+ --model-package <model package>
+ package for generated models
+
+ -o <output directory>, --output <output directory>
+ where to write the generated files (current dir by default)
+
+ --release-note <release note>
+ Release note, default to 'Minor update'.
+
+ --remove-operation-id-prefix
+ Remove prefix of operationId, e.g. config_getId => getId
+
+ --reserved-words-mappings <reserved word mappings>
+ specifies how a reserved name should be escaped to. Otherwise, the
+ default _<name> is used. For example id=identifier. You can also
+ have multiple occurrences of this option.
+
+ -s, --skip-overwrite
+ specifies if the existing files should be overwritten during the
+ generation.
+
+ --skip-validate-spec
+ Skips the default behavior of validating an input specification.
+
+ -t <template directory>, --template-dir <template directory>
+ folder containing the template files
+
+ --type-mappings <type mappings>
+ sets mappings between OpenAPI spec types and generated code types in
+ the format of OpenaAPIType=generatedType,OpenAPIType=generatedType.
+ For example: array=List,map=Map,string=String. You can also have
+ multiple occurrences of this option.
+
+ -v, --verbose
+ verbose mode
+
+
+
+
At a minimum, generate requires:
+
+
-g to specify the generator
+
-o to specify a meaningful output directory (defaults to the current directory!)
Generator-specific options should be passed as --additional-properties:
+
openapi-generator generate -g go --additional-properties=prependFormOrBodyParameters=true \
+ -o out -i petstore.yaml
+
+
To pass more than one generator property, these can be combined via comma:
+
--additional-properties=key1=value1,key2=value2
+
+
Type Mappings and Import Mappings
+
Most generators allow for types bound to the OpenAPI Specification's types to be remapped to a user's desired types. Not all type mappings can be reassigned, as some generators define mappings which are tightly coupled to the built-in templates.
+
If you're not using your own templates with star/glob package imports, you will most likely need to combine --type-mappings and --import-mappings together.
+
+
--type-mappings Defines the user's target type
+
--import-mappings Informs the template of the type to be imported
+
+
Here's how one might change the kotlin-spring server generator's default of OffsetDateTime to LocalDateTime:
NOTE: mappings are applied to DateTime, as this is the representation of the primitive type. See DefaultCodegen.
+
+
Target External Models
+
Sometimes you don't want the codegen to make a model for you--you might want to just include one that already exists in your codebase. Say you already have a User object and want to reuse that, which has a different model package from the other generated files:
+
First, indicate that the class is already included by default. This will keep the codegen from trying to generate the class.
+
--language-specific-primitives=Pet
+
+
This command line option will tell the generator to consider Pet a "primitive" type.
+
Next, if the Pet class is a different package, add an --import-mapping to tell the generator to include that import wherever Pet is used:
\ No newline at end of file
diff --git a/en/help.html b/en/help.html
new file mode 100644
index 00000000000..37e9825caa4
--- /dev/null
+++ b/en/help.html
@@ -0,0 +1,7 @@
+OpenAPI Generator · Generate clients, servers, and documentation from OpenAPI 2.0/3.x documents
\ No newline at end of file
diff --git a/en/help/index.html b/en/help/index.html
new file mode 100644
index 00000000000..37e9825caa4
--- /dev/null
+++ b/en/help/index.html
@@ -0,0 +1,7 @@
+OpenAPI Generator · Generate clients, servers, and documentation from OpenAPI 2.0/3.x documents
\ No newline at end of file
diff --git a/en/index.html b/en/index.html
new file mode 100644
index 00000000000..0a0eebaf035
--- /dev/null
+++ b/en/index.html
@@ -0,0 +1,61 @@
+OpenAPI Generator · Generate clients, servers, and documentation from OpenAPI 2.0/3.x documents
Getting started with server development can be tough, especially if you're evaluating technologies. We can reduce the burden when you bring your own OpenAPI document.
+
Generate server stubs for 40+ different languages and technologies, including Java, Kotlin, Go, and PHP.
+
Some generators support Inversion of Control, allowing you to iterate on design via your OpenAPI document without worrying about blowing away your entire domain layer when you regenerate code.
+
Schemas/Configs
+
Ever wanted to iteratively design a MySQL database, but writing table declarations was too tedious?
+
OpenAPI Generator offers some special generators such as Apache2 Configuration, MySQL and GraphQL schema generators.
+
You can easily extend these generators and their templates to create derivative generators!
+
Documentation
+
OpenAPI documents allow you to convert the metadata about your API into some other format.
+
We include documentation formats such as HTML and Cwiki, which allow you to distribute static documentation to your consumers.
+
We also support generating from OpenAPI 2.0 to newer JSON/YAML OpenAPI 3.x documents.
+
Learn How
+
OpenAPI Generator supports many different integrations and use cases, including (but not limited to):
Generation also allows for easy customization via options, custom templates, or even custom generators on your classpath. See Customization for details.
+
As a very community-oriented project, the core team is also active on the project's Gitter channel.
+
Try via NPM
+
The NPM package wrapper is cross-platform wrapper around the .jar artifact.
+Install globally, exposing the CLI on the command line:
+
# install the latest version of "openapi-generator-cli"
+npm install @openapitools/openapi-generator-cli -g
+
+# install a specific version of "openapi-generator-cli"
+npm install @openapitools/openapi-generator-cli@cli-3.0.0 -g
+
+# Or install it as dev-dependency in your node.js projects
+npm install @openapitools/openapi-generator-cli -D
+
+
Then, generate a ruby client from a valid petstore.yaml doc:
The OpenAPI Generator image acts as a standalone executable. It can be used as an alternative to installing via homebrew, or for developers who are unable to install Java or upgrade the installed version.
+
To generate code from a valid petstore.yaml doc with this image, you'll need to mount a local location as a volume.
+
docker run --rm \
+-v ${PWD}:/local openapitools/openapi-generator-cli generate \
+-i petstore.yaml \
+-g go \
+-o /local/out/go
+
\ No newline at end of file
diff --git a/en/team.html b/en/team.html
new file mode 100644
index 00000000000..3ac3d87664a
--- /dev/null
+++ b/en/team.html
@@ -0,0 +1,2 @@
+OpenAPI Generator · Generate clients, servers, and documentation from OpenAPI 2.0/3.x documents
\ No newline at end of file
diff --git a/en/team/index.html b/en/team/index.html
new file mode 100644
index 00000000000..3ac3d87664a
--- /dev/null
+++ b/en/team/index.html
@@ -0,0 +1,2 @@
+OpenAPI Generator · Generate clients, servers, and documentation from OpenAPI 2.0/3.x documents
\ No newline at end of file
diff --git a/en/users.html b/en/users.html
new file mode 100644
index 00000000000..d8de96be217
--- /dev/null
+++ b/en/users.html
@@ -0,0 +1,2 @@
+OpenAPI Generator · Generate clients, servers, and documentation from OpenAPI 2.0/3.x documents
\ No newline at end of file
diff --git a/en/users/index.html b/en/users/index.html
new file mode 100644
index 00000000000..d8de96be217
--- /dev/null
+++ b/en/users/index.html
@@ -0,0 +1,2 @@
+OpenAPI Generator · Generate clients, servers, and documentation from OpenAPI 2.0/3.x documents
\ No newline at end of file
diff --git a/help.html b/help.html
new file mode 100644
index 00000000000..e477d1c4b4e
--- /dev/null
+++ b/help.html
@@ -0,0 +1,7 @@
+OpenAPI Generator · Generate clients, servers, and documentation from OpenAPI 2.0/3.x documents
\ No newline at end of file
diff --git a/help/index.html b/help/index.html
new file mode 100644
index 00000000000..e477d1c4b4e
--- /dev/null
+++ b/help/index.html
@@ -0,0 +1,7 @@
+OpenAPI Generator · Generate clients, servers, and documentation from OpenAPI 2.0/3.x documents