Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion bin/utils/export_generator.sh
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ fi

executable="./modules/openapi-generator-cli/target/openapi-generator-cli.jar"

java -jar ${executable} config-help -g ${NAME} --named-header --format markdown --markdown-header -o docs/generators/${NAME}.md
java -jar ${executable} config-help -g "${NAME}" --named-header --format markdown --markdown-header -o "docs/generators/${NAME}.md"
5 changes: 3 additions & 2 deletions docs/customization.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,10 @@ id: customization
title: Customization
---

## Creating a new template
<a id="creating-a-new-template"></a><!-- maintain old link ref name.-->
## Custom Generator (and Template)

If none of the templates suit your needs, you can create a brand new template. OpenAPI Generator can help with this, using the `meta` command:
If none of the built-in generators suit your needs and you need to do more than just modify the mustache templates to tweak generated code, you can create a brand new generator and its associated templates. OpenAPI Generator can help with this, using the `meta` command:

```sh
java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar meta \
Expand Down
240 changes: 120 additions & 120 deletions docs/generators.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,138 +6,138 @@ title: Generators List
The following generators are available:

## CLIENT generators
* [ada](generators/ada)
* [android](generators/android)
* [apex](generators/apex)
* [bash](generators/bash)
* [c](generators/c)
* [clojure](generators/clojure)
* [cpp-qt5-client](generators/cpp-qt5-client)
* [cpp-restsdk](generators/cpp-restsdk)
* [cpp-tizen](generators/cpp-tizen)
* [csharp](generators/csharp)
* [csharp-dotnet2 (deprecated)](generators/csharp-dotnet2)
* [csharp-netcore](generators/csharp-netcore)
* [dart](generators/dart)
* [dart-dio](generators/dart-dio)
* [dart-jaguar](generators/dart-jaguar)
* [eiffel](generators/eiffel)
* [elixir](generators/elixir)
* [elm](generators/elm)
* [erlang-client](generators/erlang-client)
* [erlang-proper](generators/erlang-proper)
* [flash](generators/flash)
* [go](generators/go)
* [go-experimental (experimental)](generators/go-experimental)
* [groovy](generators/groovy)
* [haskell-http-client](generators/haskell-http-client)
* [java](generators/java)
* [javascript](generators/javascript)
* [javascript-closure-angular](generators/javascript-closure-angular)
* [javascript-flowtyped](generators/javascript-flowtyped)
* [jaxrs-cxf-client](generators/jaxrs-cxf-client)
* [jmeter](generators/jmeter)
* [kotlin](generators/kotlin)
* [lua](generators/lua)
* [nim (beta)](generators/nim)
* [objc](generators/objc)
* [ocaml](generators/ocaml)
* [perl](generators/perl)
* [php](generators/php)
* [powershell](generators/powershell)
* [python](generators/python)
* [python-experimental (experimental)](generators/python-experimental)
* [r](generators/r)
* [ruby](generators/ruby)
* [rust](generators/rust)
* [scala-akka](generators/scala-akka)
* [scala-gatling](generators/scala-gatling)
* [scala-httpclient-deprecated (deprecated)](generators/scala-httpclient-deprecated)
* [scalaz](generators/scalaz)
* [swift2-deprecated (deprecated)](generators/swift2-deprecated)
* [swift3-deprecated (deprecated)](generators/swift3-deprecated)
* [swift4](generators/swift4)
* [typescript-angular](generators/typescript-angular)
* [typescript-angularjs](generators/typescript-angularjs)
* [typescript-aurelia](generators/typescript-aurelia)
* [typescript-axios](generators/typescript-axios)
* [typescript-fetch](generators/typescript-fetch)
* [typescript-inversify](generators/typescript-inversify)
* [typescript-jquery](generators/typescript-jquery)
* [typescript-node](generators/typescript-node)
* [typescript-rxjs](generators/typescript-rxjs)
* [ada](generators/ada.md)
* [android](generators/android.md)
* [apex](generators/apex.md)
* [bash](generators/bash.md)
* [c](generators/c.md)
* [clojure](generators/clojure.md)
* [cpp-qt5-client](generators/cpp-qt5-client.md)
* [cpp-restsdk](generators/cpp-restsdk.md)
* [cpp-tizen](generators/cpp-tizen.md)
* [csharp](generators/csharp.md)
* [csharp-dotnet2 (deprecated)](generators/csharp-dotnet2.md)
* [csharp-netcore](generators/csharp-netcore.md)
* [dart](generators/dart.md)
* [dart-dio](generators/dart-dio.md)
* [dart-jaguar](generators/dart-jaguar.md)
* [eiffel](generators/eiffel.md)
* [elixir](generators/elixir.md)
* [elm](generators/elm.md)
* [erlang-client](generators/erlang-client.md)
* [erlang-proper](generators/erlang-proper.md)
* [flash](generators/flash.md)
* [go](generators/go.md)
* [go-experimental (experimental)](generators/go-experimental.md)
* [groovy](generators/groovy.md)
* [haskell-http-client](generators/haskell-http-client.md)
* [java](generators/java.md)
* [javascript](generators/javascript.md)
* [javascript-closure-angular](generators/javascript-closure-angular.md)
* [javascript-flowtyped](generators/javascript-flowtyped.md)
* [jaxrs-cxf-client](generators/jaxrs-cxf-client.md)
* [jmeter](generators/jmeter.md)
* [kotlin](generators/kotlin.md)
* [lua](generators/lua.md)
* [nim (beta)](generators/nim.md)
* [objc](generators/objc.md)
* [ocaml](generators/ocaml.md)
* [perl](generators/perl.md)
* [php](generators/php.md)
* [powershell](generators/powershell.md)
* [python](generators/python.md)
* [python-experimental (experimental)](generators/python-experimental.md)
* [r](generators/r.md)
* [ruby](generators/ruby.md)
* [rust](generators/rust.md)
* [scala-akka](generators/scala-akka.md)
* [scala-gatling](generators/scala-gatling.md)
* [scala-httpclient-deprecated (deprecated)](generators/scala-httpclient-deprecated.md)
* [scalaz](generators/scalaz.md)
* [swift2-deprecated (deprecated)](generators/swift2-deprecated.md)
* [swift3-deprecated (deprecated)](generators/swift3-deprecated.md)
* [swift4](generators/swift4.md)
* [typescript-angular](generators/typescript-angular.md)
* [typescript-angularjs](generators/typescript-angularjs.md)
* [typescript-aurelia](generators/typescript-aurelia.md)
* [typescript-axios](generators/typescript-axios.md)
* [typescript-fetch](generators/typescript-fetch.md)
* [typescript-inversify](generators/typescript-inversify.md)
* [typescript-jquery](generators/typescript-jquery.md)
* [typescript-node](generators/typescript-node.md)
* [typescript-rxjs](generators/typescript-rxjs.md)


## SERVER generators
* [ada-server](generators/ada-server)
* [aspnetcore](generators/aspnetcore)
* [cpp-pistache-server](generators/cpp-pistache-server)
* [cpp-qt5-qhttpengine-server](generators/cpp-qt5-qhttpengine-server)
* [cpp-restbed-server](generators/cpp-restbed-server)
* [csharp-nancyfx](generators/csharp-nancyfx)
* [erlang-server](generators/erlang-server)
* [fsharp-functions (beta)](generators/fsharp-functions)
* [fsharp-giraffe-server (beta)](generators/fsharp-giraffe-server)
* [go-gin-server](generators/go-gin-server)
* [go-server](generators/go-server)
* [graphql-nodejs-express-server](generators/graphql-nodejs-express-server)
* [haskell](generators/haskell)
* [java-inflector](generators/java-inflector)
* [java-msf4j](generators/java-msf4j)
* [java-pkmst](generators/java-pkmst)
* [java-play-framework](generators/java-play-framework)
* [java-undertow-server](generators/java-undertow-server)
* [java-vertx](generators/java-vertx)
* [jaxrs-cxf](generators/jaxrs-cxf)
* [jaxrs-cxf-cdi](generators/jaxrs-cxf-cdi)
* [jaxrs-cxf-extended](generators/jaxrs-cxf-extended)
* [jaxrs-jersey](generators/jaxrs-jersey)
* [jaxrs-resteasy](generators/jaxrs-resteasy)
* [jaxrs-resteasy-eap](generators/jaxrs-resteasy-eap)
* [jaxrs-spec](generators/jaxrs-spec)
* [kotlin-server](generators/kotlin-server)
* [kotlin-spring](generators/kotlin-spring)
* [kotlin-vertx (beta)](generators/kotlin-vertx)
* [nodejs-express-server (beta)](generators/nodejs-express-server)
* [nodejs-server-deprecated (deprecated)](generators/nodejs-server-deprecated)
* [php-laravel](generators/php-laravel)
* [php-lumen](generators/php-lumen)
* [php-silex](generators/php-silex)
* [php-slim](generators/php-slim)
* [php-symfony](generators/php-symfony)
* [php-ze-ph](generators/php-ze-ph)
* [python-aiohttp](generators/python-aiohttp)
* [python-blueplanet](generators/python-blueplanet)
* [python-flask](generators/python-flask)
* [ruby-on-rails](generators/ruby-on-rails)
* [ruby-sinatra](generators/ruby-sinatra)
* [rust-server](generators/rust-server)
* [scala-finch](generators/scala-finch)
* [scala-lagom-server](generators/scala-lagom-server)
* [scala-play-server](generators/scala-play-server)
* [scalatra](generators/scalatra)
* [spring](generators/spring)
* [ada-server](generators/ada-server.md)
* [aspnetcore](generators/aspnetcore.md)
* [cpp-pistache-server](generators/cpp-pistache-server.md)
* [cpp-qt5-qhttpengine-server](generators/cpp-qt5-qhttpengine-server.md)
* [cpp-restbed-server](generators/cpp-restbed-server.md)
* [csharp-nancyfx](generators/csharp-nancyfx.md)
* [erlang-server](generators/erlang-server.md)
* [fsharp-functions (beta)](generators/fsharp-functions.md)
* [fsharp-giraffe-server (beta)](generators/fsharp-giraffe-server.md)
* [go-gin-server](generators/go-gin-server.md)
* [go-server](generators/go-server.md)
* [graphql-nodejs-express-server](generators/graphql-nodejs-express-server.md)
* [haskell](generators/haskell.md)
* [java-inflector](generators/java-inflector.md)
* [java-msf4j](generators/java-msf4j.md)
* [java-pkmst](generators/java-pkmst.md)
* [java-play-framework](generators/java-play-framework.md)
* [java-undertow-server](generators/java-undertow-server.md)
* [java-vertx](generators/java-vertx.md)
* [jaxrs-cxf](generators/jaxrs-cxf.md)
* [jaxrs-cxf-cdi](generators/jaxrs-cxf-cdi.md)
* [jaxrs-cxf-extended](generators/jaxrs-cxf-extended.md)
* [jaxrs-jersey](generators/jaxrs-jersey.md)
* [jaxrs-resteasy](generators/jaxrs-resteasy.md)
* [jaxrs-resteasy-eap](generators/jaxrs-resteasy-eap.md)
* [jaxrs-spec](generators/jaxrs-spec.md)
* [kotlin-server](generators/kotlin-server.md)
* [kotlin-spring](generators/kotlin-spring.md)
* [kotlin-vertx (beta)](generators/kotlin-vertx.md)
* [nodejs-express-server (beta)](generators/nodejs-express-server.md)
* [nodejs-server-deprecated (deprecated)](generators/nodejs-server-deprecated.md)
* [php-laravel](generators/php-laravel.md)
* [php-lumen](generators/php-lumen.md)
* [php-silex](generators/php-silex.md)
* [php-slim](generators/php-slim.md)
* [php-symfony](generators/php-symfony.md)
* [php-ze-ph](generators/php-ze-ph.md)
* [python-aiohttp](generators/python-aiohttp.md)
* [python-blueplanet](generators/python-blueplanet.md)
* [python-flask](generators/python-flask.md)
* [ruby-on-rails](generators/ruby-on-rails.md)
* [ruby-sinatra](generators/ruby-sinatra.md)
* [rust-server](generators/rust-server.md)
* [scala-finch](generators/scala-finch.md)
* [scala-lagom-server](generators/scala-lagom-server.md)
* [scala-play-server](generators/scala-play-server.md)
* [scalatra](generators/scalatra.md)
* [spring](generators/spring.md)


## DOCUMENTATION generators
* [asciidoc](generators/asciidoc)
* [cwiki](generators/cwiki)
* [dynamic-html](generators/dynamic-html)
* [html](generators/html)
* [html2](generators/html2)
* [openapi](generators/openapi)
* [openapi-yaml](generators/openapi-yaml)
* [asciidoc](generators/asciidoc.md)
* [cwiki](generators/cwiki.md)
* [dynamic-html](generators/dynamic-html.md)
* [html](generators/html.md)
* [html2](generators/html2.md)
* [openapi](generators/openapi.md)
* [openapi-yaml](generators/openapi-yaml.md)


## SCHEMA generators
* [avro-schema (beta)](generators/avro-schema)
* [mysql-schema](generators/mysql-schema)
* [avro-schema (beta)](generators/avro-schema.md)
* [mysql-schema](generators/mysql-schema.md)


## CONFIG generators
* [apache2](generators/apache2)
* [graphql-schema](generators/graphql-schema)
* [protobuf-schema (beta)](generators/protobuf-schema)
* [apache2](generators/apache2.md)
* [graphql-schema](generators/graphql-schema.md)
* [protobuf-schema (beta)](generators/protobuf-schema.md)



2 changes: 0 additions & 2 deletions docs/generators/ada-server.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@

---
id: generator-opts-server-ada-server
title: Config Options for ada-server
sidebar_label: ada-server
---
Expand Down
2 changes: 0 additions & 2 deletions docs/generators/ada.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@

---
id: generator-opts-client-ada
title: Config Options for ada
sidebar_label: ada
---
Expand Down
2 changes: 0 additions & 2 deletions docs/generators/android.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@

---
id: generator-opts-client-android
title: Config Options for android
sidebar_label: android
---
Expand Down
2 changes: 0 additions & 2 deletions docs/generators/apache2.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@

---
id: generator-opts-config-apache2
title: Config Options for apache2
sidebar_label: apache2
---
Expand Down
2 changes: 0 additions & 2 deletions docs/generators/apex.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@

---
id: generator-opts-client-apex
title: Config Options for apex
sidebar_label: apex
---
Expand Down
2 changes: 0 additions & 2 deletions docs/generators/asciidoc.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@

---
id: generator-opts-documentation-asciidoc
title: Config Options for asciidoc
sidebar_label: asciidoc
---
Expand Down
2 changes: 0 additions & 2 deletions docs/generators/aspnetcore.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@

---
id: generator-opts-server-aspnetcore
title: Config Options for aspnetcore
sidebar_label: aspnetcore
---
Expand Down
2 changes: 0 additions & 2 deletions docs/generators/avro-schema.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@

---
id: generator-opts-schema-avro-schema
title: Config Options for avro-schema
sidebar_label: avro-schema
---
Expand Down
2 changes: 0 additions & 2 deletions docs/generators/bash.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@

---
id: generator-opts-client-bash
title: Config Options for bash
sidebar_label: bash
---
Expand Down
2 changes: 0 additions & 2 deletions docs/generators/c.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@

---
id: generator-opts-client-c
title: Config Options for c
sidebar_label: c
---
Expand Down
2 changes: 0 additions & 2 deletions docs/generators/clojure.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@

---
id: generator-opts-client-clojure
title: Config Options for clojure
sidebar_label: clojure
---
Expand Down
2 changes: 0 additions & 2 deletions docs/generators/cpp-pistache-server.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@

---
id: generator-opts-server-cpp-pistache-server
title: Config Options for cpp-pistache-server
sidebar_label: cpp-pistache-server
---
Expand Down
2 changes: 0 additions & 2 deletions docs/generators/cpp-qt5-client.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@

---
id: generator-opts-client-cpp-qt5-client
title: Config Options for cpp-qt5-client
sidebar_label: cpp-qt5-client
---
Expand Down
2 changes: 0 additions & 2 deletions docs/generators/cpp-qt5-qhttpengine-server.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@

---
id: generator-opts-server-cpp-qt5-qhttpengine-server
title: Config Options for cpp-qt5-qhttpengine-server
sidebar_label: cpp-qt5-qhttpengine-server
---
Expand Down
2 changes: 0 additions & 2 deletions docs/generators/cpp-restbed-server.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@

---
id: generator-opts-server-cpp-restbed-server
title: Config Options for cpp-restbed-server
sidebar_label: cpp-restbed-server
---
Expand Down
2 changes: 0 additions & 2 deletions docs/generators/cpp-restsdk.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@

---
id: generator-opts-client-cpp-restsdk
title: Config Options for cpp-restsdk
sidebar_label: cpp-restsdk
---
Expand Down
2 changes: 0 additions & 2 deletions docs/generators/cpp-tizen.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@

---
id: generator-opts-client-cpp-tizen
title: Config Options for cpp-tizen
sidebar_label: cpp-tizen
---
Expand Down
Loading