spysystem/openapi-generator repository overview
OpenAPI Generator
Master (7.10.0):
:star::star::star: If you would like to contribute, please refer to guidelines and a list of open tasks. :star::star::star:
:bangbang: To migrate from Swagger Codegen to OpenAPI Generator, please refer to the migration guide :bangbang:
:notebook_with_decorative_cover: For more information, please refer to the Wiki page and FAQ :notebook_with_decorative_cover:
:notebook_with_decorative_cover: The eBook A Beginner's Guide to Code Generation for REST APIs is a good starting point for beginners :notebook_with_decorative_cover:
: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). For security vulnerabilities, please contact [email protected]. :warning:
:bangbang: Both "OpenAPI Tools" (https://OpenAPITools.org - the parent organization of OpenAPI Generator) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI) :bangbang:
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 - 18.x), Aurelia, Axios, Fetch, Inversify, jQuery, Nestjs, Node, redux-query, Rxjs), XoJo, Zapier |
| Server stubs | Ada, C# (ASP.NET Core, Azure Functions), C++ (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
- OpenAPI Generator
- Overview
- Table of Contents
- 1 - Installation
- 2 - Getting Started
- 3 - Usage
- 4 - Companies/Projects using OpenAPI Generator
- 5 - Presentations/Videos/Tutorials/Books
- 6 - About Us
- 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.10.0 (upcoming minor release) SNAPSHOT | 07.11.2024 | Minor release with breaking changes (with fallback) |
| 7.9.0 (latest stable release) | 07.10.2024 | Minor release with breaking changes (with fallback) |
| 7.8.0 (latest stable release) | 19.08.2024 | 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 decomissioned 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>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
Tag summary
Content type
Image
Digest
sha256:a6dc23fa7…
Size
893.2 MB
Last updated
3 months ago
docker pull spysystem/openapi-generator:spy-7.23.latest