2018-05-12 12:42:26 +00:00
< h1 align = "center" > OpenAPI Generator< / h1 >
2014-09-22 23:44:01 +00:00
2018-05-12 12:42:26 +00:00
< div align = "center" >
2019-09-11 13:17:11 +00:00
[Master ](https://github.com/OpenAPITools/openapi-generator/tree/master ) (`4.1.3-SNAPSHOT`): [![Build Status ](https://img.shields.io/travis/OpenAPITools/openapi-generator/master.svg?label=Integration%20Test )](https://travis-ci.org/OpenAPITools/openapi-generator)
2018-05-14 02:48:35 +00:00
[![Integration Test2 ](https://circleci.com/gh/OpenAPITools/openapi-generator.svg?style=shield )](https://circleci.com/gh/OpenAPITools/openapi-generator)
2018-06-06 06:06:00 +00:00
[![Run Status ](https://api.shippable.com/projects/5af6bf74e790f4070084a115/badge?branch=master )](https://app.shippable.com/github/OpenAPITools/openapi-generator)
2018-05-11 08:35:59 +00:00
[![Windows Test ](https://ci.appveyor.com/api/projects/status/github/openapitools/openapi-generator?branch=master&svg=true&passingText=Windows%20Test%20-%20OK&failingText=Windows%20Test%20-%20Fails )](https://ci.appveyor.com/project/WilliamCheng/openapi-generator-wh2wu)
2019-07-26 12:21:38 +00:00
[![JDK11 Build ](https://cloud.drone.io/api/badges/OpenAPITools/openapi-generator/status.svg?ref=refs/heads/master )](https://cloud.drone.io/OpenAPITools/openapi-generator)
2017-05-30 07:16:51 +00:00
2019-08-11 16:35:49 +00:00
[`4.2.x` ](https://github.com/OpenAPITools/openapi-generator/tree/4.2.x ) branch: [![Build Status ](https://img.shields.io/travis/OpenAPITools/openapi-generator/4.2.x.svg?label=Integration%20Test )](https://travis-ci.org/OpenAPITools/openapi-generator)
[![Integration Test2 ](https://circleci.com/gh/OpenAPITools/openapi-generator/tree/4.2.x.svg?style=shield )](https://circleci.com/gh/OpenAPITools/openapi-generator)
[![Run Status ](https://api.shippable.com/projects/5af6bf74e790f4070084a115/badge?branch=4.2.x )](https://app.shippable.com/github/OpenAPITools/openapi-generator)
[![Windows Test ](https://ci.appveyor.com/api/projects/status/github/openapitools/openapi-generator?branch=4.2.x&svg=true&passingText=Windows%20Test%20-%20OK&failingText=Windows%20Test%20-%20Fails )](https://ci.appveyor.com/project/WilliamCheng/openapi-generator-wh2wu)
[![JDK11 Build ](https://cloud.drone.io/api/badges/OpenAPITools/openapi-generator/status.svg?ref=refs/heads/4.2.x )](https://cloud.drone.io/OpenAPITools/openapi-generator)
2019-05-14 08:28:32 +00:00
[`5.0.x` ](https://github.com/OpenAPITools/openapi-generator/tree/5.0.x ) branch: [![Build Status ](https://img.shields.io/travis/OpenAPITools/openapi-generator/5.0.x.svg?label=Integration%20Test )](https://travis-ci.org/OpenAPITools/openapi-generator)
[![Integration Test2 ](https://circleci.com/gh/OpenAPITools/openapi-generator/tree/5.0.x.svg?style=shield )](https://circleci.com/gh/OpenAPITools/openapi-generator)
[![Run Status ](https://api.shippable.com/projects/5af6bf74e790f4070084a115/badge?branch=5.0.x )](https://app.shippable.com/github/OpenAPITools/openapi-generator)
[![Windows Test ](https://ci.appveyor.com/api/projects/status/github/openapitools/openapi-generator?branch=5.0.x&svg=true&passingText=Windows%20Test%20-%20OK&failingText=Windows%20Test%20-%20Fails )](https://ci.appveyor.com/project/WilliamCheng/openapi-generator-wh2wu)
2019-07-26 12:21:38 +00:00
[![JDK11 Build ](https://cloud.drone.io/api/badges/OpenAPITools/openapi-generator/status.svg?ref=refs/heads/5.0.x )](https://cloud.drone.io/OpenAPITools/openapi-generator)
2018-05-12 12:42:26 +00:00
< / div >
< div align = "center" >
2017-05-30 07:16:51 +00:00
2019-08-04 15:57:19 +00:00
[![Jion the Slack chat room ](https://img.shields.io/badge/Slack-Join%20the%20chat%20room-orange )](https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM)
2018-07-20 14:12:48 +00:00
[![Stable releaases in the Maven store ](https://img.shields.io/maven-metadata/v/http/central.maven.org/maven2/org/openapitools/openapi-generator/maven-metadata.xml.svg )](http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22org.openapitools%22%20AND%20a%3A%22openapi-generator%22)
[![Follow OpenAPI Generator Twitter account to get the latest update ](https://img.shields.io/twitter/follow/oas_generator.svg?style=social&label=Follow )](https://twitter.com/oas_generator)
2014-09-22 23:44:01 +00:00
2018-05-12 12:42:26 +00:00
< / div >
2018-05-12 12:58:23 +00:00
< div align = "center" >
2018-05-11 08:35:59 +00:00
:star::star::star: If you would like to contribute, please refer to [guidelines ](CONTRIBUTING.md ) and a list of [open tasks ](https://github.com/openapitools/openapi-generator/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22 ).:star::star::star:
2015-12-07 08:58:51 +00:00
2018-05-12 02:19:27 +00:00
:bangbang: To migrate from Swagger Codegen to OpenAPI Generator, please refer to the [migration guide ](docs/migration-from-swagger-codegen.md ) :bangbang:
2018-05-11 08:35:59 +00:00
:notebook_with_decorative_cover: For more information, please refer to the [Wiki page ](https://github.com/openapitools/openapi-generator/wiki ) and [FAQ ](https://github.com/openapitools/openapi-generator/wiki/FAQ ) :notebook_with_decorative_cover:
2016-04-13 07:57:02 +00:00
2019-04-29 15:05:30 +00:00
:notebook_with_decorative_cover: The eBook [A Beginner's Guide to Code Generation for REST APIs ](https://gum.co/openapi_generator_ebook ) is a good starting point for beginners :notebook_with_decorative_cover:
2018-05-12 12:58:23 +00:00
2018-12-15 08:23:48 +00:00
:warning: If the OpenAPI spec, templates or any input (e.g. options, environment variables) is obtained from an untrusted source or environment, please make sure you've reviewed these inputs before using OpenAPI Generator to generate the API client, server stub or documentation to avoid potential security issues (e.g. [code injection ](https://en.wikipedia.org/wiki/Code_injection )) :warning:
2017-03-03 13:48:57 +00:00
2018-06-21 15:36:39 +00:00
:bangbang: Both "OpenAPI Tools" (https://OpenAPITools.org - the parent organization of OpenAPI Generator) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI) :bangbang:
2018-05-12 12:58:23 +00:00
< / div >
2018-02-06 14:35:42 +00:00
2019-04-10 16:33:09 +00:00
## Sponsors
If you find OpenAPI Generator useful for work, please consider asking your company to support this Open Source project by [becoming a sponsor ](https://opencollective.com/openapi_generator ). You can also individually sponsor the project by [becoming a backer ](https://opencollective.com/openapi_generator ).
#### Thank you to our bronze sponsors!
[![NamSor ](https://openapi-generator.tech/img/companies/namsor.png )](https://www.namsor.com/?utm_source=openapi_generator& utm_medium=github_webpage& utm_campaign=sponsor)
2019-05-05 10:14:27 +00:00
[![LightBow ](https://openapi-generator.tech/img/companies/lightbow.png )](https://www.lightbow.net/?utm_source=openapi_generator& utm_medium=github_webpage& utm_campaign=sponsor)
2019-04-10 16:33:09 +00:00
2019-07-24 16:43:19 +00:00
#### Thank you GoDaddy for sponsoring the domain names and Linode for sponsoring the VPS
[<img src="https://openapi-generator.tech/img/companies/godaddy.png" width="150"> ](https://www.godaddy.com/?utm_source=openapi_generator&utm_medium=github_webpage&utm_campaign=sponsor )
[![Linode ](https://www.linode.com/media/images/logos/standard/light/linode-logo_standard_light_small.png )](https://www.linode.com/?utm_source=openapi_generator& utm_medium=github_webpage& utm_campaign=sponsor)
2014-09-22 23:44:01 +00:00
## Overview
2018-05-13 04:27:27 +00:00
OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an [OpenAPI Spec ](https://github.com/OAI/OpenAPI-Specification ) (both 2.0 and 3.0 are supported). Currently, the following languages/frameworks are supported:
2016-12-15 14:08:40 +00:00
2018-05-12 13:06:58 +00:00
| | Languages/Frameworks |
|-|-|
Add Nim client code generator (#3879)
* First version of Nim Client
* Add some codes
* Add some codes
* Add some codes
* Add some codes
* Add some codes
* First version of Nim Client
* Add some codes
* Add some codes
* [Dart] Fix README template and update testing doco (#3809)
* [Dart] Fix README template and update testing doco
- deleted redundant shell script
- fixed and updated README template
- updated test package and moved to a dev_dependency
- removed old unused dev_dependency packages
- updated testing documentation in petstore sample
* Remove references to dart-flutter-petstore.sh
* Fix typos
* Fix typo
* Support custom git repository (#3757)
* add gitHost param to GeneratorSettings and related
* parameterize gitHost in READMEs
* parameterize gitHost in go.mod
* parameterize gitHost in git_push
* update petstore samples
* run ./bin/utils/export_docs_generators.sh
* run meta-codehen.sh
* Revert "run meta-codehen.sh"
This reverts commit d6d579f6159186531257cdfdd73b9caf9e9ffeba.
* Revert "run ./bin/utils/export_docs_generators.sh"
This reverts commit 1b81538198d4319fd1b4e97447303e3cc0e8dc99.
* Revert "update petstore samples"
This reverts commit f513add88396707f6991ae2e4920359583ec88f1.
* run ensure-up-to-date
* Add links to article and video (#3820)
* Better Go code format (#3819)
* better varible naming
* better comments
* better code format for go experimental client
* better comment, update samples
* Add some codes
* Add some codes
* Add some codes
* Add gRPC Protobuf schema generator (#3818)
* add grpc protobuf generator
* update doc
* add new doc
* add windows batch, comment out root proto
* 1792 fix remote spec handling and hash calculation (#3440)
* fixed bug where nullApi.java would be generated. Instead, generated DefaultApi.java to match the default path /{pathParam} (#3821)
* Revert "1792 fix remote spec handling and hash calculation (#3440)"
This reverts commit 2a2eefe93d81b8d253745b8adb002ab2cb9eee04.
* Add nickmeinhold to Dart technical committee (#3830)
* Bug #2845 typescript angular inheritance (#3812)
* issue #2845: enable 'supportsMultipleInheritance' on typescript angular client codegen
- note I reran ./bin/openapi3/typescript-angular-petstore-all.sh and no changes occurred.
this suggests to me that the petstore.yaml sample should be improved to make use of the
anyOf / allOf / oneOf keywords, in order to better show the effects of changes on generated code.
* issue #2845: run ./bin/openapi3/typescript-angular-petstore-all.sh
* run `mvn clean package && ./bin/typescript-angular-petstore-all.sh`
* revert extranous files
* fix warnings in csharp-netcore client (#3831)
* Add missing files to the form request (#3834)
* [client][go] avoid duplicated reflect imports (#3847)
* Following up for #3440 (1792 fix remote spec handling and hash calculation) (#3826)
* This patch fixes the bug that we cannot access to remote files when checking file updates.
Following up #3440, supporting auth.
* 1792 fix remote spec handling and hash calculation (#3440)
(cherry picked from commit 2a2eefe93d81b8d253745b8adb002ab2cb9eee04)
* fix detecting remote file / local file logic while finding the hash file, taking care of IllegalArgumentException for local files.
* add testcase
* Add a link (#3850)
* Add Element AI to the list (#3856)
* maven-plugin-plugin 3.6.0 (#3854)
* [Java][okhttp-gson] fix failure to deserialize floats (#3846)
* fixed bug where nullApi.java would be generated. Instead, generated DefaultApi.java to match the default path /{pathParam}
* fix to bug #3157
* update samples
* Adds Http Info To Dart Api (#3851)
* [C++][Pistache] Add missing setter for arrays (#3837)
* [C++][Pistache] Add missing setter for arrays
Fixes #3769
* [C++][Pistache] Update Petstore sample
* typescript-inversify: improve check for required parameters, support multiple media types (#3849)
* [typescript-inversify] Allow falsy parameters
A required parameter to an api method must not be `null` or `undefined`.
It can be any other falsy value, e.g. `""`, `0` or `false` though. This
change makes sure an error is only thrown in the former case and not in
the latter.
* [typescript-inversify] Handle multiple media types
The Accept and Content-Type HTTP headers can contain a list of media
types. Previously all but the first media type in the api definition
were ignored. Now the headers are properly generated.
* [typescript-inversify] Fix http client interface
The api service methods allow the `body` parameter to be optional. The
parameter is then passed to an `IHttpClient`. So it needs to be optional
there as well.
Also fixed the sample implementation `HttpClient`.
Fixes #3618.
* [typescript-inversify] Regenerate Petstore sample
* [typescript-inversify] Use more explicit null check
This does not change the semantic of the generated code, but makes it more explicit.
Co-Authored-By: Esteban Gehring <esteban.gehring@gmail.com>
* [typescript-angular] allow empty string basePath (#3489)
* [typescript-angular] Fixing #2731 - empty string basePath
* typescript-angular: refactor base path configuration
* typescript-angular: refactor base path configuration
* Fix/r/serialization fix and minor 3xx resp fix (#3817)
* fix(qlik): fix for minor serialization bug
* fix(r): add petsore generated classes
* fix(r): indendation fixes
* typescript-axios: Fix baseoptions (#3866)
* Fixed missing baseOptions of typescript-axios.
The typescript-axios template was missing the baseOptions setting when building an API Configuration. Set it.
* update sample.
* re-generate typescript axios samples
* Rename gRPC generator to "protobuf-schema" (#3864)
* rename grpc generator to protobuf-schema
* update doc
* Prepare v4.1.2 release (#3873)
* update samples
* update date
* fix version in readme
* BugFix #2053 Spring Boot fails to parse LocalDate query parameter (#3860)
Adds the format annotation so that Spring is able to serialize OpenApi date/date-time format into LocalDate/OffsetDateTime.
* update doc, samples (#3875)
* update stable release
* Update the batch for Windows
* Add a test snippet
* Update ensure-up-to-date
* Add Nim to README.md
* Ran ensure-up-to-date to pass CircleCI tests
2019-09-13 07:56:54 +00:00
**API clients** | **ActionScript** , **Ada** , **Apex** , **Bash** , **C** , **C#** (.net 2.0, 3.5 or later, .NET Standard 1.3 - 2.0, .NET Core 2.0), **C++** (cpp-restsdk, Qt5, Tizen), **Clojure** , **Dart (1.x, 2.x)** , **Elixir** , **Elm** , **Eiffel** , **Erlang** , **Go** , **Groovy** , **Haskell** (http-client, Servant), **Java** (Jersey1.x, Jersey2.x, OkHttp, Retrofit1.x, Retrofit2.x, Feign, RestTemplate, RESTEasy, Vertx, Google API Client Library for Java, Rest-assured, Spring 5 Web Client), **Kotlin** , **Lua** , **Nim** , **Node.js/JavaScript** (ES5, ES6, AngularJS with Google Closure Compiler annotations, Flow types), **Objective-C** , **OCaml** , **Perl** , **PHP** , **PowerShell** , **Python** , **R** , **Ruby** , **Rust** (rust, rust-server), **Scala** (akka, http4s, scalaz, swagger-async-httpclient), **Swift** (2.x, 3.x, 4.x), **Typescript** (AngularJS, Angular (2.x - 8.x), Aurelia, Axios, Fetch, Inversify, jQuery, Node, Rxjs)
2019-09-16 14:47:28 +00:00
**Server stubs** | **Ada** , **C#** (ASP.NET Core, NancyFx), **C++** (Pistache, Restbed, Qt5 QHTTPEngine), **Erlang** , **F#** (Giraffe), **Go** (net/http, Gin), **Haskell** (Servant), **Java** (MSF4J, Spring, Undertow, JAX-RS: CDI, CXF, Inflector, Jersey, RestEasy, Play Framework, [PKMST ](https://github.com/ProKarma-Inc/pkmst-getting-started-examples )), **Kotlin** (Spring Boot, Ktor, Vertx), **PHP** (Laravel, Lumen, Slim, Silex, [Symfony ](https://symfony.com/ ), [Zend Expressive ](https://github.com/zendframework/zend-expressive )), **Python** (Flask), **NodeJS** , **Ruby** (Sinatra, Rails5), **Rust** (rust-server), **Scala** ([Finch](https://github.com/finagle/finch), [Lagom ](https://github.com/lagom/lagom ), [Play ](https://www.playframework.com/ ), Scalatra)
2019-09-14 10:39:58 +00:00
**API documentation generators** | **HTML** , **Confluence Wiki** , **Asciidoc**
2018-05-12 13:06:58 +00:00
**Configuration files** | [**Apache2** ](https://httpd.apache.org/ )
2019-09-10 09:32:25 +00:00
**Others** | **GraphQL** , **JMeter** , **MySQL Schema** , **Protocol Buffer**
2014-09-22 23:44:01 +00:00
2018-05-12 13:41:09 +00:00
## Table of contents
2015-10-01 21:14:34 +00:00
2018-04-22 13:34:55 +00:00
- [OpenAPI Generator ](#openapi-generator )
2015-10-01 21:14:34 +00:00
- [Overview ](#overview )
- [Table of Contents ](#table-of-contents )
2018-05-12 13:47:57 +00:00
- [1 - Installation ](#1---installation )
- [1.1 - Compatibility ](#11---compatibility )
2018-06-05 14:24:55 +00:00
- [1.2 - Artifacts on Maven Central ](#12---artifacts-on-maven-central )
- [1.3 - Download JAR ](#13---download-jar )
- [1.4 - Build Projects ](#14---build-projects )
- [1.5 - Homebrew ](#15---homebrew )
- [1.6 - Docker ](#16---docker )
2018-11-03 14:06:11 +00:00
- [1.7 - NPM ](#17---npm )
2018-05-12 13:47:57 +00:00
- [2 - Getting Started ](#2---getting-started )
- [3 - Usage ](#3---usage )
- [3.1 - Customization ](#31---customization )
- [3.2 - Workflow Integration ](#32---workflow-integration-maven-gradle-github-cicd )
- [3.3 - Online Generators ](#33---online-openapi-generator )
- [3.4 - License Information on Generated Code ](#34---license-information-on-generated-code )
- [4 - Companies/Projects using OpenAPI Generator ](#4---companiesprojects-using-openapi-generator )
- [5 - Presentations/Videos/Tutorials/Books ](#5---presentationsvideostutorialsbooks )
- [6 - About Us ](#6---about-us )
- [6.1 - OpenAPI Generator Core Team ](#61---openapi-generator-core-team )
- [6.2 - OpenAPI Generator Technical Committee ](#62---openapi-generator-technical-committee )
- [6.3 - History of OpenAPI Generator ](#63---history-of-openapi-generator )
- [7 - License ](#7---license )
2018-05-12 13:30:12 +00:00
2018-05-12 13:54:47 +00:00
## [1 - Installation](#table-of-contents)
2018-05-12 13:30:12 +00:00
2018-05-12 13:54:47 +00:00
### [1.1 - Compatibility](#table-of-contents)
2014-09-22 23:44:01 +00:00
2018-04-22 13:34:55 +00:00
The OpenAPI Specification has undergone 3 revisions since initial creation in 2010. The openapi-generator project has the following compatibilities with the OpenAPI Specification:
2014-09-22 23:44:01 +00:00
2018-08-15 16:23:27 +00:00
OpenAPI Generator Version | Release Date | Notes
---------------------------- | ------------ | -----
2019-06-02 16:03:16 +00:00
5.0.0 (upcoming major release) [SNAPSHOT ](https://oss.sonatype.org/content/repositories/snapshots/org/openapitools/openapi-generator-cli/5.0.0-SNAPSHOT/ )| 13.05.2020 | Major release with breaking changes (no fallback)
2019-08-10 01:41:08 +00:00
4.2.0 (upcoming minor release) [SNAPSHOT ](https://oss.sonatype.org/content/repositories/snapshots/org/openapitools/openapi-generator-cli/4.2.0-SNAPSHOT/ )| 09.10.2019 | Minor release (breaking changes with fallbacks)
2019-09-11 10:33:27 +00:00
4.1.3 (upcoming minor release) [SNAPSHOT ](https://oss.sonatype.org/content/repositories/snapshots/org/openapitools/openapi-generator-cli/4.1.3-SNAPSHOT/ )| 30.09.2019 | Patch release (bug fixes, enhancements)
2019-09-11 15:29:24 +00:00
[4.1.2 ](https://github.com/OpenAPITools/openapi-generator/releases/tag/v4.1.2 ) (latest stable release) | 12.09.2019 | Patch release (bug fixes, enhancements)
2018-08-15 16:23:27 +00:00
OpenAPI Spec compatibility: 1.0, 1.1, 1.2, 2.0, 3.0
For old releases, please refer to the [**Release** ](https://github.com/OpenAPITools/openapi-generator/releases ) page.
## [1.2 - Artifacts on Maven Central](#table-of-contents)
2014-09-22 23:44:01 +00:00
2019-01-18 09:39:33 +00:00
You can find our released artifacts on maven central:
2018-06-05 14:24:55 +00:00
**Core:**
```xml
< dependency >
< groupId > org.openapitools< / groupId >
< artifactId > openapi-generator< / artifactId >
< version > ${openapi-generator-version}< / version >
< / dependency >
```
2018-06-12 10:05:32 +00:00
See the different versions of the [openapi-generator ](https://mvnrepository.com/artifact/org.openapitools/openapi-generator ) artifact available on maven central.
2018-06-05 14:24:55 +00:00
**Cli:**
```xml
< dependency >
< groupId > org.openapitools< / groupId >
< artifactId > openapi-generator-cli< / artifactId >
< version > ${openapi-generator-version}< / version >
< / dependency >
```
2018-06-12 10:05:32 +00:00
See the different versions of the [openapi-generator-cli ](https://mvnrepository.com/artifact/org.openapitools/openapi-generator-cli ) artifact available on maven central.
2018-06-05 14:24:55 +00:00
**Maven plugin:**
```xml
< dependency >
< groupId > org.openapitools< / groupId >
< artifactId > openapi-generator-maven-plugin< / artifactId >
< version > ${openapi-generator-version}< / version >
< / dependency >
```
2018-06-12 10:05:32 +00:00
* See the different versions of the [openapi-generator-maven-plugin ](https://mvnrepository.com/artifact/org.openapitools/openapi-generator-maven-plugin ) artifact available on maven central.
2018-07-06 11:11:34 +00:00
* [Readme ](https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator-maven-plugin/README.md )
2018-06-05 14:24:55 +00:00
**Gradle plugin:**
```xml
< dependency >
< groupId > org.openapitools< / groupId >
< artifactId > openapi-generator-gradle-plugin< / artifactId >
< version > ${openapi-generator-version}< / version >
< / dependency >
```
2018-06-12 10:05:32 +00:00
* See the different versions of the [openapi-generator-gradle-plugin ](https://mvnrepository.com/artifact/org.openapitools/openapi-generator-gradle-plugin ) artifact available on maven central.
2018-06-05 14:24:55 +00:00
* [Readme ](https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator-gradle-plugin/README.adoc )
### [1.3 - Download JAR](#table-of-contents)
2019-06-24 22:22:10 +00:00
<!-- RELEASE_VERSION -->
2018-04-22 13:34:55 +00:00
If you're looking for the latest stable version, you can grab it directly from Maven.org (Java 8 runtime at a minimum):
2015-12-30 21:40:58 +00:00
2019-09-11 13:17:11 +00:00
JAR location: `http://central.maven.org/maven2/org/openapitools/openapi-generator-cli/4.1.2/openapi-generator-cli-4.1.2.jar`
2018-04-22 13:34:55 +00:00
For **Mac/Linux** users:
2017-07-20 07:16:06 +00:00
```sh
2019-09-11 13:17:11 +00:00
wget http://central.maven.org/maven2/org/openapitools/openapi-generator-cli/4.1.2/openapi-generator-cli-4.1.2.jar -O openapi-generator-cli.jar
2018-04-22 13:34:55 +00:00
```
2015-12-30 21:40:58 +00:00
2018-04-22 13:34:55 +00:00
For **Windows** users, you will need to install [wget ](http://gnuwin32.sourceforge.net/packages/wget.htm ) or you can use Invoke-WebRequest in PowerShell (3.0+), e.g.
```
2019-09-11 13:17:11 +00:00
Invoke-WebRequest -OutFile openapi-generator-cli.jar http://central.maven.org/maven2/org/openapitools/openapi-generator-cli/4.1.2/openapi-generator-cli-4.1.2.jar
2015-12-30 21:40:58 +00:00
```
2018-04-22 13:34:55 +00:00
After downloading the JAR, run `java -jar openapi-generator-cli.jar help` to show the usage.
2017-11-16 09:08:16 +00:00
2018-04-22 13:34:55 +00:00
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:
2017-07-20 07:16:06 +00:00
```sh
2018-04-22 13:34:55 +00:00
export JAVA_HOME=`/usr/libexec/java_home -v 1.8`
export PATH=${JAVA_HOME}/bin:$PATH
2015-12-30 21:40:58 +00:00
```
2019-06-24 22:22:10 +00:00
<!-- /RELEASE_VERSION -->
2018-07-25 11:12:41 +00:00
### Launcher Script
2018-08-21 14:13:55 +00:00
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 ](./bin/utils/openapi-generator-cli.sh ) which resolves this issue.
2018-07-25 11:12:41 +00:00
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).
```
mkdir -p ~/bin/openapitools
2018-08-09 02:42:11 +00:00
curl https://raw.githubusercontent.com/OpenAPITools/openapi-generator/master/bin/utils/openapi-generator-cli.sh > ~/bin/openapitools/openapi-generator-cli
2018-07-25 11:12:41 +00:00
chmod u+x ~/bin/openapitools/openapi-generator-cli
export PATH=$PATH:~/bin/openapitools/
```
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
```
2018-06-05 14:24:55 +00:00
### [1.4 - Build Projects](#table-of-contents)
2018-04-22 13:34:55 +00:00
2018-01-09 22:21:49 +00:00
To build from source, you need the following installed and available in your `$PATH:`
2014-09-22 23:44:01 +00:00
2019-07-24 04:48:17 +00:00
* [Java 8 ](https://www.oracle.com/technetwork/java/index.html )
2014-09-22 23:44:01 +00:00
2019-07-24 04:48:17 +00:00
* [Apache Maven 3.3.4 or greater ](https://maven.apache.org/ )
2015-11-10 02:20:49 +00:00
2014-09-22 23:44:01 +00:00
After cloning the project, you can build it from source with this command:
2017-07-20 07:16:06 +00:00
```sh
2018-04-22 13:34:55 +00:00
mvn clean install
2014-09-22 23:44:01 +00:00
```
2018-01-22 06:35:34 +00:00
If you don't have maven installed, you may directly use the included [maven wrapper ](https://github.com/takari/maven-wrapper ), and build with the command:
```sh
2018-04-22 13:34:55 +00:00
./mvnw clean install
2018-01-22 06:35:34 +00:00
```
2018-06-05 14:24:55 +00:00
### [1.5 - Homebrew](#table-of-contents)
2016-05-27 01:26:34 +00:00
2018-06-16 13:21:18 +00:00
To install, run `brew install openapi-generator`
2016-05-27 01:26:34 +00:00
2018-04-22 13:34:55 +00:00
Here is an example usage to generate a Ruby client:
2017-07-20 07:16:06 +00:00
```sh
2018-05-23 03:41:19 +00:00
openapi-generator generate -i https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g ruby -o /tmp/test/
2016-05-27 01:26:34 +00:00
```
2019-03-12 02:00:03 +00:00
To reinstall with the latest master, run `brew uninstall openapi-generator && brew install --HEAD openapi-generator`
2018-06-16 13:21:18 +00:00
2019-07-25 02:19:40 +00:00
To install OpenJDK (pre-requisites), please run
```sh
brew cask install adoptopenjdk12
export JAVA_HOME=/Library/Java/JavaVirtualMachines/jdk-12.0.2.jdk/Contents/Home/
```
To install Maven, please run
```sh
brew install maven
```
2018-06-05 14:24:55 +00:00
### [1.6 - Docker](#table-of-contents)
2016-05-27 01:26:34 +00:00
2018-04-22 13:34:55 +00:00
#### Public Pre-built Docker images
2016-05-27 01:26:34 +00:00
2018-05-14 02:48:35 +00:00
- [https://hub.docker.com/r/openapitools/openapi-generator-cli/ ](https://hub.docker.com/r/openapitools/openapi-generator-cli/ ) (official CLI)
2018-05-18 11:14:15 +00:00
- [https://hub.docker.com/r/openapitools/openapi-generator-online/ ](https://hub.docker.com/r/openapitools/openapi-generator-online/ ) (official web service)
2016-05-27 01:26:34 +00:00
2018-04-22 13:34:55 +00:00
#### OpenAPI Generator CLI Docker Image
2015-11-04 14:32:06 +00:00
2018-04-22 13:34:55 +00:00
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.
2016-05-27 01:26:34 +00:00
2018-04-22 13:34:55 +00:00
To generate code with this image, you'll need to mount a local location as a volume.
2015-11-04 14:32:06 +00:00
2018-04-22 13:34:55 +00:00
Example:
2015-11-04 14:32:06 +00:00
2017-07-20 07:16:06 +00:00
```sh
2018-04-22 13:34:55 +00:00
docker run --rm -v ${PWD}:/local openapitools/openapi-generator-cli generate \
-i https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/2_0/petstore.yaml \
2018-05-23 03:41:19 +00:00
-g go \
2018-04-22 13:34:55 +00:00
-o /local/out/go
2016-05-27 01:26:34 +00:00
```
2016-01-27 08:41:55 +00:00
2018-04-22 13:34:55 +00:00
The generated code will be located under `./out/go` in the current directory.
2016-01-07 13:21:06 +00:00
2018-04-22 13:34:55 +00:00
#### OpenAPI Generator Online Docker Image
2016-05-27 01:26:34 +00:00
2018-04-22 13:34:55 +00:00
The openapi-generator-online 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.
2016-05-27 01:26:34 +00:00
2018-05-16 16:09:48 +00:00
Example usage:
2015-11-05 09:12:51 +00:00
2017-07-20 07:16:06 +00:00
```sh
2018-05-16 16:09:48 +00:00
# Start container at port 8888 and save the container id
2019-07-07 14:25:43 +00:00
> CID=$(docker run -d -p 8888:8080 openapitools/openapi-generator-online)
2018-05-16 16:09:48 +00:00
2016-05-27 01:26:34 +00:00
# allow for startup
2018-05-16 16:09:48 +00:00
> sleep 10
# Get the IP of the running container (optional)
2016-05-27 01:26:34 +00:00
GEN_IP=$(docker inspect --format '{{.NetworkSettings.IPAddress}}' $CID)
2018-05-16 16:09:48 +00:00
# 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'
2018-11-30 17:00:06 +00:00
{"code":"c2d483.3.4672-40e9-91df-b9ffd18d22b8","link":"http://localhost:8888/api/gen/download/c2d483.3.4672-40e9-91df-b9ffd18d22b8"}
2018-05-16 16:09:48 +00:00
# Download the generated zip file
2018-11-30 17:00:06 +00:00
> wget http://localhost:8888/api/gen/download/c2d483.3.4672-40e9-91df-b9ffd18d22b8
2018-05-16 16:09:48 +00:00
# Unzip the file
2018-11-30 17:00:06 +00:00
> unzip c2d483.3.4672-40e9-91df-b9ffd18d22b8
2018-05-16 16:09:48 +00:00
# Shutdown the openapi generator image
> docker stop $CID && docker rm $CID
```
2016-05-27 01:26:34 +00:00
2018-04-22 13:34:55 +00:00
#### Development in docker
2016-05-27 01:26:34 +00:00
2018-04-22 13:34:55 +00:00
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.
2016-05-27 01:26:34 +00:00
2018-04-22 13:34:55 +00:00
To execute `mvn package` :
2016-05-27 01:26:34 +00:00
2018-04-22 13:34:55 +00:00
```sh
2018-05-11 08:35:59 +00:00
git clone https://github.com/openapitools/openapi-generator
2018-04-22 13:34:55 +00:00
cd openapi-generator
./run-in-docker.sh mvn package
```
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:
2016-05-27 01:26:34 +00:00
2017-07-20 07:16:06 +00:00
```sh
2018-04-22 13:34:55 +00:00
./run-in-docker.sh help # Executes 'help' command for openapi-generator-cli
2018-05-23 03:41:19 +00:00
./run-in-docker.sh list # Executes 'list' command for openapi-generator-cli
2018-04-22 13:34:55 +00:00
./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 \
2018-05-23 03:41:19 +00:00
-g go -o /gen/out/go-petstore -DpackageName=petstore # generates go client, outputs locally to ./out/go-petstore
2015-11-05 09:12:51 +00:00
```
2016-05-27 01:26:34 +00:00
2018-07-31 16:34:33 +00:00
##### Troubleshooting
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
```sh
./run-in-docker.sh mvn clean install -U
```
> Failed to execute goal org.fortasoft:gradle-maven-plugin:1.0.8:invoke (default) on project openapi-generator-gradle-plugin-mvn-wrapper: org.gradle.tooling.BuildException: Could not execute build using Gradle distribution 'https://services.gradle.org/distributions/gradle-4.7-bin.zip'
Right now: no solution for this one :|
2018-04-22 13:34:55 +00:00
#### Run Docker in Vagrant
Prerequisite: install [Vagrant ](https://www.vagrantup.com/downloads.html ) and [VirtualBox ](https://www.virtualbox.org/wiki/Downloads ).
```sh
2019-07-24 04:48:17 +00:00
git clone https://github.com/openapitools/openapi-generator.git
2018-04-22 13:34:55 +00:00
cd openapi-generator
vagrant up
vagrant ssh
cd /vagrant
./run-in-docker.sh mvn package
```
2016-05-27 01:26:34 +00:00
2018-11-03 14:06:11 +00:00
### [1.7 - NPM](#table-of-contents)
2018-11-27 16:27:35 +00:00
There is also an [NPM package wrapper ](https://www.npmjs.com/package/@openapitools/openapi-generator-cli ) available for different platforms (e.g. Linux, Mac, Windows). (JVM is still required)
Please see the [project's README ](https://github.com/openapitools/openapi-generator-cli ) there for more information.
2018-11-03 14:06:11 +00:00
Install it globally to get the CLI available on the command line:
```sh
2018-11-27 16:27:35 +00:00
npm install @openapitools/openapi -generator-cli -g
2018-11-03 14:06:11 +00:00
openapi-generator version
```
2019-06-24 22:22:10 +00:00
<!-- RELEASE_VERSION -->
2019-09-11 13:17:11 +00:00
Or install a particular OpenAPI Generator version (e.g. v4.1.2):
2018-11-03 14:06:11 +00:00
```sh
2019-09-11 13:17:11 +00:00
npm install @openapitools/openapi -generator-cli@cli-4.1.2 -g
2018-11-27 16:27:35 +00:00
```
Or install it as dev-dependency:
```sh
npm install @openapitools/openapi -generator-cli -D
2018-11-03 14:06:11 +00:00
```
2019-06-24 22:22:10 +00:00
<!-- /RELEASE_VERSION -->
2018-05-12 13:54:47 +00:00
## [2 - Getting Started](#table-of-contents)
2015-11-05 09:12:51 +00:00
2018-04-22 13:34:55 +00:00
To generate a PHP client for [petstore.yaml ](https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/2_0/petstore.yaml ), please run the following
2016-04-21 06:34:48 +00:00
```sh
2018-05-11 08:35:59 +00:00
git clone https://github.com/openapitools/openapi-generator
2018-04-22 13:34:55 +00:00
cd openapi-generator
2016-04-21 06:34:48 +00:00
mvn clean package
2018-04-20 07:25:51 +00:00
java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate \
2018-04-22 13:34:55 +00:00
-i https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/2_0/petstore.yaml \
2018-05-23 03:41:19 +00:00
-g php \
2016-04-21 06:34:48 +00:00
-o /var/tmp/php_api_client
```
2018-05-23 03:41:19 +00:00
(if you're on Windows, replace the last command with `java -jar modules\openapi-generator-cli\target\openapi-generator-cli.jar generate -i https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g php -o c:\temp\php_api_client` )
2016-04-21 06:34:48 +00:00
2019-06-24 22:22:10 +00:00
<!-- RELEASE_VERSION -->
2019-09-11 13:17:11 +00:00
You can also download the JAR (latest release) directly from [maven.org ](http://central.maven.org/maven2/org/openapitools/openapi-generator-cli/4.1.2/openapi-generator-cli-4.1.2.jar )
2019-06-24 22:22:10 +00:00
<!-- /RELEASE_VERSION -->
2016-04-21 06:34:48 +00:00
2018-04-20 07:25:51 +00:00
To get a list of **general** options available, please run `java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar help generate`
2016-04-21 06:34:48 +00:00
2018-05-23 03:41:19 +00:00
To get a list of PHP specified options (which can be passed to the generator with a config file via the `-c` option), please run `java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar config-help -g php`
2016-04-21 06:34:48 +00:00
2018-05-12 13:54:47 +00:00
## [3 - Usage](#table-of-contents)
2015-11-05 09:12:51 +00:00
2014-09-22 23:44:01 +00:00
### To generate a sample client library
2018-04-22 13:34:55 +00:00
You can build a client against the [Petstore API ](https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/2_0/petstore.yaml ) as follows:
2014-09-22 23:44:01 +00:00
2017-07-20 07:16:06 +00:00
```sh
2018-09-21 04:13:23 +00:00
./bin/java-petstore-okhttp-gson.sh
2014-09-22 23:44:01 +00:00
```
2018-09-21 04:13:23 +00:00
(On Windows, run `.\bin\windows\java-petstore-okhttp-gson.bat` instead)
2015-12-07 03:53:38 +00:00
2018-09-21 04:13:23 +00:00
This script uses the default library, which is `okhttp-gson` . It will run the generator with this command:
2014-09-22 23:44:01 +00:00
2017-07-20 07:16:06 +00:00
```sh
2018-04-20 07:25:51 +00:00
java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate \
2018-04-22 13:34:55 +00:00
-i https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/2_0/petstore.yaml \
2018-05-23 03:41:19 +00:00
-g java \
2018-09-21 04:13:23 +00:00
-o samples/client/petstore/java/okhttp-gson
2014-09-22 23:44:01 +00:00
```
2018-09-21 04:13:23 +00:00
with a number of options. [The java options are documented here. ](docs/generators/java.md )
You can also get the options with the `help generate` command (below only shows partial results):
2015-03-25 09:58:22 +00:00
2014-09-22 23:44:01 +00:00
```
2015-03-25 09:58:22 +00:00
NAME
2018-05-23 03:41:19 +00:00
openapi-generator-cli generate - Generate code with the specified
generator.
2015-03-25 09:58:22 +00:00
SYNOPSIS
2018-04-22 13:34:55 +00:00
openapi-generator-cli generate
2016-02-19 10:19:58 +00:00
[(-a < authorization > | --auth < authorization > )]
[--api-package < api package > ] [--artifact-id < artifact id > ]
[--artifact-version < artifact version > ]
2015-05-29 20:01:42 +00:00
[(-c < configuration file > | --config < configuration file > )]
2018-05-23 03:41:19 +00:00
[-D < system properties > ...]
2019-04-26 01:52:50 +00:00
[(-e < templating engine > | --engine < templating engine > )]
[--enable-post-process-file]
2018-05-23 03:41:19 +00:00
[(-g < generator name > | --generator-name < generator name > )]
2019-04-26 01:52:50 +00:00
[--generate-alias-as-model] [--git-repo-id < git repo id > ]
[--git-user-id < git user id > ] [--group-id < group id > ]
[--http-user-agent < http user agent > ]
2015-03-25 09:58:22 +00:00
(-i < spec file > | --input-spec < spec file > )
2017-06-28 09:55:23 +00:00
[--ignore-file-override < ignore file override location > ]
[--import-mappings < import mappings > ...]
[--instantiation-types < instantiation types > ...]
2016-02-19 10:19:58 +00:00
[--invoker-package < invoker package > ]
2017-06-28 09:55:23 +00:00
[--language-specific-primitives < language specific primitives > ...]
2019-04-30 16:46:48 +00:00
[--library < library > ] [--log-to-stderr] [--minimal-update]
2018-08-20 01:37:20 +00:00
[--model-name-prefix < model name prefix > ]
2017-06-28 09:55:23 +00:00
[--model-name-suffix < model name suffix > ]
[--model-package < model package > ]
2019-08-11 13:57:36 +00:00
[(-o < output directory > | --output < output directory > )]
[(-p < additional properties > | --additional-properties < additional properties > )...]
2019-04-30 16:46:48 +00:00
[--package-name < package name > ] [--release-note < release note > ]
[--remove-operation-id-prefix]
2017-06-28 09:55:23 +00:00
[--reserved-words-mappings < reserved word mappings > ...]
2019-08-11 13:57:36 +00:00
[(-s | --skip-overwrite)] [--server-variables < server variables > ...]
[--skip-validate-spec] [--strict-spec < true / false strict behavior > ]
2016-02-19 10:19:58 +00:00
[(-t < template directory > | --template-dir < template directory > )]
2017-06-28 09:55:23 +00:00
[--type-mappings < type mappings > ...] [(-v | --verbose)]
2015-03-25 09:58:22 +00:00
OPTIONS
-a < authorization > , --auth < authorization >
2018-05-23 03:41:19 +00:00
adds authorization headers when fetching the OpenAPI definitions
2015-03-25 09:58:22 +00:00
remotely. Pass in a URL-encoded string of name:header with a comma
separating multiple values
2017-12-08 10:42:14 +00:00
...... (results omitted)
2015-03-25 09:58:22 +00:00
-v, --verbose
verbose mode
2015-11-10 02:20:49 +00:00
2015-08-05 08:37:08 +00:00
```
2014-09-22 23:44:01 +00:00
2014-09-26 20:56:12 +00:00
You can then compile and run the client, as well as unit tests against it:
2014-09-22 23:44:01 +00:00
2017-07-20 07:16:06 +00:00
```sh
2018-09-21 04:13:23 +00:00
cd samples/client/petstore/java/okhttp-gson
2014-09-26 20:56:12 +00:00
mvn package
2014-09-22 23:44:01 +00:00
```
2014-09-26 20:56:12 +00:00
Other languages have petstore samples, too:
2017-07-20 07:16:06 +00:00
```sh
2018-09-21 04:13:23 +00:00
./bin/android-petstore-all.sh
./bin/java-petstore-all.sh
2014-09-26 20:56:12 +00:00
./bin/objc-petstore.sh
2014-09-22 23:44:01 +00:00
```
2018-09-21 04:13:23 +00:00
2018-11-18 01:20:32 +00:00
... and others. [Here is a list of all scripts. ](https://github.com/OpenAPITools/openapi-generator/wiki/Samples-folder#scripts )
2018-09-21 04:13:23 +00:00
2018-05-12 13:54:47 +00:00
### [3.1 - Customization](#table-of-contents)
2014-09-22 23:44:01 +00:00
2018-05-04 04:29:23 +00:00
Please refer to [customization.md ](docs/customization.md ) on how to customize the output (e.g. package name, version)
2014-09-22 23:44:01 +00:00
2018-05-12 13:54:47 +00:00
### [3.2 - Workflow Integration (Maven, Gradle, Github, CI/CD)](#table-of-contents)
2015-10-22 22:34:20 +00:00
2018-05-04 04:29:23 +00:00
Please refer to [integration.md ](docs/integration.md ) on how to integrate OpenAPI generator with Maven, Gradle, Github and CI/CD.
2015-10-22 22:34:20 +00:00
2018-05-12 13:54:47 +00:00
### [3.3 - Online OpenAPI generator](#table-of-contents)
2015-10-22 22:34:20 +00:00
2018-11-27 07:51:23 +00:00
Here are the public online services:
2019-07-24 04:48:17 +00:00
- latest stable version: https://api.openapi-generator.tech
- latest master: https://api-latest-master.openapi-generator.tech (updated with latest master every hour)
2018-11-27 07:51:23 +00:00
The server is sponsored by [Linode ](https://www.linode.com/ ) [![Linode Logo ](https://www.linode.com/media/images/logos/standard/light/linode-logo_standard_light_small.png )](https://www.linode.com/)
(These services are beta and do not have any guarantee on service level)
2019-01-22 16:48:43 +00:00
Please refer to [online.md ](docs/online.md ) on how to run and use the `openapi-generator-online` - a web service for `openapi-generator` .
2015-10-22 22:34:20 +00:00
2018-05-12 13:54:47 +00:00
### [3.4 - License information on Generated Code](#table-of-contents)
2016-05-29 02:25:45 +00:00
2018-04-22 13:34:55 +00:00
The OpenAPI Generator project is intended as a benefit for users of the Open API Specification. The project itself has the [License ](#license ) as specified. In addition, please understand the following points:
2016-05-29 02:25:45 +00:00
2018-04-22 13:34:55 +00:00
* The templates included with this project are subject to the [License ](#license ).
* Generated code is intentionally _not_ subject to the parent project license
2016-03-14 05:39:07 +00:00
2018-04-22 13:34:55 +00:00
When code is generated from this project, it shall be considered **AS IS** and owned by the user of the software. There are no warranties--expressed or implied--for generated code. You can do what you wish with it, and once generated, the code is your responsibility and subject to the licensing terms that you deem appropriate.
2018-05-12 13:54:47 +00:00
## [4 - Companies/Projects using OpenAPI Generator](#table-of-contents)
2018-06-07 10:27:27 +00:00
Here are some companies/projects (alphabetical order) using OpenAPI Generator in production. To add your company/project to the list, please visit [README.md ](README.md ) and click on the icon to edit the page.
2016-03-14 05:39:07 +00:00
2019-01-24 02:42:11 +00:00
- [Adaptant Solutions AG ](https://www.adaptant.io/ )
2018-06-10 06:19:17 +00:00
- [Angular.Schule ](https://angular.schule/ )
2018-12-07 15:05:26 +00:00
- [ASKUL ](https://www.askul.co.jp )
2018-11-30 01:22:01 +00:00
- [b<>com ](https://b-com.com/en )
2019-01-17 14:11:29 +00:00
- [BIMData.io ](https://bimdata.io )
2018-06-06 02:57:54 +00:00
- [Bithost GmbH ](https://www.bithost.ch )
2018-08-28 16:42:40 +00:00
- [Boxever ](https://www.boxever.com/ )
2019-05-11 06:15:59 +00:00
- [CAM ](https://www.cam-inc.co.jp/ )
2019-04-12 10:49:50 +00:00
- [Camptocamp ](https://www.camptocamp.com/en )
2019-01-23 10:00:12 +00:00
- [codecentric AG ](https://www.codecentric.de/ )
2019-08-06 08:24:29 +00:00
- [Commencis ](https://www.commencis.com/ )
2019-01-22 08:55:49 +00:00
- [Cupix ](https://www.cupix.com/ )
2019-07-03 10:38:06 +00:00
- [DB Systel ](https://www.dbsystel.de )
2019-09-07 03:45:26 +00:00
- [Element AI ](https://www.elementai.com/ )
2019-01-16 10:14:54 +00:00
- [FormAPI ](https://formapi.io/ )
2019-06-18 08:45:13 +00:00
- [Fuse ](https://www.fuse.no/ )
2019-09-23 12:47:20 +00:00
- [Gantner ](https://www.gantner.com )
2019-01-03 14:31:10 +00:00
- [GenFlow ](https://github.com/RepreZen/GenFlow )
2018-06-07 08:45:23 +00:00
- [GMO Pepabo ](https://pepabo.com/en/ )
2019-03-28 16:12:55 +00:00
- [GoDaddy ](https://godaddy.com )
2018-09-03 09:43:25 +00:00
- [JustStar ](https://www.juststarinfo.com )
2018-10-31 08:35:39 +00:00
- [Klarna ](https://www.klarna.com/ )
2019-09-19 14:29:39 +00:00
- [Médiavision ](https://www.mediavision.fr/ )
2018-12-07 13:23:53 +00:00
- [Metaswitch ](https://www.metaswitch.com/ )
2018-09-26 03:53:55 +00:00
- [Myworkout ](https://myworkout.com )
2019-08-22 05:59:34 +00:00
- [Paxos ](https://www.paxos.com )
2019-08-28 13:05:29 +00:00
- [Pricefx ](https://www.pricefx.com/ )
2019-01-16 14:00:44 +00:00
- [Prometheus/Alertmanager ](https://github.com/prometheus/alertmanager )
2018-06-07 10:27:27 +00:00
- [Raiffeisen Schweiz Genossenschaft ](https://www.raiffeisen.ch )
2018-07-24 04:13:28 +00:00
- [RepreZen API Studio ](https://www.reprezen.com/swagger-openapi-code-generation-api-first-microservices-enterprise-development )
2018-06-07 10:27:27 +00:00
- [REST United ](https://restunited.com )
2018-12-10 14:48:28 +00:00
- [Stingray ](http://www.stingray.com )
2018-08-22 02:43:32 +00:00
- [Suva ](https://www.suva.ch/ )
2018-06-20 03:59:25 +00:00
- [Telstra ](https://dev.telstra.com )
2018-11-17 03:38:13 +00:00
- [TUI InfoTec GmbH ](http://www.tui-infotec.com/ )
2018-06-07 14:12:03 +00:00
- [unblu inc. ](https://www.unblu.com/ )
2019-03-04 14:27:54 +00:00
- [Veamly ](https://www.veamly.com/ )
2019-07-10 08:35:34 +00:00
- [WSO2 ](https://wso2.com/ )
2019-01-22 08:49:53 +00:00
- [Xero ](https://www.xero.com/ )
2019-05-21 03:08:58 +00:00
- [Yelp ](https://www.yelp.com/ )
2018-08-29 03:34:58 +00:00
- [Zalando ](https://www.zalando.com )
2018-06-07 10:27:27 +00:00
2018-05-12 13:54:47 +00:00
## [5 - Presentations/Videos/Tutorials/Books](#table-of-contents)
2016-01-05 13:02:05 +00:00
2018-05-16 15:07:42 +00:00
- 2018/05/12 - [OpenAPI Generator - community drivenで成長するコードジェネレータ ](https://ackintosh.github.io/blog/2018/05/12/openapi-generator/ ) by [中野暁人 ](https://github.com/ackintosh )
- 2018/05/15 - [Starting a new open-source project ](http://jmini.github.io/blog/2018/2018-05-15_new-open-source-project.html ) by [Jeremie Bresson ](https://github.com/jmini )
- 2018/05/15 - [REST API仕様からAPIクライアントやスタブサーバを自動生成する「OpenAPI Generator」オープンソースで公開。Swagger Codegenからのフォーク ](https://www.publickey1.jp/blog/18/rest_apiapiopenapi_generatorswagger_generator.html ) by [Publickey ](https://www.publickey1.jp )
2018-06-10 06:19:17 +00:00
- 2018/06/08 - [Swagger Codegen is now OpenAPI Generator ](https://angular.schule/blog/2018-06-swagger-codegen-is-now-openapi-generator ) by [JohannesHoppe ](https://github.com/JohannesHoppe )
2018-06-30 10:52:11 +00:00
- 2018/06/21 - [Connect your JHipster apps to the world of APIs with OpenAPI and gRPC ](https://fr.slideshare.net/chbornet/jhipster-conf-2018-connect-your-jhipster-apps-to-the-world-of-apis-with-openapi-and-grpc ) by [Christophe Bornet ](https://github.com/cbornet ) at [JHipster Conf 2018 ](https://jhipster-conf.github.io/ )
2018-08-22 08:44:31 +00:00
- 2018/06/27 - [Lessons Learned from Leading an Open-Source Project Supporting 30+ Programming Languages ](https://speakerdeck.com/wing328/lessons-learned-from-leading-an-open-source-project-supporting-30-plus-programming-languages ) - [William Cheng ](https://github.com/wing328 ) at [LinuxCon + ContainerCon + CloudOpen China 2018 ](http://bit.ly/2waDKKX )
2018-07-23 10:36:39 +00:00
- 2018/07/19 - [OpenAPI Generator Contribution Quickstart - RingCentral Go SDK ](https://medium.com/ringcentral-developers/openapi-generator-for-go-contribution-quickstart-8cc72bf37b53 ) by [John Wang ](https://github.com/grokify )
2018-09-26 12:41:12 +00:00
- 2018/08/22 - [OpenAPI Generatorのプロジェクト構成などのメモ ](https://yinm.info/20180822/ ) by [Yusuke Iinuma ](https://github.com/yinm )
2019-01-07 14:54:43 +00:00
- 2018/09/12 - [RepreZen and OpenAPI 3.0: Now is the Time ](https://www.reprezen.com/blog/reprezen-openapi-3.0-upgrade-now-is-the-time ) by [Miles Daffin ](https://www.reprezen.com/blog/author/miles-daffin )
2018-10-31 08:35:39 +00:00
- 2018/10/31 - [A node package wrapper for openapi-generator ](https://github.com/HarmoWatch/openapi-generator-cli )
2018-11-05 00:17:22 +00:00
- 2018/11/03 - [OpenAPI Generator + golang + Flutter でアプリ開発 ](http://ryuichi111std.hatenablog.com/entry/2018/11/03/214005 ) by [Ryuichi Daigo ](https://github.com/ryuichi111 )
2019-03-08 07:58:33 +00:00
- 2018/11/15 - [基于openapi3.0的yaml文件生成java代码的一次实践 ](https://blog.csdn.net/yzy199391/article/details/84023982 ) by [焱魔王 ](https://me.csdn.net/yzy199391 )
2018-11-27 15:59:23 +00:00
- 2018/11/19 - [OpenAPIs are everywhere ](https://youtu.be/-lDot4Yn7Dg ) by [Jeremie Bresson (Unblu) ](https://github.com/jmini ) at [EclipseCon Europe 2018 ](https://www.eclipsecon.org/europe2018 )
2019-01-07 14:45:46 +00:00
- 2018/12/09 - [openapi-generator をカスタマイズする方法 ](https://qiita.com/watiko/items/0961287c02eac9211572 ) by [@watiko ](https://qiita.com/watiko )
2019-01-07 14:54:43 +00:00
- 2019/01/03 - [Calling a Swagger service from Apex using openapi-generator ](https://lekkimworld.com/2019/01/03/calling-a-swagger-service-from-apex-using-openapi-generator/ ) by [Mikkel Flindt Heisterberg ](https://lekkimworld.com )
2019-01-14 04:15:00 +00:00
- 2019/01/13 - [OpenAPI GeneratorでRESTful APIの定義書から色々自動生成する ](https://ky-yk-d.hatenablog.com/entry/2019/01/13/234108 ) by [@ky_yk_d ](https://twitter.com/ky_yk_d )
2019-08-06 08:24:29 +00:00
- 2019/01/20 - [Contract-First API Development with OpenAPI Generator and Connexion ](https://medium.com/commencis/contract-first-api-development-with-openapi-generator-and-connexion-b21bbf2f9244 ) by [Anil Can Aydin ](https://github.com/anlcnydn )
2019-03-07 07:42:39 +00:00
- 2019/01/30 - [Rapid Application Development With API First Approach Using Open-API Generator ](https://dzone.com/articles/rapid-api-development-using-open-api-generator ) by [Milan Sonkar ](https://dzone.com/users/828329/milan_sonkar.html )
2019-02-03 16:30:32 +00:00
- 2019/02/02 - [平静を保ち、コードを生成せよ 〜 OpenAPI Generator誕生の背景と軌跡 〜 ](https://speakerdeck.com/akihito_nakano/gunmaweb34 ) by [中野暁人 ](https://github.com/ackintosh ) at [Gunma.web #34 スキーマ駆動開発 ](https://gunmaweb.connpass.com/event/113974/ )
2019-03-20 07:14:01 +00:00
- 2019/02/20 - [An adventure in OpenAPI V3 code generation ](https://mux.com/blog/an-adventure-in-openapi-v3-api-code-generation/ ) by [Phil Cluff ](https://mux.com/blog/author/philc/ )
2019-03-01 13:16:40 +00:00
- 2019/02/26 - [Building API Services: A Beginner’ s Guide ](https://medium.com/google-cloud/building-api-services-a-beginners-guide-7274ae4c547f ) by [Ratros Y. ](https://medium.com/@ratrosy ) in [Google Cloud Platofrm Blog ](https://medium.com/google-cloud )
2019-03-02 13:45:23 +00:00
- 2019/02/26 - [Building APIs with OpenAPI: Continued ](https://medium.com/@ratrosy/building-apis-with-openapi-continued-5d0faaed32eb ) by [Ratros Y. ](https://medium.com/@ratrosy ) in [Google Cloud Platofrm Blog ](https://medium.com/google-cloud )
2019-03-25 05:13:41 +00:00
- 2019-03-07 - [OpenAPI Generator で Spring Boot と Angular をタイプセーフに繋ぐ ](https://qiita.com/chibato/items/e4a748db12409b40c02f ) by [Tomofumi Chiba ](https://github.com/chibat )
2019-03-27 02:26:37 +00:00
- 2019-03-25 - [Access any REST service with the SAP S/4HANA Cloud SDK ](https://blogs.sap.com/2019/03/25/integrate-sap-s4hana-cloud-sdk-with-open-api/ ) by [Alexander Duemont ](https://people.sap.com/alexander.duemont )
2019-03-27 01:44:23 +00:00
- 2019-03-25 - [OpenAPI generatorを試してみる ](https://qiita.com/amuyikam/items/e8a45daae59c68be0fc8 ) by [@amuyikam ](https://twitter.com/amuyikam )
2019-04-02 06:44:48 +00:00
- 2019-03-27 - [OpenAPI3を使ってみよう! Go言語でクライアントとスタブの自動生成まで! ](https://techblog.zozo.com/entry/openapi3/go ) by [@gold_kou ](https://twitter.com/gold_kou )
2019-05-21 15:43:29 +00:00
- 2019-04-17 - [OpenAPIによるスキーマファースト開発の実施サンプルとCloud Runについて ](https://tech-blog.optim.co.jp/entry/2019/04/17/174000 ) by [@yukey1031 ](https://twitter.com/yukey1031 )
2019-04-19 04:49:41 +00:00
- 2019-04-18 - [How to use OpenAPI3 for API developer (RubyKaigi 2019) ](https://speakerdeck.com/ota42y/how-to-use-openapi3-for-api-developer ) by [@ota42y ](https://twitter.com/ota42y ) at [RubyKaigi 2019 ](https://rubykaigi.org/2019 )
2019-04-29 15:05:30 +00:00
- 2019-04-29 - [A Beginner's Guide to Code Generation for REST APIs (OpenAPI Generator) ](https://gum.co/openapi_generator_ebook ) by [William Cheng ](https://twitter.com/wing328 )
2019-05-01 07:15:45 +00:00
- 2019-05-01 - [Design and generate a REST API from Swagger / OpenAPI in Java, Python, C# and more ](https://simply-how.com/design-and-generate-api-code-from-openapi ) by [Simply How ](https://simply-how.com/ )
2019-05-20 11:00:31 +00:00
- 2019-05-17 - [Generate Spring Boot REST API using Swagger/OpenAPI ](https://www.47northlabs.com/knowledge-base/generate-spring-boot-rest-api-using-swagger-openapi/ ) by [Antonie Zafirov ](https://www.47northlabs.com/author/antonie-zafirov/ )
2019-05-22 10:27:26 +00:00
- 2019-05-22 - [REST APIs代码生成指南(OpenAPI Generator) ](https://gum.co/openapi_generator_ebook_gb ) by [William Cheng ](https://twitter.com/wing328 ), [Xin Meng ](https://github.com/xmeng1 )
2019-06-24 06:00:18 +00:00
- 2019-05-24 - [REST API 代碼生成指南 (OpenAPI Generator) ](https://gum.co/openapi_generator_ebook_big5 ) by [William Cheng ](https://twitter.com/wing328 )
2019-06-24 06:42:01 +00:00
- 2019-06-24 - [Kubernetes Clients and OpenAPI Generator ](https://speakerdeck.com/wing328/kubernetes-clients-and-openapi-generator ) by [William Cheng ](https://twitter.com/wing328 ) at [Kubernetes Contributor Summits Shanghai 2019 ](https://www.lfasiallc.com/events/contributors-summit-china-2019/ )
2019-07-13 02:39:58 +00:00
- 2019-06-28 [Codewind OpenAPI Tools ](https://marketplace.eclipse.org/content/codewind-openapi-tools ) in [Eclipse Marketplace ](https://marketplace.eclipse.org/ ) by IBM
- 2019-06-29 [Codewind OpenAPI Tools ](https://marketplace.visualstudio.com/items?itemName=IBM.codewind-openapi-tools ) in [Visual Studio Marketplace ](https://marketplace.visualstudio.com/ ) by IBM
2019-07-04 14:24:35 +00:00
- 2019-07-04 - [REST API のためのコード生成入門 (OpenAPI Generator) ](https://gum.co/openapi_generator_ebook_big5 ) by [William Cheng ](https://twitter.com/wing328 ), [中野暁人 ](https://github.com/ackintosh ), [和田拓朗 ](https://github.com/taxpon )
2019-07-15 08:46:26 +00:00
- 2019-07-08 - [OpenAPI Generator にコントリビュートしたら社名が載った話。(CAM) - CAM TECH BLOG ](https://tech.cam-inc.co.jp/entry/2019/07/08/140000 ) by [CAM, Inc. ](https://www.cam-inc.co.jp/ )
2019-07-14 06:22:24 +00:00
- 2019-07-14 - [OpenAPI GeneratorでPythonのクライアントライブラリを作成した ](https://qiita.com/yuji38kwmt/items/dfb929316a1335a161c0 ) by [yuji38kwmt ](https://qiita.com/yuji38kwmt )
2019-07-19 07:15:22 +00:00
- 2019-07-19 - [Developer Experience (DX) for Open-Source Projects: How to Engage Developers and Build a Growing Developer Community ](https://speakerdeck.com/wing328/developer-experience-dx-for-open-source-projects-english-japanese ) by [William Cheng ](https://twitter.com/wing328 ), [中野暁人 ](https://github.com/ackintosh ) at [Open Source Summit Japan 2019 ](https://events.linuxfoundation.org/events/open-source-summit-japan-2019/ )
2019-08-25 15:19:04 +00:00
- 2019-08-14 - [Our OpenAPI journey with Standardizing SDKs ](https://bitmovin.com/our-openapi-journey-with-standardizing-sdks/ ) by [Sebastian Burgstaller ](https://bitmovin.com/author/sburgstaller/ ) at [Bitmovin ](https://www.bitmovin.com )
2019-08-28 01:49:56 +00:00
- 2019-08-15 - [APIのコードを自動生成させたいだけならgRPCでなくてもよくない? ](https://www.m3tech.blog/entry/2019/08/15/110000 ) by [M3, Inc. ](https://corporate.m3.com/ )
2019-09-07 03:26:35 +00:00
- 2019-08-22 - [マイクロサービスにおけるWeb APIスキーマの管理─ GraphQL、gRPC、OpenAPIの特徴と使いどころ ](https://employment.en-japan.com/engineerhub/entry/2019/08/22/103000 ) by [@ota42y ](https://twitter.com/ota42y )
2019-08-24 03:59:47 +00:00
- 2019-08-24 - [SwaggerドキュメントからOpenAPI Generatorを使ってモックサーバー作成 ](https://qiita.com/masayoshi0222/items/4845e4c715d04587c104 ) by [坂本正義 ](https://qiita.com/masayoshi0222 )
2019-09-03 16:04:16 +00:00
- 2019-08-29 - [OpenAPI初探 ](https://cloud.tencent.com/developer/article/1495986 ) by [peakxie ](https://cloud.tencent.com/developer/user/1113152 ) at [腾讯云社区 ](https://cloud.tencent.com/developer )
- 2019-08-29 - [全面进化: Kubernetes CRD 1.16 GA前瞻 ](https://www.servicemesher.com/blog/kubernetes-1.16-crd-ga-preview/ ) by [Min Kim ](https://github.com/yue9944882 ) at [ServiceMesher Blog ](https://www.servicemesher.com/blog/ )
- 2019-09-01 - [Creating a PHP-Slim server using OpenAPI (Youtube video) ](https://www.youtube.com/watch?v=5cJtbIrsYkg ) by [Daniel Persson ](https://www.youtube.com/channel/UCnG-TN23lswO6QbvWhMtxpA )
2019-09-20 09:07:43 +00:00
- 2019-09-14 - [Generating and Configuring a Mastercard API Client ](https://developer.mastercard.com/platform/documentation/generating-and-configuring-a-mastercard-api-client/ ) at [Mastercard Developers Platform ](https://developer.mastercard.com/platform/documentation/ )
2019-09-19 07:33:49 +00:00
- 2019-09-15 - [OpenAPI(Swagger)導入下調べ ](https://qiita.com/ShoichiKuraoka/items/f1f7a3c2376f7cd9c56a ) by [Shoichi Kuraoka ](https://qiita.com/ShoichiKuraoka )
2019-09-24 05:10:21 +00:00
- 2019-09-22 - [OpenAPI 3を完全に理解できる本 ](https://booth.pm/ja/items/1571902 ) by [@ota42y ](https://twitter.com/ota42y )
2019-09-26 14:55:31 +00:00
- 2019-09-22 - [RESTful APIs: Tutorial of OpenAPI Specification ](https://medium.com/@amirm.lavasani/restful-apis-tutorial-of-openapi-specification-eeada0e3901d ) by [Amir Lavasani ](https://medium.com/@amirm.lavasani )
2019-09-26 15:21:25 +00:00
- 2019-09-22 - [Redefining SDKs as software diversity kits ](https://devrel.net/dev-rel/redefining-sdks-as-software-diversity-kits ) by [Sid Maestre (Xero) ](https://twitter.com/sidneyallen ) at [DevRelCon San Francisco 2019 ](https://sf2019.devrel.net/ )
2019-09-24 10:04:26 +00:00
- 2019-09-23 - [swaggerからOpenApi GeneratorでSpringのコードを自動生成 ](https://qiita.com/littleFeet/items/492df2ad68a0799a5e5e ) by [@littleFeet ](https://qiita.com/littleFeet ) at [Qiita ](https://qiita.com/ )
2019-03-27 02:26:37 +00:00
2018-05-12 13:54:47 +00:00
## [6 - About Us](#table-of-contents)
2015-10-31 16:02:08 +00:00
2018-05-12 13:54:47 +00:00
### [6.1 - OpenAPI Generator Core Team](#table-of-contents)
2016-06-27 01:50:54 +00:00
2018-04-22 13:34:55 +00:00
OpenAPI Generator core team members are contributors who have been making significant contributions (review issues, fix bugs, make enhancements, etc) to the project on a regular basis.
2017-04-05 08:41:07 +00:00
2018-05-12 13:41:09 +00:00
#### Core Team Members
2019-01-12 02:57:44 +00:00
* [@wing328 ](https://github.com/wing328 ) (2015/07) [:heart: ](https://www.patreon.com/wing328 )
* [@jimschubert ](https://github.com/jimschubert ) (2016/05) [:heart: ](https://www.patreon.com/jimschubert )
2018-02-25 08:54:59 +00:00
* [@cbornet ](https://github.com/cbornet ) (2016/05)
2019-01-12 02:57:44 +00:00
* [@ackintosh ](https://github.com/ackintosh ) (2018/02) [:heart: ](https://www.patreon.com/ackintosh/overview )
2019-06-09 03:48:13 +00:00
* [@jmini ](https://github.com/jmini ) (2018/04) [:heart: ](https://www.patreon.com/jmini )
2019-06-06 19:36:00 +00:00
* [@etherealjoy ](https://github.com/etherealjoy ) (2019/06)
2016-05-08 10:48:22 +00:00
2019-01-12 02:57:44 +00:00
:heart: = Link to support the contributor directly
2018-05-12 13:41:09 +00:00
#### Template Creator
2019-04-26 01:52:50 +00:00
**NOTE**: Embedded templates are only supported in _Mustache_ format. Support for all other formats is experimental and subject to change at any time.
2016-05-08 10:48:22 +00:00
Here is a list of template creators:
* API Clients:
2017-10-04 03:49:40 +00:00
* Ada: @stcarrez
2017-05-19 15:32:10 +00:00
* Apex: @asnelling
2017-01-12 08:48:25 +00:00
* Bash: @bkryza
2019-01-14 14:13:36 +00:00
* C: @PowerOfCreation @zhemant [:heart: ](https://www.patreon.com/zhemant )
2016-06-15 02:44:04 +00:00
* C++ REST: @Danielku15
2016-05-08 15:24:14 +00:00
* C# (.NET 2.0): @who
2017-04-24 06:47:43 +00:00
* C# (.NET Standard 1.3 ): @Gronsak
2019-01-12 02:57:44 +00:00
* C# (.NET 4.5 refactored): @jimschubert [:heart: ](https://www.patreon.com/jimschubert )
2016-05-08 10:48:22 +00:00
* Clojure: @xhh
2016-11-30 15:31:21 +00:00
* Dart: @yissachar
2018-09-02 09:59:42 +00:00
* Dart (refactor): @joernahrens
* Dart 2: @swipesight
2018-09-14 12:49:13 +00:00
* Dart (Jaguar): @jaumard
2017-01-30 09:42:00 +00:00
* Elixir: @niku
2019-01-04 03:49:50 +00:00
* Elm: @eriktim
2017-08-10 18:05:14 +00:00
* Eiffel: @jvelilla
2017-11-12 14:07:12 +00:00
* Erlang: @tsloughter
2018-10-30 16:09:30 +00:00
* Erlang (PropEr): @jfacorro @robertoaloi
2016-11-30 15:31:21 +00:00
* Groovy: @victorgit
2019-01-12 02:57:44 +00:00
* Go: @wing328 [:heart: ](https://www.patreon.com/wing328 )
2017-05-05 13:50:32 +00:00
* Go (rewritten in 2.3.0): @antihax
2017-10-20 03:06:28 +00:00
* Haskell (http-client): @jonschoning
2016-11-30 15:31:21 +00:00
* Java (Feign): @davidkiss
2016-05-08 10:48:22 +00:00
* Java (Retrofit): @0legg
2017-08-31 02:11:58 +00:00
* Java (Retrofit2): @emilianobonassi
2016-11-29 09:12:23 +00:00
* Java (Jersey2): @xhh
2016-05-08 10:48:22 +00:00
* Java (okhttp-gson): @xhh
2017-04-24 06:42:07 +00:00
* Java (RestTemplate): @nbruno
2018-07-04 07:40:57 +00:00
* Java (Spring 5 WebClient): @daonomic
2017-05-02 11:10:48 +00:00
* Java (RESTEasy): @gayathrigs
2017-07-31 14:12:00 +00:00
* Java (Vertx): @lopesmcc
2017-11-03 10:46:07 +00:00
* Java (Google APIs Client Library): @charlescapps
2018-01-28 17:16:21 +00:00
* Java (Rest-assured): @viclovsky
2019-07-27 14:49:01 +00:00
* Java (Java 11 Native HTTP client): @bbdouglas
2016-11-30 15:31:21 +00:00
* Javascript/NodeJS: @jfiala
2016-05-08 10:48:22 +00:00
* Javascript (Closure-annotated Angular) @achew22
2018-06-25 04:04:10 +00:00
* Javascript (Flow types) @jaypea
2017-08-10 18:05:14 +00:00
* JMeter: @davidkiss
2019-01-12 02:57:44 +00:00
* Kotlin: @jimschubert [:heart: ](https://www.patreon.com/jimschubert )
2019-09-22 02:00:26 +00:00
* Kotlin (MultiPlatform): @andrewemery
2017-08-10 18:05:14 +00:00
* Lua: @daurnimator
Add Nim client code generator (#3879)
* First version of Nim Client
* Add some codes
* Add some codes
* Add some codes
* Add some codes
* Add some codes
* First version of Nim Client
* Add some codes
* Add some codes
* [Dart] Fix README template and update testing doco (#3809)
* [Dart] Fix README template and update testing doco
- deleted redundant shell script
- fixed and updated README template
- updated test package and moved to a dev_dependency
- removed old unused dev_dependency packages
- updated testing documentation in petstore sample
* Remove references to dart-flutter-petstore.sh
* Fix typos
* Fix typo
* Support custom git repository (#3757)
* add gitHost param to GeneratorSettings and related
* parameterize gitHost in READMEs
* parameterize gitHost in go.mod
* parameterize gitHost in git_push
* update petstore samples
* run ./bin/utils/export_docs_generators.sh
* run meta-codehen.sh
* Revert "run meta-codehen.sh"
This reverts commit d6d579f6159186531257cdfdd73b9caf9e9ffeba.
* Revert "run ./bin/utils/export_docs_generators.sh"
This reverts commit 1b81538198d4319fd1b4e97447303e3cc0e8dc99.
* Revert "update petstore samples"
This reverts commit f513add88396707f6991ae2e4920359583ec88f1.
* run ensure-up-to-date
* Add links to article and video (#3820)
* Better Go code format (#3819)
* better varible naming
* better comments
* better code format for go experimental client
* better comment, update samples
* Add some codes
* Add some codes
* Add some codes
* Add gRPC Protobuf schema generator (#3818)
* add grpc protobuf generator
* update doc
* add new doc
* add windows batch, comment out root proto
* 1792 fix remote spec handling and hash calculation (#3440)
* fixed bug where nullApi.java would be generated. Instead, generated DefaultApi.java to match the default path /{pathParam} (#3821)
* Revert "1792 fix remote spec handling and hash calculation (#3440)"
This reverts commit 2a2eefe93d81b8d253745b8adb002ab2cb9eee04.
* Add nickmeinhold to Dart technical committee (#3830)
* Bug #2845 typescript angular inheritance (#3812)
* issue #2845: enable 'supportsMultipleInheritance' on typescript angular client codegen
- note I reran ./bin/openapi3/typescript-angular-petstore-all.sh and no changes occurred.
this suggests to me that the petstore.yaml sample should be improved to make use of the
anyOf / allOf / oneOf keywords, in order to better show the effects of changes on generated code.
* issue #2845: run ./bin/openapi3/typescript-angular-petstore-all.sh
* run `mvn clean package && ./bin/typescript-angular-petstore-all.sh`
* revert extranous files
* fix warnings in csharp-netcore client (#3831)
* Add missing files to the form request (#3834)
* [client][go] avoid duplicated reflect imports (#3847)
* Following up for #3440 (1792 fix remote spec handling and hash calculation) (#3826)
* This patch fixes the bug that we cannot access to remote files when checking file updates.
Following up #3440, supporting auth.
* 1792 fix remote spec handling and hash calculation (#3440)
(cherry picked from commit 2a2eefe93d81b8d253745b8adb002ab2cb9eee04)
* fix detecting remote file / local file logic while finding the hash file, taking care of IllegalArgumentException for local files.
* add testcase
* Add a link (#3850)
* Add Element AI to the list (#3856)
* maven-plugin-plugin 3.6.0 (#3854)
* [Java][okhttp-gson] fix failure to deserialize floats (#3846)
* fixed bug where nullApi.java would be generated. Instead, generated DefaultApi.java to match the default path /{pathParam}
* fix to bug #3157
* update samples
* Adds Http Info To Dart Api (#3851)
* [C++][Pistache] Add missing setter for arrays (#3837)
* [C++][Pistache] Add missing setter for arrays
Fixes #3769
* [C++][Pistache] Update Petstore sample
* typescript-inversify: improve check for required parameters, support multiple media types (#3849)
* [typescript-inversify] Allow falsy parameters
A required parameter to an api method must not be `null` or `undefined`.
It can be any other falsy value, e.g. `""`, `0` or `false` though. This
change makes sure an error is only thrown in the former case and not in
the latter.
* [typescript-inversify] Handle multiple media types
The Accept and Content-Type HTTP headers can contain a list of media
types. Previously all but the first media type in the api definition
were ignored. Now the headers are properly generated.
* [typescript-inversify] Fix http client interface
The api service methods allow the `body` parameter to be optional. The
parameter is then passed to an `IHttpClient`. So it needs to be optional
there as well.
Also fixed the sample implementation `HttpClient`.
Fixes #3618.
* [typescript-inversify] Regenerate Petstore sample
* [typescript-inversify] Use more explicit null check
This does not change the semantic of the generated code, but makes it more explicit.
Co-Authored-By: Esteban Gehring <esteban.gehring@gmail.com>
* [typescript-angular] allow empty string basePath (#3489)
* [typescript-angular] Fixing #2731 - empty string basePath
* typescript-angular: refactor base path configuration
* typescript-angular: refactor base path configuration
* Fix/r/serialization fix and minor 3xx resp fix (#3817)
* fix(qlik): fix for minor serialization bug
* fix(r): add petsore generated classes
* fix(r): indendation fixes
* typescript-axios: Fix baseoptions (#3866)
* Fixed missing baseOptions of typescript-axios.
The typescript-axios template was missing the baseOptions setting when building an API Configuration. Set it.
* update sample.
* re-generate typescript axios samples
* Rename gRPC generator to "protobuf-schema" (#3864)
* rename grpc generator to protobuf-schema
* update doc
* Prepare v4.1.2 release (#3873)
* update samples
* update date
* fix version in readme
* BugFix #2053 Spring Boot fails to parse LocalDate query parameter (#3860)
Adds the format annotation so that Spring is able to serialize OpenApi date/date-time format into LocalDate/OffsetDateTime.
* update doc, samples (#3875)
* update stable release
* Update the batch for Windows
* Add a test snippet
* Update ensure-up-to-date
* Add Nim to README.md
* Ran ensure-up-to-date to pass CircleCI tests
2019-09-13 07:56:54 +00:00
* Nim: @hokamoto
2019-07-29 02:07:32 +00:00
* OCaml: @cgensoul
2019-01-12 02:57:44 +00:00
* Perl: @wing328 [:heart: ](https://www.patreon.com/wing328 )
2017-05-02 11:14:54 +00:00
* PHP (Guzzle): @baartosz
2017-06-20 15:26:19 +00:00
* PowerShell: @beatcracker
2017-09-03 17:25:04 +00:00
* R: @ramnov
2019-08-03 06:54:18 +00:00
* Ruby (Faraday): @meganemura @dkliban
2017-08-06 09:06:58 +00:00
* Rust: @farcaller
2017-10-19 09:37:02 +00:00
* Rust (rust-server): @metaswitch
2017-12-08 10:42:14 +00:00
* Scala (scalaz & http4s): @tbrown1979
2019-05-02 09:53:41 +00:00
* Scala (Akka): @cchafer
2016-05-08 10:48:22 +00:00
* Swift: @tkqubo
2016-10-15 10:18:10 +00:00
* Swift 3: @hexelon
2017-07-08 17:36:12 +00:00
* Swift 4: @ehyche
2018-10-30 16:09:30 +00:00
* TypeScript (Angular1): @mhardorf
2016-05-08 10:48:22 +00:00
* TypeScript (Angular2): @roni -frantchi
2018-10-31 08:35:39 +00:00
* TypeScript (Angular6): @akehir
2018-10-30 16:09:30 +00:00
* TypeScript (Angular7): @topce
2018-09-18 14:47:06 +00:00
* TypeScript (Axios): @nicokoenig
* TypeScript (Fetch): @leonyu
2017-12-08 10:42:14 +00:00
* TypeScript (jQuery): @bherila
2018-09-18 14:47:06 +00:00
* TypeScript (Node): @mhardorf
2019-01-21 15:26:18 +00:00
* TypeScript (Rxjs): @denyo
2019-05-27 15:33:07 +00:00
* TypeScript (Inversify): @gualtierim
2016-05-08 10:48:22 +00:00
* Server Stubs
2018-01-19 05:21:39 +00:00
* Ada: @stcarrez
2019-06-25 11:23:49 +00:00
* C# ASP.NET 5: @jimschubert [:heart: ](https://www.patreon.com/jimschubert )
* C# ASP.NET Core 3.0: @A -Joshi
2016-06-22 02:33:31 +00:00
* C# NancyFX: @mstefaniuk
2018-08-02 14:39:37 +00:00
* C++ (Qt5 QHttpEngine): @etherealjoy
2017-06-14 14:41:24 +00:00
* C++ Pistache: @sebymiano
2017-06-02 06:51:43 +00:00
* C++ Restbed: @stkrwork
2016-09-09 07:49:27 +00:00
* Erlang Server: @galaxie
2019-05-06 14:11:50 +00:00
* F# (Giraffe) Server: @nmfisher
2016-06-20 14:42:24 +00:00
* Go Server: @guohuang
2018-10-01 13:24:32 +00:00
* Go (Gin) Server: @kemokemo
2018-12-06 02:37:46 +00:00
* GraphQL Express Server: @renepardon
2016-05-08 10:48:22 +00:00
* Haskell Servant: @algas
2016-10-26 06:41:44 +00:00
* Java MSF4J: @sanjeewa -malalgoda
2016-05-08 10:48:22 +00:00
* Java Spring Boot: @diyfr
2016-10-26 06:41:44 +00:00
* Java Undertow: @stevehu
2017-03-10 14:10:49 +00:00
* Java Play Framework: @JFCote
2017-12-19 13:12:14 +00:00
* Java PKMST: @anshu2185 @sanshuman @rkumar -pk @ninodpillai
2016-05-08 10:48:22 +00:00
* JAX-RS RestEasy: @chameleon82
2016-10-10 13:10:52 +00:00
* JAX-RS CXF: @hiveship
* JAX-RS CXF (CDI): @nickcmaynard
2017-03-01 04:17:01 +00:00
* JAX-RS RestEasy (JBoss EAP): @jfiala
2019-01-12 02:57:44 +00:00
* Kotlin: @jimschubert [:heart: ](https://www.patreon.com/jimschubert )
2018-08-29 03:34:58 +00:00
* Kotlin (Spring Boot): @dr4ke616
2019-09-16 14:47:28 +00:00
* Kotlin (Vertx): @Wooyme
Add a new NodeJS Express server generator (#3567)
* create nodejs express esrver
* 1st commit of the express.js module. Express server working, api-docs loads properly. No real paths yet
* 1st commit of the express.js module. Express server working, api-docs loads properly. No real paths yet (#2839)
* Working Express server with successful routing to controllers.
* rewrote controllers and services. Haven't tested yet
* controllers and services have passed tests successfully
* Added documentation
* Added documentation
* Support for openApi v3, using 'express-openapi-validator' for parsing and validation, and an internal router to pass arguments to controllers and services. /controllers/Pet.js and /services/PetService.js should be used for reverse engineering for future codegen script
* update generator and template
* update samples
* more update
* update service, controller
* add vendor extensions
* some updates to adapt to changes in the generator (removing references to swager); some work on handling file uploads; some work on tests
* Update NodeJS server generator and templates based on new output (#3261)
* update generator and template
* update samples
* more update
* update service, controller
* add vendor extensions
* update doc
* Changed routing code to follow the following convention:
Each path operation has a 'x-openapi-router-controller' and 'x-openapi-router-service'. Automated files will be placed under /controllers and /services respectively.
Controller file names will end with 'Controller.js'.
Removed swaggerRouter, replaced it with openapiRouter
Routing works and simple tests show a return of 200 to requests.
* [nodejs-express-server] various updates, fixes (#3319)
* various fix
* remove dot from service
* add space
* better method empty argument
* remove test service (#3379)
* add new doc
* 1. routingTests.js runs through all operations described in openapi.yaml and tries calling them, expecting 200 in return. Currently not all tests pass - not supporting xml, and problems with formData
2. Removed old testing files.
3. Added model files - contain data and structure as defined in openapi.yaml. Model.js has static methods relevant to all model files.
4. Changed openapi.yaml to allow running tests easily.
* 1. routingTests.js runs through all operations described in openapi.yaml and tries calling them, expecting 200 in return. Currently not all tests pass - not supporting xml, and problems with formData (#3442)
2. Removed old testing files.
3. Added model files - contain data and structure as defined in openapi.yaml. Model.js has static methods relevant to all model files.
4. Changed openapi.yaml to allow running tests easily.
* added model classes. Currently as a concept only. Seems like won't be in use
* Updated README.md to be a detailed description of the project.
Removed test files that are not needed.
Removed utils/writer.js which is not needed, and the references to it in the codegen files
* Removed redundant file app.js - this file has no benefit at this point. index.js now calls ExpressServer.js directly. Updated files that used to call app.js. Updated README.md accordingly
Added a path to call the openapi.yaml, and a test file for all endpoints that are not in the openapi.yaml, ensuring that they return 200. Updated README.md accordingly
* Remove test controller (#3575)
* remove test controller
* add back changes to templates
* remove app.js
* update wording
2019-08-08 16:30:47 +00:00
* NodeJS Express: @YishTish
2018-08-02 14:39:37 +00:00
* PHP Laravel: @renepardon
2017-09-21 03:07:43 +00:00
* PHP Lumen: @abcsun
2016-05-08 10:48:22 +00:00
* PHP Slim: @jfastnacht
2017-07-05 08:58:21 +00:00
* PHP Symfony: @ksm2
2017-01-16 08:16:14 +00:00
* PHP Zend Expressive (with Path Handler): @Articus
2019-01-14 15:47:59 +00:00
* Python AIOHTTP: @Jyhess
2016-11-29 09:12:23 +00:00
* Ruby on Rails 5: @zlx
2017-10-19 09:37:02 +00:00
* Rust (rust-server): @metaswitch
2019-01-12 02:57:44 +00:00
* Scala Finch: @jimschubert [:heart: ](https://www.patreon.com/jimschubert )
2017-11-21 08:37:42 +00:00
* Scala Lagom: @gmkumar2005
2019-03-27 01:47:47 +00:00
* Scala Play: @adigerber
2016-08-01 08:17:24 +00:00
* Documentation
2019-09-14 12:32:34 +00:00
* AsciiDoc: @man -at-home
2016-08-01 08:17:24 +00:00
* HTML Doc 2: @jhitchcock
2016-08-01 09:35:05 +00:00
* Confluence Wiki: @jhitchcock
2017-06-28 10:05:53 +00:00
* Configuration
* Apache2: @stkrwork
2018-10-01 11:46:33 +00:00
* Schema
2019-08-22 08:06:04 +00:00
* Avro: @sgadouar
2019-01-12 02:57:44 +00:00
* GraphQL: @wing328 [:heart: ](https://www.patreon.com/wing328 )
2018-10-01 11:46:33 +00:00
* MySQL: @ybelenko
2019-09-10 09:32:25 +00:00
* Protocol Buffer: @wing328
2016-05-08 10:48:22 +00:00
2019-01-12 02:57:44 +00:00
:heart: = Link to support the contributor directly
2018-05-12 13:41:09 +00:00
#### How to join the core team
2016-05-08 16:30:55 +00:00
Here are the requirements to become a core team member:
2018-04-22 13:34:55 +00:00
- rank within top 50 in https://github.com/openapitools/openapi-generator/graphs/contributors
- to contribute, here are some good [starting points ](https://github.com/openapitools/openapi-generator/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22 )
2016-05-08 16:30:55 +00:00
- regular contributions to the project
- about 3 hours per week
- for contribution, it can be addressing issues, reviewing PRs submitted by others, submitting PR to fix bugs or make enhancements, etc
2018-05-13 04:27:27 +00:00
- must be active in the past 3 months at the time of application
2016-05-08 16:30:55 +00:00
2018-05-13 04:27:27 +00:00
To join the core team, please reach out to team@openapitools.org for more information.
2016-11-29 09:12:23 +00:00
2016-05-08 16:30:55 +00:00
To become a Template Creator, simply submit a PR for new API client (e.g. Rust, Elixir) or server stub (e.g. Ruby Grape) generator.
2018-05-12 13:54:47 +00:00
### [6.2 - OpenAPI Generator Technical Committee](#table-of-contents)
2016-11-30 09:43:58 +00:00
2018-04-22 13:34:55 +00:00
Members of the OpenAPI Generator technical committee shoulder the following responsibilities:
2016-11-30 09:43:58 +00:00
2017-08-28 17:31:22 +00:00
- Provides guidance and direction to other users
- Reviews pull requests and issues
- Improves the generator by making enhancements, fixing bugs or updating documentations
- Sets the technical direction of the generator
2016-11-30 09:43:58 +00:00
2017-08-28 17:31:22 +00:00
Who is eligible? Those who want to join must have at least 3 PRs merged into a generator. (Exceptions can be granted to template creators or contributors who have made a lot of code changes with less than 3 merged PRs)
2016-11-30 09:43:58 +00:00
2018-05-13 04:27:27 +00:00
If you want to join the committee, please kindly apply by sending an email to team@openapitools.org with your Github ID.
2017-08-28 17:31:22 +00:00
2018-05-12 13:41:09 +00:00
#### Members of Technical Committee
2017-08-28 17:31:22 +00:00
2018-07-05 03:33:14 +00:00
| Languages | Member (join date) |
2017-08-28 17:31:22 +00:00
|:-------------|:-------------|
| ActionScript | |
2018-07-05 03:33:14 +00:00
| Ada | @stcarrez (2018/02) @micheleISEP (2018/02) |
| Android | @jaz -ah (2017/09) |
| Apex | |
| Bash | @frol (2017/07) @bkryza (2017/08) @kenjones -cisco (2017/09) |
2018-11-17 10:42:40 +00:00
| C | @zhemant (2018/11) |
2019-08-15 10:33:17 +00:00
| C++ | @ravinikam (2017/07) @stkrwork (2017/07) @etherealjoy (2018/02) @martindelille (2018/03) @muttleyxd (2019/08) |
2019-01-12 02:57:44 +00:00
| C# | @mandrean (2017/08), @jimschubert (2017/09) [:heart: ](https://www.patreon.com/jimschubert ) |
2017-08-28 17:31:22 +00:00
| Clojure | |
2019-09-04 14:18:31 +00:00
| Dart | @ircecho (2017/07) @swipesight (2018/09) @jaumard (2018/09) @nickmeinhold (2019/09) |
2017-09-29 01:47:03 +00:00
| Eiffel | @jvelilla (2017/09) |
2019-01-05 11:18:49 +00:00
| Elixir | @mrmstn (2018/12) |
2019-01-04 03:49:50 +00:00
| Elm | @eriktim (2018/09) |
2018-10-30 16:09:30 +00:00
| Erlang | @tsloughter (2017/11) @jfacorro (2018/10) @robertoaloi (2018/10) |
2019-05-06 14:11:50 +00:00
| F# | @nmfisher (2019/05) |
2019-07-25 07:35:55 +00:00
| Go | @antihax (2017/11) @bvwells (2017/12) @grokify (2018/07) @kemokemo (2018/09) @bkabrda (2019/07) |
2018-12-06 02:37:46 +00:00
| GraphQL | @renepardon (2018/12) |
2018-07-05 03:33:14 +00:00
| Groovy | |
| Haskell | |
2019-04-09 09:23:46 +00:00
| Java | @bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) |
| Kotlin | @jimschubert (2017/09) [:heart: ](https://www.patreon.com/jimschubert ), @dr4ke616 (2018/08) @karismann (2019/03) @Zomzog (2019/04) |
2018-07-05 03:33:14 +00:00
| Lua | @daurnimator (2017/08) |
Add Nim client code generator (#3879)
* First version of Nim Client
* Add some codes
* Add some codes
* Add some codes
* Add some codes
* Add some codes
* First version of Nim Client
* Add some codes
* Add some codes
* [Dart] Fix README template and update testing doco (#3809)
* [Dart] Fix README template and update testing doco
- deleted redundant shell script
- fixed and updated README template
- updated test package and moved to a dev_dependency
- removed old unused dev_dependency packages
- updated testing documentation in petstore sample
* Remove references to dart-flutter-petstore.sh
* Fix typos
* Fix typo
* Support custom git repository (#3757)
* add gitHost param to GeneratorSettings and related
* parameterize gitHost in READMEs
* parameterize gitHost in go.mod
* parameterize gitHost in git_push
* update petstore samples
* run ./bin/utils/export_docs_generators.sh
* run meta-codehen.sh
* Revert "run meta-codehen.sh"
This reverts commit d6d579f6159186531257cdfdd73b9caf9e9ffeba.
* Revert "run ./bin/utils/export_docs_generators.sh"
This reverts commit 1b81538198d4319fd1b4e97447303e3cc0e8dc99.
* Revert "update petstore samples"
This reverts commit f513add88396707f6991ae2e4920359583ec88f1.
* run ensure-up-to-date
* Add links to article and video (#3820)
* Better Go code format (#3819)
* better varible naming
* better comments
* better code format for go experimental client
* better comment, update samples
* Add some codes
* Add some codes
* Add some codes
* Add gRPC Protobuf schema generator (#3818)
* add grpc protobuf generator
* update doc
* add new doc
* add windows batch, comment out root proto
* 1792 fix remote spec handling and hash calculation (#3440)
* fixed bug where nullApi.java would be generated. Instead, generated DefaultApi.java to match the default path /{pathParam} (#3821)
* Revert "1792 fix remote spec handling and hash calculation (#3440)"
This reverts commit 2a2eefe93d81b8d253745b8adb002ab2cb9eee04.
* Add nickmeinhold to Dart technical committee (#3830)
* Bug #2845 typescript angular inheritance (#3812)
* issue #2845: enable 'supportsMultipleInheritance' on typescript angular client codegen
- note I reran ./bin/openapi3/typescript-angular-petstore-all.sh and no changes occurred.
this suggests to me that the petstore.yaml sample should be improved to make use of the
anyOf / allOf / oneOf keywords, in order to better show the effects of changes on generated code.
* issue #2845: run ./bin/openapi3/typescript-angular-petstore-all.sh
* run `mvn clean package && ./bin/typescript-angular-petstore-all.sh`
* revert extranous files
* fix warnings in csharp-netcore client (#3831)
* Add missing files to the form request (#3834)
* [client][go] avoid duplicated reflect imports (#3847)
* Following up for #3440 (1792 fix remote spec handling and hash calculation) (#3826)
* This patch fixes the bug that we cannot access to remote files when checking file updates.
Following up #3440, supporting auth.
* 1792 fix remote spec handling and hash calculation (#3440)
(cherry picked from commit 2a2eefe93d81b8d253745b8adb002ab2cb9eee04)
* fix detecting remote file / local file logic while finding the hash file, taking care of IllegalArgumentException for local files.
* add testcase
* Add a link (#3850)
* Add Element AI to the list (#3856)
* maven-plugin-plugin 3.6.0 (#3854)
* [Java][okhttp-gson] fix failure to deserialize floats (#3846)
* fixed bug where nullApi.java would be generated. Instead, generated DefaultApi.java to match the default path /{pathParam}
* fix to bug #3157
* update samples
* Adds Http Info To Dart Api (#3851)
* [C++][Pistache] Add missing setter for arrays (#3837)
* [C++][Pistache] Add missing setter for arrays
Fixes #3769
* [C++][Pistache] Update Petstore sample
* typescript-inversify: improve check for required parameters, support multiple media types (#3849)
* [typescript-inversify] Allow falsy parameters
A required parameter to an api method must not be `null` or `undefined`.
It can be any other falsy value, e.g. `""`, `0` or `false` though. This
change makes sure an error is only thrown in the former case and not in
the latter.
* [typescript-inversify] Handle multiple media types
The Accept and Content-Type HTTP headers can contain a list of media
types. Previously all but the first media type in the api definition
were ignored. Now the headers are properly generated.
* [typescript-inversify] Fix http client interface
The api service methods allow the `body` parameter to be optional. The
parameter is then passed to an `IHttpClient`. So it needs to be optional
there as well.
Also fixed the sample implementation `HttpClient`.
Fixes #3618.
* [typescript-inversify] Regenerate Petstore sample
* [typescript-inversify] Use more explicit null check
This does not change the semantic of the generated code, but makes it more explicit.
Co-Authored-By: Esteban Gehring <esteban.gehring@gmail.com>
* [typescript-angular] allow empty string basePath (#3489)
* [typescript-angular] Fixing #2731 - empty string basePath
* typescript-angular: refactor base path configuration
* typescript-angular: refactor base path configuration
* Fix/r/serialization fix and minor 3xx resp fix (#3817)
* fix(qlik): fix for minor serialization bug
* fix(r): add petsore generated classes
* fix(r): indendation fixes
* typescript-axios: Fix baseoptions (#3866)
* Fixed missing baseOptions of typescript-axios.
The typescript-axios template was missing the baseOptions setting when building an API Configuration. Set it.
* update sample.
* re-generate typescript axios samples
* Rename gRPC generator to "protobuf-schema" (#3864)
* rename grpc generator to protobuf-schema
* update doc
* Prepare v4.1.2 release (#3873)
* update samples
* update date
* fix version in readme
* BugFix #2053 Spring Boot fails to parse LocalDate query parameter (#3860)
Adds the format annotation so that Spring is able to serialize OpenApi date/date-time format into LocalDate/OffsetDateTime.
* update doc, samples (#3875)
* update stable release
* Update the batch for Windows
* Add a test snippet
* Update ensure-up-to-date
* Add Nim to README.md
* Ran ensure-up-to-date to pass CircleCI tests
2019-09-13 07:56:54 +00:00
| Nim | |
2017-08-28 17:56:59 +00:00
| NodeJS/Javascript | @CodeNinjai (2017/07) @frol (2017/07) @cliffano (2017/07) |
2017-08-28 17:31:22 +00:00
| ObjC | |
2019-08-02 06:15:49 +00:00
| OCaml | @cgensoul (2019/08) |
2019-06-21 13:52:35 +00:00
| Perl | @wing328 (2017/07) [:heart: ](https://www.patreon.com/wing328 ) @yue9944882 (2019/06) |
2019-01-12 02:57:44 +00:00
| PHP | @jebentier (2017/07), @dkarlovi (2017/07), @mandrean (2017/08), @jfastnacht (2017/09), @ackintosh (2017/09) [:heart: ](https://www.patreon.com/ackintosh/overview ), @ybelenko (2018/07), @renepardon (2018/12) |
2018-07-05 03:33:14 +00:00
| PowerShell | |
2019-01-17 14:09:39 +00:00
| Python | @taxpon (2017/07) @frol (2017/07) @mbohlool (2017/07) @cbornet (2017/09) @kenjones -cisco (2017/11) @tomplus (2018/10) @Jyhess (2019/01) |
2019-07-05 07:49:19 +00:00
| R | @Ramanth (2019/07) @saigiridhar21 (2019/07) |
2019-02-10 03:34:46 +00:00
| Ruby | @cliffano (2017/07) @zlx (2017/09) @autopp (2019/02) |
2019-07-31 11:50:51 +00:00
| Rust | @frol (2017/07) @farcaller (2017/08) @bjgill (2017/12) @richardwhiuk (2019/07) |
2019-01-12 02:57:44 +00:00
| Scala | @clasnake (2017/07), @jimschubert (2017/09) [:heart: ](https://www.patreon.com/jimschubert ), @shijinkui (2018/01), @ramzimaalej (2018/03) |
2018-04-17 07:19:10 +00:00
| Swift | @jgavris (2017/07) @ehyche (2017/08) @Edubits (2017/09) @jaz -ah (2017/09) @d -date (2018/03) |
2019-07-09 07:37:04 +00:00
| TypeScript | @TiFu (2017/07) @taxpon (2017/07) @sebastianhaas (2017/07) @kenisteward (2017/07) @Vrolijkx (2017/09) @macjohnny (2018/01) @nicokoenig (2018/09) @topce (2018/10) @akehir (2019/07) |
2016-12-09 07:18:55 +00:00
2019-01-12 02:57:44 +00:00
:heart: = Link to support the contributor directly
2018-05-12 13:54:47 +00:00
### [6.3 - History of OpenAPI Generator](#table-of-contents)
2018-04-22 13:34:55 +00:00
2018-05-11 05:28:17 +00:00
OpenAPI Generator is a fork of [Swagger Codegen ](https://github.com/swagger-api/swagger-codegen ). In view of the issues with the Swagger Codegen 3.0.0 (beta) release and the disagreement on the project's direction, more than 40 top contributors and template creators of Swagger Codegen decided to fork Swagger Codegen and maintain a community-driven version called "OpenAPI Generator". Please refer to the [Q&A ](docs/qna.md ) for more information.
2018-04-22 13:34:55 +00:00
2018-05-12 13:41:09 +00:00
#### Founding Members (alphabetical order):
2018-04-22 13:34:55 +00:00
- [Akihito Nakano ](https://github.com/ackintosh )
- [Artem Ocheredko ](https://github.com/galaxie )
2018-05-07 02:22:08 +00:00
- [Arthur Mogliev ](https://github.com/Articus )
2018-04-22 13:34:55 +00:00
- [Bartek Kryza ](https://github.com/bkryza )
- [Ben Wells ](https://github.com/bvwells )
- [Benjamin Gill ](https://github.com/bjgill )
- [Christophe Bornet ](https://github.com/cbornet )
- [Cliffano Subagio ](https://github.com/cliffano )
- [Daiki Matsudate ](https://github.com/d-date )
- [Daniel ](https://github.com/Danielku15 )
2018-05-03 01:46:14 +00:00
- [Emiliano Bonassi ](https://github.com/emilianobonassi )
2019-01-04 03:49:50 +00:00
- [Erik Timmers ](https://github.com/eriktim )
2018-04-22 13:34:55 +00:00
- [Esteban Marin ](https://github.com/macjohnny )
2018-05-15 14:16:49 +00:00
- [Gustavo Paz ](https://github.com/gustavoapaz )
2018-04-22 13:34:55 +00:00
- [Javier Velilla ](https://github.com/jvelilla )
- [Jean-François Côté ](https://github.com/JFCote )
- [Jim Schubert ](https://github.com/jimschubert )
- [Jon Schoning ](https://github.com/jonschoning )
2019-06-09 03:48:13 +00:00
- [Jérémie Bresson ](https://github.com/jmini ) [:heart: ](https://www.patreon.com/jmini )
2018-04-22 13:34:55 +00:00
- [Jörn Ahrens ](https://github.com/jayearn )
2018-05-26 14:07:35 +00:00
- [Keni Steward ](https://github.com/kenisteward )
2018-04-22 13:34:55 +00:00
- [Marcin Stefaniuk ](https://github.com/mstefaniuk )
- [Martin Delille ](https://github.com/MartinDelille )
- [Masahiro Yamauchi ](https://github.com/algas )
2018-05-04 15:21:56 +00:00
- [Michele Albano ](https://github.com/micheleISEP )
2018-04-22 13:34:55 +00:00
- [Ramzi Maalej ](https://github.com/ramzimaalej )
- [Ravindra Nikam ](https://github.com/ravinikam )
2018-05-15 14:44:36 +00:00
- [Ricardo Cardona ](https://github.com/ricardona )
2018-04-22 13:34:55 +00:00
- [Sebastian Haas ](https://github.com/sebastianhaas )
2018-05-14 08:55:31 +00:00
- [Sebastian Mandrean ](https://github.com/mandrean )
2018-04-22 13:34:55 +00:00
- [Sreenidhi Sreesha ](https://github.com/sreeshas )
2018-05-09 01:54:18 +00:00
- [Stefan Krismann ](https://github.com/stkrwork )
2018-05-14 08:55:31 +00:00
- [Stephane Carrez ](https://github.com/stcarrez )
2018-04-22 13:34:55 +00:00
- [Takuro Wada ](https://github.com/taxpon )
- [Tomasz Prus ](https://github.com/tomplus )
- [Tristan Sloughter ](https://github.com/tsloughter )
2018-05-02 13:32:11 +00:00
- [Victor Orlovsky ](https://github.com/viclovsky )
2018-04-22 13:34:55 +00:00
- [Victor Trakhtenberg ](https://github.com/victorgit )
- [Vlad Frolov ](https://github.com/frol )
- [Vladimir Pouzanov ](https://github.com/farcaller )
2018-05-14 08:55:31 +00:00
- [William Cheng ](https://github.com/wing328 )
2019-01-14 14:13:36 +00:00
- [Xin Meng ](https://github.com/xmeng1 ) [:heart: ](https://www.patreon.com/user/overview?u=16435385 )
2018-04-22 13:34:55 +00:00
- [Xu Hui Hui ](https://github.com/xhh )
- [antihax ](https://github.com/antihax )
- [beatcracker ](https://github.com/beatcracker )
- [daurnimator ](https:/github.com/daurnimator )
- [etherealjoy ](https://github.com/etherealjoy )
- [jfiala ](https://github.com/jfiala )
- [lukoyanov ](https://github.com/lukoyanov )
2016-12-09 07:18:55 +00:00
2019-01-14 14:13:36 +00:00
:heart: = Link to support the contributor directly
2016-11-04 22:16:04 +00:00
2018-05-12 13:54:47 +00:00
## [7 - License](#table-of-contents)
2014-09-22 23:44:01 +00:00
-------
2018-05-11 05:28:17 +00:00
Copyright 2018 OpenAPI-Generator Contributors (https://openapi-generator.tech)
2018-01-04 13:56:20 +00:00
Copyright 2018 SmartBear Software
2014-09-22 23:44:01 +00:00
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
2019-07-24 04:48:17 +00:00
You may obtain a copy of the License at [apache.org/licenses/LICENSE-2.0 ](https://www.apache.org/licenses/LICENSE-2.0 )
2014-09-22 23:44:01 +00:00
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
2016-02-12 20:23:27 +00:00
---