openapi-generator

OpenAPI Generator Master (7.28.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). For security vulnerabilities, please contact team@openapitools.org. ⚠️ ‼️ 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, Checkly for sponsoring the API monitoring and Gradle for sponsoring Develocity 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.1, .NET Core 3.1, .NET 5.0. Libraries: RestSharp, GenericHost, HttpClient), C++ (Arduino, cpp-restsdk, Qt5, Tizen, Unreal Engine 4), Clojure, Crystal, Dart, Elixir, Elm, Eiffel, Erlang, Go, Groovy, Haskell (http-client, Servant), Java (Apache HttpClient 4.x, Apache HttpClient 5.x, Jersey2.x, OkHttp, Retrofit1.x, Retrofit2.x, Feign, RestTemplate, RESTEasy, Vertx, Google API Client Library for Java, Rest-assured, Spring 5 Web Client, Spring 6 RestClient, MicroProfile Rest Client, Helidon), Jetbrains HTTP Client, Julia, k6, Kotlin, Lua, N4JS, 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 (hyper, reqwest, rust-server), Scala (akka, http4s, scalaz, sttp, swagger-async-httpclient, pekko), Swift (2.x, 3.x, 4.x, 5.x, 6.x), Typescript (AngularJS, Angular (9.x - 19.x), Aurelia, Axios, Fetch, Inversify, jQuery, Nestjs, Node, redux-query, Rxjs), XoJo, Zapier Server stubs Ada, C# (ASP.NET Core, Azure Functions), C++ (Httplib, Oat++, Pistache, Restbed, Qt5 QHTTPEngine), Erlang, F# (Giraffe), Go (net/http, Gin, Echo), Haskell (Servant, Yesod), Java (MSF4J, Spring, Undertow, JAX-RS: CDI, CXF, Inflector, Jersey, RestEasy, Play Framework, PKMST, Vert.x, Apache Camel, Helidon), Julia, Kotlin (Spring Boot, Ktor, Vert.x), PHP (Flight, Laravel, Lumen, Mezzio (fka Zend Expressive), Slim, Silex, Symfony), Python (FastAPI, Flask), NodeJS, Ruby (Sinatra, Rails5), Rust (rust-server), Scala (Akka, Finch, Lagom, Play, Cask, Scalatra) API documentation generators HTML, Confluence Wiki, Asciidoc, Markdown, PlantUML Configuration files Apache2 Others GraphQL, JMeter, Ktorm, MySQL Schema, Postman Collection, Protocol Buffer, WSDL Table of contents Sponsors Thank you to our bronze sponsors! Thank you GoDaddy for sponsoring the domain names, Linode for sponsoring the VPS, Checkly for sponsoring the API monitoring and Gradle for sponsoring Develocity Overview Table of contents 1 - Installation 1.1 - Compatibility 1.2 - Artifacts on Maven Central 1.3 - Download JAR Launcher Script 1.4 - Build Projects Nix users 1.5 - Homebrew 1.6 - Docker Public Pre-built Docker images OpenAPI Generator CLI Docker Image OpenAPI Generator Online Docker Image Development in docker Troubleshooting Run Docker in Vagrant 1.7 - NPM 1.8 - pip 2 - Getting Started 3 - Usage To generate a sample client library 3.1 - Customization 3.2 - Workflow Integration (Maven, Gradle, Github, CI/CD) 3.3 - Online OpenAPI generator 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 Core Team Members Template Creator How to join the core team 6.2 - OpenAPI Generator Technical Committee Members of Technical Committee 6.3 - History of OpenAPI Generator Founding Members (alphabetical order): 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 7.28.0 (upcoming minor release) SNAPSHOT 20.11.2026 Minor release with breaking changes (with fallback) 7.27.0 (latest stable release) 02.11.2026 Minor release with breaking changes (with fallback) 6.6.0 11.05.2023 Minor release with breaking changes (with fallback) 5.4.0 31.01.2022 Minor release with breaking changes (with fallback) 4.3.1 06.05.2020 Patch release (enhancements, bug fixes, etc) OpenAPI Spec compatibility: 1.0, 1.1, 1.2, 2.0, 3.0, 3.1 (beta support) (We do not publish daily/nightly build. Please use SNAPSHOT instead) For old releases, please refer to the Release page. For decommissioned generators/libraries/frameworks, please refer to the "Decommission" label in the pull request page. 1.2 - Artifacts on Maven Central You can find our released artifacts on maven central: Core: <dependency> <groupId>org.openapitools</groupId> <artifactId>o