OpenAPI Generator

Master (5.0.0):

⭐⭐⭐ If you would like to contribute, please refer to guidelines and a list of open tasks.⭐⭐⭐

‼️ To migrate from Swagger Codegen to OpenAPI Generator, please refer to the migration guide ‼️

📔 For more information, please refer to the Wiki page and FAQ 📔

📔 The eBook A Beginner's Guide to Code Generation for REST APIs is a good starting point for beginners 📔

⚠️ 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) ⚠️

‼️ Both "OpenAPI Tools" (https://OpenAPITools.org - the parent organization of OpenAPI Generator) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI) ‼️

Sponsors

If you find OpenAPI Generator useful for work, please consider asking your company to support this Open Source project by becoming a sponsor. You can also individually sponsor the project by becoming a backer.

Thank you to our bronze sponsors!

Thank you GoDaddy for sponsoring the domain names, Linode for sponsoring the VPS and Checkly for sponsoring the API monitoring

Overview

OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec (both 2.0 and 3.0 are supported). Currently, the following languages/frameworks are supported:

	Languages/Frameworks
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, MicroProfile Rest Client), k6, Kotlin, Lua, Nim, Node.js/JavaScript (ES5, ES6, AngularJS with Google Closure Compiler annotations, Flow types, Apollo GraphQL DataStore), Objective-C, OCaml, Perl, PHP, PowerShell, Python, R, Ruby, Rust (rust, rust-server), Scala (akka, http4s, scalaz, sttp, swagger-async-httpclient), Swift (2.x, 3.x, 4.x, 5.x), Typescript (AngularJS, Angular (2.x - 8.x), Aurelia, Axios, Fetch, Inversify, jQuery, Node, Rxjs)
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, Vert.x), Kotlin (Spring Boot, Ktor, Vertx), PHP (Laravel, Lumen, Slim, Silex, Symfony, Zend Expressive), Python (Flask), NodeJS, Ruby (Sinatra, Rails5), Rust (rust-server), Scala (Akka, Finch, Lagom, Play, Scalatra)
API documentation generators	HTML, Confluence Wiki, Asciidoc
Configuration files	Apache2
Others	GraphQL, JMeter, MySQL Schema, Protocol Buffer

Table of contents

• OpenAPI Generator
• Overview
• Table of Contents
• 1 - Installation
  • 1.1 - Compatibility
  • 1.2 - Artifacts on Maven Central
  • 1.3 - Download JAR
  • 1.4 - Build Projects
  • 1.5 - Homebrew
  • 1.6 - Docker
  • 1.7 - NPM
• 2 - Getting Started
• 3 - Usage
  • 3.1 - Customization
  • 3.2 - Workflow Integration
  • 3.3 - Online Generators
  • 3.4 - License Information on Generated Code
  • 3.5 - IDE Integration
• 4 - Companies/Projects using OpenAPI Generator
• 5 - Presentations/Videos/Tutorials/Books
• 6 - About Us
  • 6.1 - OpenAPI Generator Core Team
  • 6.2 - OpenAPI Generator Technical Committee
  • 6.3 - History of OpenAPI Generator
• 7 - License

1 - Installation

1.1 - Compatibility

The OpenAPI Specification has undergone 3 revisions since initial creation in 2010. The openapi-generator project has the following compatibilities with the OpenAPI Specification:

OpenAPI Generator Version	Release Date	Notes
5.0.0 (upcoming major release) SNAPSHOT	17.06.2020	Major release with breaking changes (no fallback)
4.3.1 (latest stable release)	06.05.2020	Patch release (enhancements, bug fixes, etc)

OpenAPI Spec compatibility: 1.0, 1.1, 1.2, 2.0, 3.0

For old releases, please refer to the Release page.

1.2 - Artifacts on Maven Central

You can find our released artifacts on maven central:

Core:

<dependency>
    <groupId>org.openapitools</groupId>
    <artifactId>openapi-generator</artifactId>
    <version>${openapi-generator-version}</version>
</dependency>

See the different versions of the openapi-generator artifact available on maven central.

Cli:

<dependency>
    <groupId>org.openapitools</groupId>
    <artifactId>openapi-generator-cli</artifactId>
    <version>${openapi-generator-version}</version>
</dependency>

See the different versions of the openapi-generator-cli artifact available on maven central.

Maven plugin:

<dependency>
    <groupId>org.openapitools</groupId>
    <artifactId>openapi-generator-maven-plugin</artifactId>
    <version>${openapi-generator-version}</version>
</dependency>

• See the different versions of the openapi-generator-maven-plugin artifact available on maven central.
• Readme

Gradle plugin:

<dependency>
    <groupId>org.openapitools</groupId>
    <artifactId>openapi-generator-gradle-plugin</artifactId>
    <version>${openapi-generator-version}</version>
</dependency>

• See the different versions of the openapi-generator-gradle-plugin artifact available on maven central.
• Readme

1.3 - Download JAR

If you're looking for the latest stable version, you can grab it directly from Maven.org (Java 8 runtime at a minimum):

JAR location: https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/4.3.1/openapi-generator-cli-4.3.1.jar

For Mac/Linux users:

wget https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/4.3.1/openapi-generator-cli-4.3.1.jar -O openapi-generator-cli.jar

For Windows users, you will need to install wget or you can use Invoke-WebRequest in PowerShell (3.0+), e.g.

Invoke-WebRequest -OutFile openapi-generator-cli.jar https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/4.3.1/openapi-generator-cli-4.3.1.jar

After downloading the JAR, run java -jar openapi-generator-cli.jar help to show the usage.

For Mac users, please make sure Java 8 is installed (Tips: run java -version to check the version), and export JAVA_HOME in order to use the supported Java version:

export JAVA_HOME=`/usr/libexec/java_home -v 1.8`
export PATH=${JAVA_HOME}/bin:$PATH

Launcher Script

One downside to manual jar downloads is that you don't keep up-to-date with the latest released version. We have a Bash launcher script at bin/utils/openapi-generator.cli.sh which resolves this issue.

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
curl https://raw.githubusercontent.com/OpenAPITools/openapi-generator/master/bin/utils/openapi-generator-cli.sh > ~/bin/openapitools/openapi-generator-cli
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

1.4 - Build Projects

To build from source, you need the following installed and available in your $PATH:

• Java 8

• Apache Maven 3.3.4 or greater

After cloning the project, you can build it from source with this command:

mvn clean install

If you don't have maven installed, you may directly use the included maven wrapper, and build with the command:

./mvnw clean install

The default build contains minimal static analysis (via CheckStyle). To run your build with PMD and Spotbugs, use the static-analysis profile:

mvn -Pstatic-analysis clean install

1.5 - Homebrew

To install, run brew install openapi-generator

Here is an example usage to generate a Ruby client:

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/

To reinstall with the latest master, run brew uninstall openapi-generator && brew install --HEAD openapi-generator

To install OpenJDK (pre-requisites), please run

brew tap AdoptOpenJDK/openjdk
brew cask install adoptopenjdk12
export JAVA_HOME=/Library/Java/JavaVirtualMachines/jdk-12.0.2.jdk/Contents/Home/

To install Maven, please run

brew install maven

1.6 - Docker

Public Pre-built Docker images

• https://hub.docker.com/r/openapitools/openapi-generator-cli/ (official CLI)
• https://hub.docker.com/r/openapitools/openapi-generator-online/ (official web service)

OpenAPI Generator CLI Docker Image

The OpenAPI Generator image acts as a standalone executable. It can be used as an alternative to installing via homebrew, or for developers who are unable to install Java or upgrade the installed version.

To generate code with this image, you'll need to mount a local location as a volume.

Example:

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 \
    -g go \
    -o /local/out/go

The generated code will be located under ./out/go in the current directory.

OpenAPI Generator Online Docker Image

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.

Example usage:

# Start container at port 8888 and save the container id
> CID=$(docker run -d -p 8888:8080 openapitools/openapi-generator-online)

# allow for startup
> sleep 10

# Get the IP of the running container (optional)
GEN_IP=$(docker inspect --format '{{.NetworkSettings.IPAddress}}'  $CID)

# Execute an HTTP request to generate a Ruby client
> curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' \
-d '{"openAPIUrl": "https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/2_0/petstore.yaml"}' \
'http://localhost:8888/api/gen/clients/ruby'

{"code":"c2d483.3.4672-40e9-91df-b9ffd18d22b8","link":"http://localhost:8888/api/gen/download/c2d483.3.4672-40e9-91df-b9ffd18d22b8"}

# Download the generated zip file  
> wget http://localhost:8888/api/gen/download/c2d483.3.4672-40e9-91df-b9ffd18d22b8

# Unzip the file
> unzip c2d483.3.4672-40e9-91df-b9ffd18d22b8

# Shutdown the openapi generator image
> docker stop $CID && docker rm $CID

Development in docker

You can use run-in-docker.sh to do all development. This script maps your local repository to /gen in the docker container. It also maps ~/.m2/repository to the appropriate container location.

To execute mvn package:

git clone https://github.com/openapitools/openapi-generator
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:

./run-in-docker.sh help # Executes 'help' command for openapi-generator-cli
./run-in-docker.sh list # Executes 'list' command for openapi-generator-cli
./run-in-docker.sh /gen/bin/go-petstore.sh  # Builds the Go client
./run-in-docker.sh generate -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml \
    -g go -o /gen/out/go-petstore -DpackageName=petstore # generates go client, outputs locally to ./out/go-petstore

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

./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 :|

Run Docker in Vagrant

Prerequisite: install Vagrant and VirtualBox.

git clone https://github.com/openapitools/openapi-generator.git
cd openapi-generator
vagrant up
vagrant ssh
cd /vagrant
./run-in-docker.sh mvn package

1.7 - NPM

There is also an NPM package wrapper available for different platforms (e.g. Linux, Mac, Windows). (JVM is still required) Please see the project's README there for more information.

Install it globally to get the CLI available on the command line:

npm install @openapitools/openapi-generator-cli -g
openapi-generator version

Or install a particular OpenAPI Generator version (e.g. v4.3.1):

npm install @openapitools/openapi-generator-cli@cli-4.3.1 -g

Or install it as dev-dependency:

npm install @openapitools/openapi-generator-cli -D

2 - Getting Started

To generate a PHP client for petstore.yaml, please run the following

git clone https://github.com/openapitools/openapi-generator
cd openapi-generator
mvn clean package
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 /var/tmp/php_api_client

(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)

You can also download the JAR (latest release) directly from maven.org

To get a list of general options available, please run java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar help generate

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

3 - Usage

To generate a sample client library

You can build a client against the Petstore API as follows:

./bin/java-petstore-okhttp-gson.sh

(On Windows, run .\bin\windows\java-petstore-okhttp-gson.bat instead)

This script uses the default library, which is okhttp-gson. It will run the generator with this command:

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 java \
  -o samples/client/petstore/java/okhttp-gson

with a number of options. The java options are documented here.

You can also get the options with the help generate command (below only shows partial results):

NAME
        openapi-generator-cli generate - Generate code with the specified
        generator.

SYNOPSIS
        openapi-generator-cli generate
                [(-a <authorization> | --auth <authorization>)]
                [--api-name-suffix <api name suffix>]
                [--api-package <api package>] [--artifact-id <artifact id>]
                [--artifact-version <artifact version>]
                [(-c <configuration file> | --config <configuration file>)]
                [-D <system properties>...]
                [(-e <templating engine> | --engine <templating engine>)]
                [--enable-post-process-file]
                [(-g <generator name> | --generator-name <generator name>)]
                [--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>]
                (-i <spec file> | --input-spec <spec file>)
                [--ignore-file-override <ignore file override location>]
                [--import-mappings <import mappings>...]
                [--instantiation-types <instantiation types>...]
                [--invoker-package <invoker package>]
                [--language-specific-primitives <language specific primitives>...]
                [--library <library>] [--log-to-stderr] [--minimal-update]
                [--model-name-prefix <model name prefix>]
                [--model-name-suffix <model name suffix>]
                [--model-package <model package>]
                [(-o <output directory> | --output <output directory>)]
                [(-p <additional properties> | --additional-properties <additional properties>)...]
                [--package-name <package name>] [--release-note <release note>]
                [--remove-operation-id-prefix]
                [--reserved-words-mappings <reserved word mappings>...]
                [(-s | --skip-overwrite)] [--server-variables <server variables>...]
                [--skip-validate-spec] [--strict-spec <true/false strict behavior>]
                [(-t <template directory> | --template-dir <template directory>)]
                [--type-mappings <type mappings>...] [(-v | --verbose)]

OPTIONS
        -a <authorization>, --auth <authorization>
            adds authorization headers when fetching the OpenAPI definitions
            remotely. Pass in a URL-encoded string of name:header with a comma
            separating multiple values

...... (results omitted)

        -v, --verbose
            verbose mode

You can then compile and run the client, as well as unit tests against it:

cd samples/client/petstore/java/okhttp-gson
mvn package

Other languages have petstore samples, too:

./bin/android-petstore-all.sh
./bin/java-petstore-all.sh
./bin/objc-petstore.sh

... and others. Here is a list of all scripts.

3.1 - Customization

Please refer to customization.md on how to customize the output (e.g. package name, version)

3.2 - Workflow Integration (Maven, Gradle, Github, CI/CD)

Please refer to integration.md on how to integrate OpenAPI generator with Maven, Gradle, sbt, Bazel, Github and CI/CD.

3.3 - Online OpenAPI generator

Here are the public online services:

• latest stable version: https://api.openapi-generator.tech
• latest master: https://api-latest-master.openapi-generator.tech (updated with latest master every hour)

The server is sponsored by Linode

(These services are beta and do not have any guarantee on service level)

Please refer to online.md on how to run and use the openapi-generator-online - a web service for openapi-generator.

3.4 - License information on Generated Code

The OpenAPI Generator project is intended as a benefit for users of the Open API Specification. The project itself has the License as specified. In addition, please understand the following points:

• The templates included with this project are subject to the License.
• Generated code is intentionally not subject to the parent project license

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.

3.5 - IDE Integration

Here is a list of community-conitributed IDE plug-ins that integrate with OpenAPI Generator:

• Eclipse: Codewind OpenAPI Tools for Eclipse by IBM
• IntelliJ IDEA: OpenAPI Generator by Jim Schubert
• IntelliJ IDEA: Senya Editor by senya.io
• RepreZen API Studio
• Visual Studio: REST API Client Code Generator by Christian Resma Helle
• Visual Studio Code: Codewind OpenAPI Tools by IBM

4 - Companies/Projects using OpenAPI Generator

Here are some companies/projects (alphabetical order) using OpenAPI Generator in production. To add your company/project to the list, please visit README.md and click on the icon to edit the page.

• Adaptant Solutions AG
• Agoda
• Allianz
• Angular.Schule
• Australia and New Zealand Banking Group (ANZ)
• ASKUL
• Arduino
• b<>com
• Banzai Cloud
• BIMData.io
• Bithost GmbH
• Bosch Connected Industry
• Boxever
• California State University, Northridge
• CAM
• Camptocamp
• Cisco
• codecentric AG
• Commencis
• Crossover Health
• Cupix
• Datadog
• DB Systel
• DocSpring
• dwango
• Edge Impulse
• Element AI
• Embotics
• emineo
• Fenergo
• freee
• FreshCells
• Fuse
• Gantner
• GenFlow
• GetYourGuide
• GMO Pepabo
• GoDaddy
• Here
• IBM
• Instana
• JustStar
• k6.io
• Klarna
• Kronsoft Development
• Kubernetes
• Linode
• Logicdrop
• MailSlurp
• Médiavision
• Metaswitch
• MoonVision
• Myworkout
• NamSor
• Openet
• openVALIDATION
• Oracle
• Paxos
• Ponicode
• Pricefx
• Prometheus/Alertmanager
• QEDIT
• Qulix Systems
• Raiffeisen Schweiz Genossenschaft
• RedHat
• RepreZen API Studio
• REST United
• Robotinfra
• Sony Interactive Entertainment
• Stingray
• Suva
• Telstra
• TravelTime platform
• TUI InfoTec GmbH
• unblu inc.
• Veamly
• Woleet
• WSO2
• Vouchery.io
• Xero
• Yahoo Japan
• Vonage
• YITU Technology
• Yelp
• Zalando

5 - Presentations/Videos/Tutorials/Books

• 2018/05/12 - OpenAPI Generator - community drivenで成長するコードジェネレータ by 中野暁人
• 2018/05/15 - Starting a new open-source project by Jeremie Bresson
• 2018/05/15 - REST API仕様からAPIクライアントやスタブサーバを自動生成する「OpenAPI Generator」オープンソースで公開。Swagger Codegenからのフォーク by Publickey
• 2018/06/08 - Swagger Codegen is now OpenAPI Generator by JohannesHoppe
• 2018/06/21 - Connect your JHipster apps to the world of APIs with OpenAPI and gRPC by Christophe Bornet at JHipster Conf 2018
• 2018/06/22 - OpenAPI Generator で Gatling Client を生成してみた at ソモサン
• 2018/06/27 - Lessons Learned from Leading an Open-Source Project Supporting 30+ Programming Languages - William Cheng at LinuxCon + ContainerCon + CloudOpen China 2018
• 2018/07/19 - OpenAPI Generator Contribution Quickstart - RingCentral Go SDK by John Wang
• 2018/08/22 - OpenAPI Generatorのプロジェクト構成などのメモ by Yusuke Iinuma
• 2018/09/12 - RepreZen and OpenAPI 3.0: Now is the Time by Miles Daffin
• 2018/10/31 - A node package wrapper for openapi-generator
• 2018/11/03 - OpenAPI Generator + golang + Flutter でアプリ開発 by Ryuichi Daigo
• 2018/11/15 - 基于openapi3.0的yaml文件生成java代码的一次实践 by 焱魔王
• 2018/11/18 - Generating PHP library code from OpenAPI by Lorna Jane at LORNAJANE Blog
• 2018/11/19 - OpenAPIs are everywhere by Jeremie Bresson (Unblu) at EclipseCon Europe 2018
• 2018/12/09 - openapi-generator をカスタマイズする方法 by @watiko
• 2019/01/03 - Calling a Swagger service from Apex using openapi-generator by Mikkel Flindt Heisterberg
• 2019/01/13 - OpenAPI GeneratorでRESTful APIの定義書から色々自動生成する by @ky_yk_d
• 2019/01/20 - Contract-First API Development with OpenAPI Generator and Connexion by Anil Can Aydin
• 2019/01/30 - Rapid Application Development With API First Approach Using Open-API Generator by Milan Sonkar
• 2019/02/02 - 平静を保ち、コードを生成せよ 〜 OpenAPI Generator誕生の背景と軌跡 〜 by 中野暁人 at Gunma.web #34 スキーマ駆動開発
• 2019/02/20 - An adventure in OpenAPI V3 code generation by Phil Cluff
• 2019/02/26 - Building API Services: A Beginner’s Guide by Ratros Y. in Google Cloud Platofrm Blog
• 2019/02/26 - Building APIs with OpenAPI: Continued by Ratros Y. in Google Cloud Platofrm Blog
• 2019-03-07 - OpenAPI Generator で Spring Boot と Angular をタイプセーフに繋ぐ by Tomofumi Chiba
• 2019-03-16 - A Quick introduction to manual OpenAPI V3 by vados at VADOSWARE
• 2019-03-25 - Access any REST service with the SAP S/4HANA Cloud SDK by Alexander Duemont
• 2019-03-25 - OpenAPI generatorを試してみる by @amuyikam
• 2019-03-27 - OpenAPI3を使ってみよう！Go言語でクライアントとスタブの自動生成まで！ by @gold_kou
• 2019-04-17 - OpenAPIによるスキーマファースト開発の実施サンプルとCloud Runについて by @yukey1031
• 2019-04-18 - How to use OpenAPI3 for API developer (RubyKaigi 2019) by @ota42y at RubyKaigi 2019
• 2019-04-29 - A Beginner's Guide to Code Generation for REST APIs (OpenAPI Generator) by William Cheng
• 2019-05-01 - Design and generate a REST API from Swagger / OpenAPI in Java, Python, C# and more by Simply How
• 2019-05-17 - Generate Spring Boot REST API using Swagger/OpenAPI by Antonie Zafirov
• 2019-05-22 - REST APIs代码生成指南(OpenAPI Generator) by William Cheng, Xin Meng
• 2019-05-24 - REST API 代碼生成指南 (OpenAPI Generator) by William Cheng
• 2019-06-24 - Kubernetes Clients and OpenAPI Generator by William Cheng at Kubernetes Contributor Summits Shanghai 2019
• 2019-06-28 Codewind OpenAPI Tools in Eclipse Marketplace by IBM
• 2019-06-29 Codewind OpenAPI Tools in Visual Studio Marketplace by IBM
• 2019-07-04 - REST API のためのコード生成入門 (OpenAPI Generator) by William Cheng, 中野暁人, 和田拓朗
• 2019-07-08 - OpenAPI Generator にコントリビュートしたら社名が載った話。(CAM) - CAM TECH BLOG by CAM, Inc.
• 2019-07-14 - OpenAPI GeneratorでPythonのクライアントライブラリを作成した by yuji38kwmt
• 2019-07-19 - Developer Experience (DX) for Open-Source Projects: How to Engage Developers and Build a Growing Developer Community by William Cheng, 中野暁人 at Open Source Summit Japan 2019
• 2019-08-14 - Our OpenAPI journey with Standardizing SDKs by Sebastian Burgstaller at Bitmovin
• 2019-08-15 - APIのコードを自動生成させたいだけならgRPCでなくてもよくない? by M3, Inc.
• 2019-08-22 - マイクロサービスにおけるWeb APIスキーマの管理─ GraphQL、gRPC、OpenAPIの特徴と使いどころ by @ota42y
• 2019-08-24 - SwaggerドキュメントからOpenAPI Generatorを使ってモックサーバー作成 by 坂本正義
• 2019-08-29 - OpenAPI初探 by peakxie at 腾讯云社区
• 2019-08-29 - 全面进化：Kubernetes CRD 1.16 GA前瞻 by Min Kim at ServiceMesher Blog
• 2019-09-01 - Creating a PHP-Slim server using OpenAPI (Youtube video) by Daniel Persson
• 2019-09-06 - Vert.x and OpenAPI by Stephan H Wissel at wissel.net blog
• 2019-09-09 - Cloud-native development - Creating RESTful microservices in IBM Cloud Docs
• 2019-09-14 - Generating and Configuring a Mastercard API Client at Mastercard Developers Platform
• 2019-09-15 - OpenAPI(Swagger)導入下調べ by Shoichi Kuraoka
• 2019-09-17 - Tutorial: Documenting http4k APIs with OpenApi3 by http4k
• 2019-09-22 - OpenAPI 3を完全に理解できる本 by @ota42y
• 2019-09-22 - RESTful APIs: Tutorial of OpenAPI Specification by Amir Lavasani
• 2019-09-22 - Redefining SDKs as software diversity kits by Sid Maestre (Xero) at DevRelCon San Francisco 2019
• 2019-09-23 - swaggerからOpenApi GeneratorでSpringのコードを自動生成 by @littleFeet at Qiita
• 2019-09-24 - Eine Stunde was mit Api First! by @janweinschenker at Java Forum Nord
• 2019-10-09 - openapi-generator で生成した Go クライアントで Bearer 認証をする by Akira Tanimura
• 2019-10-10 - Automatic Generation of REST Clients by Thomas Peyrard, Senior Software Engineer at Criteo in Full-Stack Tech Talks (Meetup)
• 2019-10-12 - OpenApi自动生成client by 郑泽洲
• 2019-10-16 - How to ship APIs faster? by Simon Guilliams @ PoniCode
• 2019-10-22 - OpenAPI + Spring Boot(Kotlin)でファイルダウンロードAPIを作成する by Yuki Furukawa
• 2019-10-24 - Microprofile OpenAPI - Code First or Design First? by Peter [pɛʃə] Steiner at eclipsecon Europe 2019
• 2019-11-06 - Generating API clients based on OpenAPI v3 specifications by Dominik Jastrzębski @ 98elements
• 2019-11-06 - OpenAPIを利用して自前のAPIサーバー(Sinatra)を移植した時のメモ by Yasuhiro ABE
• 2019-11-07 - API First development with OpenAPI - You should you practise it !? by Nick Van Hoof at Devoxx Belgium 2019
• 2019-11-08 - JHipster beyond CRUD - API-First for Enterprises by Enrico Costanzi by Enrico Costanzi at JHipster Conf 2019 in Paris
• 2019-11-11 - TypeScript REST APIクライアント by @unhurried
• 2019-11-11 - One Spec to Rule them all - OpenAPI in Action by Andreas Litt at code.talks 2019
• 2019-11-13 - OpenAPI 3.0 Editor And Generator With A Spring Boot Example at Simply How
• 2019-11-17 - OpenAPI Generator YouTube playlist at YouTube
• 2019-11-20 - Introduction to OpenAPI by Lorna Mitchell at GOTO Copenhagen 2019
• 2019-11-20 - How to Generate Angular code from OpenAPI specifications by Anuraj
• 2019-11-23 - Swagger ではない OpenAPI Specification 3.0 による API サーバー開発 by Tetsuya Morimoto at JJUG CCC 2019 Fall
• 2019-11-24 - Accelerate Flutter development with OpenAPI and Dart code generation by Irina Southwell
• 2019-11-25 - openapi-generatorで手軽にスタブサーバとクライアントの生成 by @pochopocho13
• 2019-11-26 - CordaCon 2019 Highlights: Braid Server and OpenAPI Generator for Corda Client API’s by Adel Rustum at B9lab
• 2019-12-03 - A Road to Less Coding: Auto-Generate APILibrary at Corda Blog
• 2019-12-04 - Angular＋NestJS＋OpenAPI（Swagger）でマイクロサービスを視野に入れた環境を考える by てらしー
• 2019-12-17 - OpenAPI Generator で OAuth2 アクセストークン発行のコードまで生成してみる by TECHSCORE
• 2019-12-23 - Use Ada for Your Web Development by Stephane Carrez
• 2019-12-23 - OpenAPIのスキーマを分割・構造化していく方法 by 小飯塚達也 at GiFT, Inc
• 2020-01-17 - OpenAPI demo for Pulp 3.0 GA by Pulp at Youtube
• 2020-01-19 - Why document a REST API as code? by Rolf Streefkerk at DEV Community
• 2020-01-28 - Get Your Serverless Swagger Back with OpenAPI by Matt Tyler
• 2020-01-30 - OpenAPI Generatorへのコントリビュート by yutaka0m
• 2020-02-01 - Using OpenAPI to Maximise Your Pulp 3 Experience by Dennis Kliban at FOSDEM
• 2020-02-07 - Why you should use OpenAPI for your API design by Nick Van Hoof at API Conference
• 2020-02-17 - Rubynetes: using OpenAPI to validate Kubernetes configs by Neil Wilson at Brightbox
• 2020-02-20 - Building SDKs for the future by Sid Maestre (Xero)
• 2020-02-27 - Nuxt利用プロダクトでIE11と仲良くするためのE2E at Medpeer.co.jp Tech Blog
• 2020-02-29 - Providing Support to IoT Devices Deployed in Disconnected Rural Environment (Conference paper) by Sergio Laso, Daniel Flores-Martín, Juan Luis HerreraCarlos, CanalJuan Manuel, MurilloJavier Berrocal
• 2020-03-02 - How To Generate Angular & Spring Code From OpenAPI Specification by Michael Hoffmann
• 2020-03-02 - OpenAPI Generator + TypeScript で始める自動生成の型に守られた豊かなクライアント生活 by 五百蔵 直樹 at GiFT株式会社
• 2020-03-10 - OpenAPI Generator Meetup #1 by 中野暁人 at OpenAPI Generator Meetup #1
• 2020-03-15 - Load Testing Your API with Swagger/OpenAPI and k6
• 2020-04-13 - 俺的【OAS】との向き合い方 (爆速でOpenAPIと友達になろう) in OPTim Blog
• 2020-04-22 - Introduction to OpenAPI Generator by Kristopher Sandoval in Nordic APIs
• 2020-04-27 - How we use Open API v3 specification to auto-generate API documentation, code-snippets and clients by Tanel Tähepõld
• 2020-05-09 - OpenAPIでお手軽にモックAPIサーバーを動かす by Sachie Kamba
• 2020-05-18 - Spring Boot REST with OpenAPI 3 by Alfonz Jan Frithz
• 2020-05-19 - Dead Simple APIs with Open API by Chris Tankersley at Nexmo
• 2020-05-22 - TypeScript REST API Client by "unhurried"

6 - About Us

6.1 - OpenAPI Generator Core Team

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.

Core Team Members

• @wing328 (2015/07) ❤️
• @jimschubert (2016/05) ❤️
• @cbornet (2016/05)
• @ackintosh (2018/02) ❤️
• @jmini (2018/04) ❤️
• @etherealjoy (2019/06)
• @spacether (2020/05)

❤️ = Link to support the contributor directly

Template Creator

NOTE: Embedded templates are only supported in Mustache format. Support for all other formats is experimental and subject to change at any time.

Here is a list of template creators:

• API Clients:
  • Ada: @stcarrez
  • Apex: @asnelling
  • Bash: @bkryza
  • C: @PowerOfCreation @zhemant ❤️
  • C++ REST: @Danielku15
  • C++ UE4: @Kahncode
  • C# (.NET 2.0): @who
  • C# (.NET Standard 1.3 ): @Gronsak
  • C# (.NET 4.5 refactored): @jimschubert ❤️
  • Clojure: @xhh
  • Dart: @yissachar
  • Dart (refactor): @joernahrens
  • Dart 2: @swipesight
  • Dart (Jaguar): @jaumard
  • Dart (Dio): @athornz
  • Elixir: @niku
  • Elm: @eriktim
  • Eiffel: @jvelilla
  • Erlang: @tsloughter
  • Erlang (PropEr): @jfacorro @robertoaloi
  • Groovy: @victorgit
  • Go: @wing328 ❤️
  • Go (rewritten in 2.3.0): @antihax
  • Haskell (http-client): @jonschoning
  • Java (Feign): @davidkiss
  • Java (Retrofit): @0legg
  • Java (Retrofit2): @emilianobonassi
  • Java (Jersey2): @xhh
  • Java (okhttp-gson): @xhh
  • Java (RestTemplate): @nbruno
  • Java (Spring 5 WebClient): @daonomic
  • Java (RESTEasy): @gayathrigs
  • Java (Vertx): @lopesmcc
  • Java (Google APIs Client Library): @charlescapps
  • Java (Rest-assured): @viclovsky
  • Java (Java 11 Native HTTP client): @bbdouglas
  • Javascript/NodeJS: @jfiala
  • Javascript (Apollo DataSource): @erithmetic
  • Javascript (Closure-annotated Angular) @achew22
  • Javascript (Flow types) @jaypea
  • JMeter: @davidkiss
  • Kotlin: @jimschubert ❤️
  • Kotlin (MultiPlatform): @andrewemery
  • Lua: @daurnimator
  • Nim: @hokamoto
  • OCaml: @cgensoul
  • Perl: @wing328 ❤️
  • PHP (Guzzle): @baartosz
  • PowerShell: @beatcracker
  • PowerShell (refactored in 5.0.0): @wing328
  • Python-experimental: @spacether
  • R: @ramnov
  • Ruby (Faraday): @meganemura @dkliban
  • Rust: @farcaller
  • Rust (rust-server): @metaswitch
  • Scala (scalaz & http4s): @tbrown1979
  • Scala (Akka): @cchafer
  • Scala (sttp): @chameleon82
  • Swift: @tkqubo
  • Swift 3: @hexelon
  • Swift 4: @ehyche
  • Swift 5: @4brunu
  • TypeScript (Angular1): @mhardorf
  • TypeScript (Angular2): @roni-frantchi
  • TypeScript (Angular6): @akehir
  • TypeScript (Angular7): @topce
  • TypeScript (Axios): @nicokoenig
  • TypeScript (Fetch): @leonyu
  • TypeScript (jQuery): @bherila
  • TypeScript (Node): @mhardorf
  • TypeScript (Rxjs): @denyo
  • TypeScript (Inversify): @gualtierim
  • TypeScript (redux-query): @petejohansonxo
• Server Stubs
  • Ada: @stcarrez
  • C# ASP.NET 5: @jimschubert ❤️
  • C# ASP.NET Core 3.0: @A-Joshi
  • C# APS.NET Core 3.1: @phatcher
  • C# NancyFX: @mstefaniuk
  • C++ (Qt5 QHttpEngine): @etherealjoy
  • C++ Pistache: @sebymiano
  • C++ Restbed: @stkrwork
  • Erlang Server: @galaxie
  • F# (Giraffe) Server: @nmfisher
  • Go Server: @guohuang
  • Go (Gin) Server: @kemokemo
  • GraphQL Express Server: @renepardon
  • Haskell Servant: @algas
  • Java MSF4J: @sanjeewa-malalgoda
  • Java Spring Boot: @diyfr
  • Java Undertow: @stevehu
  • Java Play Framework: @JFCote
  • Java PKMST: @anshu2185 @sanshuman @rkumar-pk @ninodpillai
  • Java Vert.x: @lwlee2608
  • JAX-RS RestEasy: @chameleon82
  • JAX-RS CXF: @hiveship
  • JAX-RS CXF (CDI): @nickcmaynard
  • JAX-RS RestEasy (JBoss EAP): @jfiala
  • Kotlin: @jimschubert ❤️
  • Kotlin (Spring Boot): @dr4ke616
  • Kotlin (Vertx): @Wooyme
  • NodeJS Express: @YishTish
  • PHP Laravel: @renepardon
  • PHP Lumen: @abcsun
  • PHP Slim: @jfastnacht
  • PHP Symfony: @ksm2
  • PHP Zend Expressive (with Path Handler): @Articus
  • Python AIOHTTP: @Jyhess
  • Ruby on Rails 5: @zlx
  • Rust (rust-server): @metaswitch
  • Scala Akka: @Bouillie
  • Scala Finch: @jimschubert ❤️
  • Scala Lagom: @gmkumar2005
  • Scala Play: @adigerber
• Documentation
  • AsciiDoc: @man-at-home
  • HTML Doc 2: @jhitchcock
  • Confluence Wiki: @jhitchcock
  • PlantUML: @pburls
• Configuration
  • Apache2: @stkrwork
  • k6: @mostafa
• Schema
  • Avro: @sgadouar
  • GraphQL: @wing328 ❤️
  • MySQL: @ybelenko
  • Protocol Buffer: @wing328

❤️ = Link to support the contributor directly

How to join the core team

Here are the requirements to become a core team member:

• rank within top 50 in https://github.com/openapitools/openapi-generator/graphs/contributors
  • to contribute, here are some good starting points
• 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
  • must be active in the past 3 months at the time of application

To join the core team, please reach out to team@openapitools.org for more information.

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.

6.2 - OpenAPI Generator Technical Committee

Members of the OpenAPI Generator technical committee shoulder the following responsibilities:

• 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

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)

If you want to join the committee, please kindly apply by sending an email to team@openapitools.org with your Github ID.

Members of Technical Committee

Languages	Member (join date)
ActionScript
Ada	@stcarrez (2018/02) @michelealbano (2018/02)
Android	@jaz-ah (2017/09)
Apex
Bash	@frol (2017/07) @bkryza (2017/08) @kenjones-cisco (2017/09)
C	@zhemant (2018/11) @ityuhui (2019/12) @michelealbano (2020/03)
C++	@ravinikam (2017/07) @stkrwork (2017/07) @etherealjoy (2018/02) @martindelille (2018/03) @muttleyxd (2019/08)
C#	@mandrean (2017/08), @jimschubert (2017/09) ❤️ @frankyjuang (2019/09) @shibayan (2020/02)
Clojure
Dart	@ircecho (2017/07) @swipesight (2018/09) @jaumard (2018/09) @athornz (2019/12) @amondnet (2019/12)
Eiffel	@jvelilla (2017/09)
Elixir	@mrmstn (2018/12)
Elm	@eriktim (2018/09)
Erlang	@tsloughter (2017/11) @jfacorro (2018/10) @robertoaloi (2018/10)
F#	@nmfisher (2019/05)
Go	@antihax (2017/11) @bvwells (2017/12) @grokify (2018/07) @kemokemo (2018/09) @bkabrda (2019/07)
GraphQL	@renepardon (2018/12)
Groovy
Haskell
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) @lwlee2608 (2019/10) @bkabrda (2020/01)
Kotlin	@jimschubert (2017/09) ❤️, @dr4ke616 (2018/08) @karismann (2019/03) @Zomzog (2019/04) @andrewemery (2019/10) @4brunu (2019/11) @yutaka0m (2020/03)
Lua	@daurnimator (2017/08)
Nim
NodeJS/Javascript	@CodeNinjai (2017/07) @frol (2017/07) @cliffano (2017/07)
ObjC
OCaml	@cgensoul (2019/08)
Perl	@wing328 (2017/07) ❤️ @yue9944882 (2019/06)
PHP	@jebentier (2017/07), @dkarlovi (2017/07), @mandrean (2017/08), @jfastnacht (2017/09), @ackintosh (2017/09) ❤️, @ybelenko (2018/07), @renepardon (2018/12)
PowerShell	@wing328 (2020/05)
Python	@taxpon (2017/07) @frol (2017/07) @mbohlool (2017/07) @cbornet (2017/09) @kenjones-cisco (2017/11) @tomplus (2018/10) @Jyhess (2019/01) @arun-nalla (2019/11) @spacether (2019/11)
R	@Ramanth (2019/07) @saigiridhar21 (2019/07)
Ruby	@cliffano (2017/07) @zlx (2017/09) @autopp (2019/02)
Rust	@frol (2017/07) @farcaller (2017/08) @bjgill (2017/12) @richardwhiuk (2019/07) @paladinzh (2020/05)
Scala	@clasnake (2017/07), @jimschubert (2017/09) ❤️, @shijinkui (2018/01), @ramzimaalej (2018/03), @chameleon82 (2020/03), @Bouillie (2020/04)
Swift	@jgavris (2017/07) @ehyche (2017/08) @Edubits (2017/09) @jaz-ah (2017/09) @4brunu (2019/11)
TypeScript	@TiFu (2017/07) @taxpon (2017/07) @sebastianhaas (2017/07) @kenisteward (2017/07) @Vrolijkx (2017/09) @macjohnny (2018/01) @topce (2018/10) @akehir (2019/07) @petejohansonxo (2019/11) @amakhrov (2020/02)

❤️ = Link to support the contributor directly

6.3 - History of OpenAPI Generator

OpenAPI Generator is a fork of 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 for more information.

Founding Members (alphabetical order):

• Akihito Nakano
• Artem Ocheredko
• Arthur Mogliev
• Bartek Kryza
• Ben Wells
• Benjamin Gill
• Christophe Bornet
• Cliffano Subagio
• Daiki Matsudate
• Daniel
• Emiliano Bonassi
• Erik Timmers
• Esteban Marin
• Gustavo Paz
• Javier Velilla
• Jean-François Côté
• Jim Schubert
• Jon Schoning
• Jérémie Bresson ❤️
• Jörn Ahrens
• Keni Steward
• Marcin Stefaniuk
• Martin Delille
• Masahiro Yamauchi
• Michele Albano
• Ramzi Maalej
• Ravindra Nikam
• Ricardo Cardona
• Sebastian Haas
• Sebastian Mandrean
• Sreenidhi Sreesha
• Stefan Krismann
• Stephane Carrez
• Takuro Wada
• Tomasz Prus
• Tristan Sloughter
• Victor Orlovsky
• Victor Trakhtenberg
• Vlad Frolov
• Vladimir Pouzanov
• William Cheng
• Xin Meng ❤️
• Xu Hui Hui
• antihax
• beatcracker
• daurnimator
• etherealjoy
• jfiala
• lukoyanov

❤️ = Link to support the contributor directly

7 - License

---

Copyright 2018 OpenAPI-Generator Contributors (https://openapi-generator.tech)
Copyright 2018 SmartBear Software

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at apache.org/licenses/LICENSE-2.0

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.

---