From 9b745e265068d78c2d7472bb9b891733f1eb5e59 Mon Sep 17 00:00:00 2001 From: Frank Kilcommins Date: Fri, 11 Oct 2024 17:55:10 +0100 Subject: [PATCH] chore(repo): simplify README to aid navigation and docs --- README.md | 1187 ++---------------------------- docs/Swagger-Codegen-Logo.png | Bin 0 -> 26449 bytes docs/building.md | 37 + docs/compatibility.md | 120 +++ docs/consumers.md | 159 ++++ docs/docker.md | 92 +++ docs/generation-selective.md | 51 ++ docs/generators-configuration.md | 119 +++ docs/generators.md | 96 +++ docs/online-generators.md | 81 ++ docs/prerequisites.md | 46 ++ docs/public-content.md | 62 ++ docs/template-creators.md | 93 +++ docs/versioning.md | 51 ++ docs/workflow-integration.md | 33 + 15 files changed, 1119 insertions(+), 1108 deletions(-) create mode 100644 docs/Swagger-Codegen-Logo.png create mode 100644 docs/building.md create mode 100644 docs/compatibility.md create mode 100644 docs/consumers.md create mode 100644 docs/docker.md create mode 100644 docs/generation-selective.md create mode 100644 docs/generators-configuration.md create mode 100644 docs/generators.md create mode 100644 docs/online-generators.md create mode 100644 docs/prerequisites.md create mode 100644 docs/public-content.md create mode 100644 docs/template-creators.md create mode 100644 docs/versioning.md create mode 100644 docs/workflow-integration.md diff --git a/README.md b/README.md index 1a0a887c277..2d5fa2bf70c 100644 --- a/README.md +++ b/README.md @@ -1,75 +1,30 @@ -# +# Swagger Codegen +![Swagger Codegen Logo](./docs/Swagger-Codegen-Logo.png) -[![Build Status](https://img.shields.io/jenkins/build.svg?jobUrl=https://jenkins.swagger.io/job/oss-swagger-core-master-java-8)](https://jenkins.swagger.io/view/OSS%20-%20Java/job/oss-swagger-core-master-java-8) +This is the Swagger Codegen project, which allows generation of API client libraries (SDK generation), server stubs and documentation automatically given an [OpenAPI Spec](https://github.com/OAI/OpenAPI-Specification). -[![Build Status](https://jenkins.swagger.io/view/OSS%20-%20Java/job/oss-swagger-codegen-master/badge/icon?subject=jenkins%20build)](https://jenkins.swagger.io/view/OSS%20-%20Java/job/oss-swagger-codegen-master/) +💚 If you would like to contribute, please refer to [guidelines](https://github.com/swagger-api/swagger-codegen/blob/master/CONTRIBUTING.md) and a list of [open tasks](https://github.com/swagger-api/swagger-codegen/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22).💚 -[![Build Status](https://jenkins.swagger.io/view/OSS%20-%20Java/job/oss-swagger-codegen-master-java7/badge/icon?subject=jenkins%20build%20-%20java%207)](https://jenkins.swagger.io/view/OSS%20-%20Java/job/oss-swagger-codegen-master-java7/) +📔 For more information, please refer to the [Wiki page](https://github.com/swagger-api/swagger-codegen/wiki) and [FAQ](https://github.com/swagger-api/swagger-codegen/wiki/FAQ) 📔 - -[Maven Central](https://maven-badges.herokuapp.com/maven-central/io.swagger/swagger-codegen-project) - -:star::star::star: If you would like to contribute, please refer to [guidelines](https://github.com/swagger-api/swagger-codegen/blob/master/CONTRIBUTING.md) and a list of [open tasks](https://github.com/swagger-api/swagger-codegen/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22).:star::star::star: - -:notebook_with_decorative_cover: For more information, please refer to the [Wiki page](https://github.com/swagger-api/swagger-codegen/wiki) and [FAQ](https://github.com/swagger-api/swagger-codegen/wiki/FAQ) :notebook_with_decorative_cover: - -:warning: If the OpenAPI/Swagger spec is obtained from an untrusted source, please make sure you've reviewed the spec before using Swagger Codegen to generate the API client, server stub or documentation as [code injection](https://en.wikipedia.org/wiki/Code_injection) may occur :warning: - -:rocket: ProductHunt: https://producthunt.com/posts/swagger-codegen :rocket: - -:notebook_with_decorative_cover: The eBook [A Beginner's Guide to Code Generation for REST APIs](https://gumroad.com/l/swagger_codegen_beginner) is a good starting point for beginners. +⚠️ If the OpenAPI Description or Swagger file is obtained from an untrusted source, please make sure you've reviewed the artefact before using Swagger Codegen to generate the API client, server stub or documentation as [code injection](https://en.wikipedia.org/wiki/Code_injection) may occur. ⚠️ ## Versioning -**NOTE:** version 2.X (`io.swagger`) and 3.X (`io.swagger.codegen.v3`) have **different** group ids. - -2.X and 3.X version lines of Swagger Codegen are available; 2.X (`master` branch) supports Swagger/OpenAPI version 2, -while 3.X ([`3.0.0` branch](https://github.com/swagger-api/swagger-codegen/tree/3.0.0)) supports OpenAPI version 3 (and version 2 via spec conversion to version 3). -[Online generator of version 3.X](https://github.com/swagger-api/swagger-codegen/tree/3.0.0#online-generators) supports both generation from Swagger/OpenAPI version 2 (by using engine + generators of 2.X) and version 3 specifications. - - -**NOTE:** this document refers to version 2.X, check [here](https://github.com/swagger-api/swagger-codegen/tree/3.0.0) for 3.X. - - -### Swagger Codegen 2.X ([`master` branch](https://github.com/swagger-api/swagger-codegen/tree/master)) - -Swagger Codegen 2.X supports Swagger/OpenAPI version 2. - -group id: `io.swagger` -maven central (maven plugin): https://mvnrepository.com/artifact/io.swagger/swagger-codegen-maven-plugin - -dependency example: - -``` - - io.swagger - swagger-codegen-maven-plugin - 2.4.43 - -``` - -### Swagger Codegen 3.X ([`3.0.0` branch](https://github.com/swagger-api/swagger-codegen/tree/3.0.0)) - -Swagger Codegen 3.X supports OpenAPI version 3 (and version 2 via spec conversion to version 3) -[Online generator of version 3.X](https://github.com/swagger-api/swagger-codegen/tree/3.0.0#online-generators) supports both generation from Swagger/OpenAPI version 2 (by using engine + generators of 2.X) and version 3 specifications. +> ⚠️ this document refers to version 2.X, check [here](https://github.com/swagger-api/swagger-codegen/tree/3.0.0) for 3.X. -group id: `io.swagger.codegen.v3` -maven central: https://mvnrepository.com/artifact/io.swagger.codegen.v3 +Both **2.X** and **3.X** version lines of Swagger Codegen are available and are independently maintained. -dependency example: +**NOTES:** -``` - - io.swagger.codegen.v3 - swagger-codegen-maven-plugin - 3.0.61 - -``` +- Versions 2.X (`io.swagger`) and 3.X (`io.swagger.codegen.v3`) have **different** group ids. +- OpenAPI 3.0.X is supported from the 3.X version only. +For full versioning information, please refer to the [versioning documentation](./docs/versioning.md). +## Supported Languages and Frameworks -## Overview -This is the Swagger Codegen project, which allows generation of API client libraries (SDK generation), server stubs and documentation automatically given an [OpenAPI Spec](https://github.com/OAI/OpenAPI-Specification). Currently, the following languages/frameworks are supported: +Currently, the following languages/frameworks are supported: - **API clients**: **ActionScript**, **Ada**, **Apex**, **Bash**, **C#** (.net 2.0, 3.5 or later), **C++** (cpprest, Qt5, Tizen), **Clojure**, **Dart**, **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), **Kotlin**, **Lua**, **Node.js** (ES5, ES6, AngularJS with Google Closure Compiler annotations) **Objective-C**, **Perl**, **PHP**, **PowerShell**, **Python**, **R**, **Ruby**, **Rust** (rust, rust-server), **Scala** (akka, http4s, swagger-async-httpclient), **Swift** (2.x, 3.x, 4.x, 5.x), **Typescript** (Angular1.x, Angular2.x, Fetch, jQuery, Node) - **Server stubs**: **Ada**, **C#** (ASP.NET Core, NancyFx), **C++** (Pistache, Restbed), **Erlang**, **Go**, **Haskell** (Servant), **Java** (MSF4J, Spring, Undertow, JAX-RS: CDI, CXF, Inflector, RestEasy, Play Framework, [PKMST](https://github.com/ProKarma-Inc/pkmst-getting-started-examples)), **Kotlin**, **PHP** (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), Scalatra) @@ -79,339 +34,87 @@ This is the Swagger Codegen project, which allows generation of API client libra Check out [OpenAPI-Spec](https://github.com/OAI/OpenAPI-Specification) for additional information about the OpenAPI project. -# Table of contents - - - [Versioning](#versioning) - - [Overview](#overview) - - [Table of Contents](#table-of-contents) - - Installation - - [Compatibility](#compatibility) - - [Prerequisites](#prerequisites) - - [OS X Users](#os-x-users) - - [Building](#building) - - [Docker](#docker) - - [Development in Docker](#development-in-docker) - - [Run docker in Vagrant](#run-docker-in-vagrant) - - [Public pre-built Docker images](#public-pre-built-docker-images) - - [Homebrew](#homebrew) - - [Getting Started](#getting-started) - - Generators - - [To generate a sample client library](#to-generate-a-sample-client-library) - - [Generating libraries from your server](#generating-libraries-from-your-server) - - [Modifying the client library format](#modifying-the-client-library-format) - - [Making your own codegen modules](#making-your-own-codegen-modules) - - [Where is Javascript???](#where-is-javascript) - - [Generating a client from local files](#generating-a-client-from-local-files) - - [Customizing the generator](#customizing-the-generator) - - [Validating your OpenAPI Spec](#validating-your-openapi-spec) - - [Generating dynamic html api documentation](#generating-dynamic-html-api-documentation) - - [Generating static html api documentation](#generating-static-html-api-documentation) - - [To build a server stub](#to-build-a-server-stub) - - [To build the codegen library](#to-build-the-codegen-library) - - [Workflow Integration](#workflow-integration) - - [Maven Integration](#maven-integration) - - [Gradle Integration](#gradle-integration) - - [Github Integration](#github-integration) - - [Online Generators](#online-generators) - - [Guidelines for Contribution](https://github.com/swagger-api/swagger-codegen/blob/master/CONTRIBUTING.md#guidelines-for-contributing) - - [Companies/Projects using Swagger Codegen](#companiesprojects-using-swagger-codegen) - - [Presentations/Videos/Tutorials/Books](#presentationsvideostutorialsbooks) - - [Swagger Codegen Core Team](#swagger-codegen-core-team) - - [Swagger Codegen Technical Committee](#swagger-codegen-technical-committee) - - [License](#license) +## Table of contents + +- [Versioning](#versioning) +- [Compatibility](#compatibility) +- [Getting Started](#getting-started) +- [Generators](#generators) + - [To generate a sample client library](#to-generate-a-sample-client-library) + - [Generating libraries from your server](#generating-libraries-from-your-server) + - [Validating your OpenAPI Spec](#validating-your-openapi-spec) + - [Generating dynamic html api documentation](#generating-dynamic-html-api-documentation) + - [Generating static html api documentation](#generating-static-html-api-documentation) +- [Workflow Integration](#workflow-integration) +- [Online Generators](#online-generators) +- [Contribution](#contributing) +- [Swagger Codegen Core Team](#swagger-codegen-core-team) ## Compatibility -The OpenAPI Specification has undergone 3 revisions since initial creation in 2010. The Swagger Codegen project has the following compatibilities with the OpenAPI Specification: -Swagger Codegen Version | Release Date | OpenAPI Spec compatibility | Notes +The OpenAPI Specification has undergone 3 revisions since initial creation in 2010. The **current stable** versions of Swagger Codegen project have the following compatibilities with the OpenAPI Specification: + +Swagger Codegen Version | Release Date | Swagger / OpenAPI Spec compatibility | Notes -------------------------- |--------------| -------------------------- | ----- -3.0.62-SNAPSHOT (current 3.0.0, upcoming minor release) [SNAPSHOT](https://oss.sonatype.org/content/repositories/snapshots/io/swagger/codegen/v3/swagger-codegen-cli/3.0.62-SNAPSHOT/)| TBD | 1.0, 1.1, 1.2, 2.0, 3.0 | Minor release -[3.0.61](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.61) (**current stable**) | 2024-08-09 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.61](https://github.com/swagger-api/swagger-codegen/tree/v3.0.61) -[3.0.60](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.60) | 2024-08-01 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.60](https://github.com/swagger-api/swagger-codegen/tree/v3.0.60) -[3.0.59](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.59) | 2024-07-22 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.59](https://github.com/swagger-api/swagger-codegen/tree/v3.0.59) -[3.0.58](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.58) | 2024-07-08 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.58](https://github.com/swagger-api/swagger-codegen/tree/v3.0.58) -[3.0.57](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.57) | 2024-05-27 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.57](https://github.com/swagger-api/swagger-codegen/tree/v3.0.57) -[3.0.56](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.56) | 2024-05-10 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.56](https://github.com/swagger-api/swagger-codegen/tree/v3.0.56) -[3.0.55](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.55) | 2024-04-22 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.55](https://github.com/swagger-api/swagger-codegen/tree/v3.0.55) -[3.0.54](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.54) | 2024-02-19 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.54](https://github.com/swagger-api/swagger-codegen/tree/v3.0.54) -[3.0.53](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.53) | 2024-02-14 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.53](https://github.com/swagger-api/swagger-codegen/tree/v3.0.53) -[3.0.52](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.52) | 2023-12-30 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.52](https://github.com/swagger-api/swagger-codegen/tree/v3.0.52) -[3.0.51](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.51) | 2023-11-21 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.51](https://github.com/swagger-api/swagger-codegen/tree/v3.0.51) -[3.0.50](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.50) | 2023-10-26 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.50](https://github.com/swagger-api/swagger-codegen/tree/v3.0.50) -[3.0.49](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.49) | 2023-10-23 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.49](https://github.com/swagger-api/swagger-codegen/tree/v3.0.49) -[3.0.48](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.48) | 2023-10-19 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.48](https://github.com/swagger-api/swagger-codegen/tree/v3.0.48) -[3.0.47](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.47) | 2023-10-02 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.47](https://github.com/swagger-api/swagger-codegen/tree/v3.0.47) -[3.0.46](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.46) | 2023-06-07 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.46](https://github.com/swagger-api/swagger-codegen/tree/v3.0.46) -[3.0.45](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.45) | 2023-06-02 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.45](https://github.com/swagger-api/swagger-codegen/tree/v3.0.45) -[3.0.44](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.44) | 2023-05-23 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.44](https://github.com/swagger-api/swagger-codegen/tree/v3.0.44) -[3.0.43](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.43) | 2023-05-17 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.43](https://github.com/swagger-api/swagger-codegen/tree/v3.0.43) -[3.0.42](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.42) | 2023-04-05 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.42](https://github.com/swagger-api/swagger-codegen/tree/v3.0.42) -[3.0.41](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.41) | 2023-02-16 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.41](https://github.com/swagger-api/swagger-codegen/tree/v3.0.41) -[3.0.40](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.40) | 2023-01-27 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.40](https://github.com/swagger-api/swagger-codegen/tree/v3.0.40) -[3.0.39](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.39) | 2023-01-25 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.39](https://github.com/swagger-api/swagger-codegen/tree/v3.0.39) -[3.0.38](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.38) | 2023-01-22 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.38](https://github.com/swagger-api/swagger-codegen/tree/v3.0.38) -[3.0.37](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.37) | 2023-01-19 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.37](https://github.com/swagger-api/swagger-codegen/tree/v3.0.37) -[3.0.36](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.36) | 2022-11-10 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.36](https://github.com/swagger-api/swagger-codegen/tree/v3.0.36) -[3.0.35](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.35) | 2022-08-15 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.35](https://github.com/swagger-api/swagger-codegen/tree/v3.0.35) -[3.0.34](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.34) | 2022-04-12 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.34](https://github.com/swagger-api/swagger-codegen/tree/v3.0.34) -[3.0.33](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.33) | 2022-02-07 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.33](https://github.com/swagger-api/swagger-codegen/tree/v3.0.33) -[3.0.32](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.32) | 2022-01-11 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.32](https://github.com/swagger-api/swagger-codegen/tree/v3.0.32) -[3.0.31](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.31) | 2021-12-28 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.31](https://github.com/swagger-api/swagger-codegen/tree/v3.0.31) -[3.0.30](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.30) | 2021-11-18 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.30](https://github.com/swagger-api/swagger-codegen/tree/v3.0.30) -[3.0.29](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.29) | 2021-10-05 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.29](https://github.com/swagger-api/swagger-codegen/tree/v3.0.29) -[3.0.28](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.28) | 2021-09-30 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.28](https://github.com/swagger-api/swagger-codegen/tree/v3.0.28) -[3.0.27](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.27) | 2021-06-28 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.27](https://github.com/swagger-api/swagger-codegen/tree/v3.0.27) -[3.0.26](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.26) | 2021-05-28 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.26](https://github.com/swagger-api/swagger-codegen/tree/v3.0.26) -[3.0.25](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.25) | 2021-03-04 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.25](https://github.com/swagger-api/swagger-codegen/tree/v3.0.25) -[3.0.24](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.24) | 2020-12-29 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.24](https://github.com/swagger-api/swagger-codegen/tree/v3.0.24) -[3.0.23](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.23) | 2020-11-02 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.23](https://github.com/swagger-api/swagger-codegen/tree/v3.0.23) -[3.0.22](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.22) | 2020-10-05 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.22](https://github.com/swagger-api/swagger-codegen/tree/v3.0.22) -[3.0.21](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.21) | 2020-07-28 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.21](https://github.com/swagger-api/swagger-codegen/tree/v3.0.21) -[3.0.20](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.20) | 2020-05-18 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.20](https://github.com/swagger-api/swagger-codegen/tree/v3.0.20) -[3.0.19](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.19) | 2020-04-02 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.19](https://github.com/swagger-api/swagger-codegen/tree/v3.0.19) -[3.0.18](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.18) | 2020-02-26 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.18](https://github.com/swagger-api/swagger-codegen/tree/v3.0.18) -[3.0.17](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.17) | 2020-02-23 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.17](https://github.com/swagger-api/swagger-codegen/tree/v3.0.17) -[3.0.17](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.16) | 2020-01-15 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.16](https://github.com/swagger-api/swagger-codegen/tree/v3.0.16) -[3.0.15](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.15) | 2020-01-03 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.15](https://github.com/swagger-api/swagger-codegen/tree/v3.0.15) -[3.0.14](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.14) | 2019-11-16 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.14](https://github.com/swagger-api/swagger-codegen/tree/v3.0.14) -[3.0.13](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.13) | 2019-10-16 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.13](https://github.com/swagger-api/swagger-codegen/tree/v3.0.13) -[3.0.12](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.12) | 2019-10-14 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.12](https://github.com/swagger-api/swagger-codegen/tree/v3.0.12) -[3.0.11](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.11) | 2019-08-24 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.11](https://github.com/swagger-api/swagger-codegen/tree/v3.0.11) -[3.0.10](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.10) | 2019-07-11 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.10](https://github.com/swagger-api/swagger-codegen/tree/v3.0.10) -[3.0.9](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.9) | 2019-06-28 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.9](https://github.com/swagger-api/swagger-codegen/tree/v3.0.9) -[3.0.8](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.8) | 2019-04-25 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.8](https://github.com/swagger-api/swagger-codegen/tree/v3.0.8) -[3.0.7](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.7) | 2019-03-26 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.7](https://github.com/swagger-api/swagger-codegen/tree/v3.0.7) -[3.0.5](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.5) | 2019-02-18 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.5](https://github.com/swagger-api/swagger-codegen/tree/v3.0.5) -[3.0.4](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.4) | 2019-01-16 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.4](https://github.com/swagger-api/swagger-codegen/tree/v3.0.4) -[3.0.3](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.3) | 2018-11-30 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.3](https://github.com/swagger-api/swagger-codegen/tree/v3.0.3) -[3.0.2](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.2)| 2018-10-19 | 1.0, 1.1, 1.2, 2.0, 3.0 | Minor release -[3.0.1](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.1)| 2018-10-05 | 1.0, 1.1, 1.2, 2.0, 3.0 | Major release with breaking changes -[3.0.0](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.0)| 2018-09-06 | 1.0, 1.1, 1.2, 2.0, 3.0 | Major release with breaking changes -2.4.44-SNAPSHOT (current master, upcoming minor release) [SNAPSHOT](https://oss.sonatype.org/content/repositories/snapshots/io/swagger/swagger-codegen-cli/2.4.44-SNAPSHOT/)| TBD | 1.0, 1.1, 1.2, 2.0 | Minor release +[3.0.62](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.62) (**current stable**) | 2024-08-27 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.62](https://github.com/swagger-api/swagger-codegen/tree/v3.0.62) [2.4.43](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.43) (**current stable**) | 2024-08-09 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.42](https://github.com/swagger-api/swagger-codegen/tree/v2.4.43) -[2.4.42](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.42) | 2024-07-29 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.42](https://github.com/swagger-api/swagger-codegen/tree/v2.4.42) -[2.4.41](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.41) | 2024-04-22 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.41](https://github.com/swagger-api/swagger-codegen/tree/v2.4.41) -[2.4.39](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.39) | 2024-01-02 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.39](https://github.com/swagger-api/swagger-codegen/tree/v2.4.39) -[2.4.38](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.38) | 2023-12-29 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.38](https://github.com/swagger-api/swagger-codegen/tree/v2.4.38) -[2.4.37](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.37) | 2023-11-21 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.37](https://github.com/swagger-api/swagger-codegen/tree/v2.4.37) -[2.4.36](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.36) | 2023-10-26 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.36](https://github.com/swagger-api/swagger-codegen/tree/v2.4.36) -[2.4.35](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.35) | 2023-10-26 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.35](https://github.com/swagger-api/swagger-codegen/tree/v2.4.35) -[2.4.34](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.34) | 2023-10-19 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.34](https://github.com/swagger-api/swagger-codegen/tree/v2.4.34) -[2.4.33](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.33) | 2023-10-02 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.33](https://github.com/swagger-api/swagger-codegen/tree/v2.4.33) -[2.4.32](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.32) | 2023-05-17 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.32](https://github.com/swagger-api/swagger-codegen/tree/v2.4.32) -[2.4.31](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.31) | 2023-04-02 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.31](https://github.com/swagger-api/swagger-codegen/tree/v2.4.31) -[2.4.30](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.30) | 2023-02-16 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.30](https://github.com/swagger-api/swagger-codegen/tree/v2.4.30) -[2.4.29](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.29) | 2022-11-10 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.29](https://github.com/swagger-api/swagger-codegen/tree/v2.4.29) -[2.4.28](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.28) | 2022-08-15 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.28](https://github.com/swagger-api/swagger-codegen/tree/v2.4.28) -[2.4.27](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.27) | 2022-04-12 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.27](https://github.com/swagger-api/swagger-codegen/tree/v2.4.27) -[2.4.26](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.26) | 2022-02-07 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.26](https://github.com/swagger-api/swagger-codegen/tree/v2.4.26) -[2.4.25](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.25) | 2021-12-28 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.25](https://github.com/swagger-api/swagger-codegen/tree/v2.4.25) -[2.4.24](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.24) | 2021-11-18 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.24](https://github.com/swagger-api/swagger-codegen/tree/v2.4.24) -[2.4.23](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.23) | 2021-10-08 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.23](https://github.com/swagger-api/swagger-codegen/tree/v2.4.23) -[2.4.22](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.22) | 2021-09-30 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.22](https://github.com/swagger-api/swagger-codegen/tree/v2.4.22) -[2.4.21](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.21) | 2021-06-28 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.21](https://github.com/swagger-api/swagger-codegen/tree/v2.4.21) -[2.4.20](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.20) | 2021-05-28 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.20](https://github.com/swagger-api/swagger-codegen/tree/v2.4.20) -[2.4.19](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.19) | 2021-03-04 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.19](https://github.com/swagger-api/swagger-codegen/tree/v2.4.19) -[2.4.18](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.18) | 2020-12-29 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.18](https://github.com/swagger-api/swagger-codegen/tree/v2.4.18) -[2.4.17](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.17) | 2020-11-02 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.17](https://github.com/swagger-api/swagger-codegen/tree/v2.4.17) -[2.4.16](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.16) | 2020-10-05 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.16](https://github.com/swagger-api/swagger-codegen/tree/v2.4.16) -[2.4.15](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.15) | 2020-07-28 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.15](https://github.com/swagger-api/swagger-codegen/tree/v2.4.15) -[2.4.14](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.14) | 2020-05-18 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.14](https://github.com/swagger-api/swagger-codegen/tree/v2.4.14) -[2.4.13](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.13) | 2020-04-02 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.13](https://github.com/swagger-api/swagger-codegen/tree/v2.4.13) -[2.4.12](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.12) | 2020-01-15 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.12](https://github.com/swagger-api/swagger-codegen/tree/v2.4.12) -[2.4.11](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.11) | 2020-01-03 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.11](https://github.com/swagger-api/swagger-codegen/tree/v2.4.11) -[2.4.10](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.10) | 2019-11-16 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.10](https://github.com/swagger-api/swagger-codegen/tree/v2.4.10) -[2.4.9](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.9) | 2019-10-14 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.9](https://github.com/swagger-api/swagger-codegen/tree/v2.4.9) -[2.4.8](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.8) | 2019-08-24 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.8](https://github.com/swagger-api/swagger-codegen/tree/v2.4.8) -[2.4.7](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.7) | 2019-07-11 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.7](https://github.com/swagger-api/swagger-codegen/tree/v2.4.7) -[2.4.6](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.6) | 2019-06-28 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.6](https://github.com/swagger-api/swagger-codegen/tree/v2.4.6) -[2.4.5](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.5) | 2019-04-25 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.5](https://github.com/swagger-api/swagger-codegen/tree/v2.4.5) -[2.4.4](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.4) | 2019-03-26 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.4](https://github.com/swagger-api/swagger-codegen/tree/v2.4.4) -[2.4.2](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.2) | 2019-02-18 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.2](https://github.com/swagger-api/swagger-codegen/tree/v2.4.2) -[2.4.1](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.1) | 2019-01-16 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.1](https://github.com/swagger-api/swagger-codegen/tree/v2.4.1) -[2.4.0](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.0) | 2018-11-30 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.0](https://github.com/swagger-api/swagger-codegen/tree/v2.4.0) -[2.3.1](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.3.1) | 2018-01-17 | 1.0, 1.1, 1.2, 2.0 | [tag v2.3.1](https://github.com/swagger-api/swagger-codegen/tree/v2.3.1) -[2.3.0](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.3.0) | 2017-12-21 | 1.0, 1.1, 1.2, 2.0 | [tag v2.3.0](https://github.com/swagger-api/swagger-codegen/tree/v2.3.0) -[2.2.3](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.2.3) | 2017-07-15 | 1.0, 1.1, 1.2, 2.0 | [tag v2.2.3](https://github.com/swagger-api/swagger-codegen/tree/v2.2.3) -[2.2.2](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.2.2) | 2017-03-01 | 1.0, 1.1, 1.2, 2.0 | [tag v2.2.2](https://github.com/swagger-api/swagger-codegen/tree/v2.2.2) -[2.2.1](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.2.1) | 2016-08-07 | 1.0, 1.1, 1.2, 2.0 | [tag v2.2.1](https://github.com/swagger-api/swagger-codegen/tree/v2.2.1) -[2.1.6](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.1.6) | 2016-04-06 | 1.0, 1.1, 1.2, 2.0 | [tag v2.1.6](https://github.com/swagger-api/swagger-codegen/tree/v2.1.6) -2.0.17 | 2014-08-22 | 1.1, 1.2 | [tag v2.0.17](https://github.com/swagger-api/swagger-codegen/tree/2.0.17) -1.0.4 | 2012-04-12 | 1.0, 1.1 | [tag v1.0.4](https://github.com/swagger-api/swagger-codegen/tree/swagger-codegen_2.9.1-1.1) - -### Prerequisites -If you're looking for the latest stable version, you can grab it directly from Maven.org (Java 8 runtime at a minimum): - -```sh -# Download current stable 2.x.x branch (Swagger and OpenAPI version 2) -wget https://repo1.maven.org/maven2/io/swagger/swagger-codegen-cli/2.4.43/swagger-codegen-cli-2.4.43.jar -O swagger-codegen-cli.jar - -java -jar swagger-codegen-cli.jar help - -# Download current stable 3.x.x branch (OpenAPI version 3) -wget https://repo1.maven.org/maven2/io/swagger/codegen/v3/swagger-codegen-cli/3.0.61/swagger-codegen-cli-3.0.61.jar -O swagger-codegen-cli.jar - -java -jar swagger-codegen-cli.jar --help -``` -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. `Invoke-WebRequest -OutFile swagger-codegen-cli.jar https://repo1.maven.org/maven2/io/swagger/swagger-codegen-cli/2.4.43/swagger-codegen-cli-2.4.43.jar` +💁 Here's also an overview of what's coming around the corner: -On a mac, it's even easier with `brew`: -```sh -brew install swagger-codegen -``` - -To build from source, you need the following installed and available in your `$PATH:` - -* [Java 11+](http://java.oracle.com) - -* [Apache maven 3.6.2 or greater](http://maven.apache.org/) - -#### OS X Users -Don't forget to install Java 11+. - -Export `JAVA_HOME` in order to use the supported Java version: -```sh -export JAVA_HOME=`/usr/libexec/java_home -v 11` -export PATH=${JAVA_HOME}/bin:$PATH -``` - -### Building - -After cloning the project, you can build it from source with this command: -```sh -mvn clean package -``` - -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 -./mvnw clean package -``` - -### Homebrew +Swagger Codegen Version | Release Date | Swagger / OpenAPI Spec compatibility | Notes +-------------------------- |--------------| -------------------------- | ----- +3.0.63-SNAPSHOT (current 3.0.0, upcoming minor release) [SNAPSHOT](https://oss.sonatype.org/content/repositories/snapshots/io/swagger/codegen/v3/swagger-codegen-cli/3.0.63-SNAPSHOT/)| TBD | 1.0, 1.1, 1.2, 2.0, 3.0 | Minor release +2.4.44-SNAPSHOT (current master, upcoming minor release) [SNAPSHOT](https://oss.sonatype.org/content/repositories/snapshots/io/swagger/swagger-codegen-cli/2.4.44-SNAPSHOT/)| TBD | 1.0, 1.1, 1.2, 2.0 | Minor release -To install, run `brew install swagger-codegen` +For detailed breakdown of all versions, please see the [full compatibility listing](./docs/compatibility.md). -Here is an example usage: -```sh -swagger-codegen generate -i https://petstore.swagger.io/v2/swagger.json -l ruby -o /tmp/test/ -``` +### Getting Started -### Docker +To get up and running with Swagger Codegen, check out the following guides and instructions: -#### Development in docker +- [Prerequisites](./docs/prerequisites.md) +- [Building](./docs/building.md) +- [Using Docker](./docs/docker.md) -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. +Once you've your environment setup, you're ready to start generating clients and/or servers. -To execute `mvn package`: +As a quick example, to generate a PHP client for https://petstore.swagger.io/v2/swagger.json, you can run the following: ```sh git clone https://github.com/swagger-api/swagger-codegen cd swagger-codegen -./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 swagger-codegen-cli. To generate code, you'll need to output to a directory under `/gen` (e.g. `/gen/out`). For example: - -```sh -./run-in-docker.sh help # Executes 'help' command for swagger-codegen-cli -./run-in-docker.sh langs # Executes 'langs' command for swagger-codegen-cli -./run-in-docker.sh /gen/bin/go-petstore.sh # Builds the Go client -./run-in-docker.sh generate -i modules/swagger-codegen/src/test/resources/2_0/petstore.yaml \ - -l go -o /gen/out/go-petstore -DpackageName=petstore # generates go client, outputs locally to ./out/go-petstore +mvn clean package +java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ + -i https://petstore.swagger.io/v2/swagger.json \ + -l php \ + -o /var/tmp/php_api_client ``` -#### Standalone generator Development in docker - -See [standalone generator development](https://github.com/swagger-api/swagger-codegen/blob/master/standalone-gen-dev/standalone-generator-development.md) - -#### Run Docker in Vagrant -Prerequisite: install [Vagrant](https://www.vagrantup.com/downloads.html) and [VirtualBox](https://www.virtualbox.org/wiki/Downloads). - ```sh -git clone http://github.com/swagger-api/swagger-codegen.git -cd swagger-codegen -vagrant up -vagrant ssh -cd /vagrant -./run-in-docker.sh mvn package - ``` - -#### Public Pre-built Docker images - - - https://hub.docker.com/r/swaggerapi/swagger-generator/ (official web service) - - https://hub.docker.com/r/swaggerapi/swagger-codegen-cli/ (official CLI) - -##### Swagger Generator Docker Image - -The Swagger Generator 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 (note this assumes `jq` is installed for command line processing of JSON): +**Note:** if you're on Windows, replace the last command with ```sh -# Start container and save the container id -CID=$(docker run -d swaggerapi/swagger-generator) -# allow for startup -sleep 5 -# Get the IP of the running container -GEN_IP=$(docker inspect --format '{{.NetworkSettings.IPAddress}}' $CID) -# Execute an HTTP request and store the download link -RESULT=$(curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{ - "swaggerUrl": "https://petstore.swagger.io/v2/swagger.json" -}' 'http://localhost:8188/api/gen/clients/javascript' | jq '.link' | tr -d '"') -# Download the generated zip and redirect to a file -curl $RESULT > result.zip -# Shutdown the swagger generator image -docker stop $CID && docker rm $CID +java -jar modules\swagger-codegen-cli\target\swagger-codegen-cli.jar generate -i https://petstore.swagger.io/v2/swagger.json -l php -o c:\temp\php_api_client ``` -In the example above, `result.zip` will contain the generated client. - -##### Swagger Codegen CLI Docker Image - -The Swagger Codegen 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. +You can also download the JAR (latest release) directly from [maven.org](https://repo1.maven.org/maven2/io/swagger/swagger-codegen-cli/2.4.43/swagger-codegen-cli-2.4.43.jar) -Example: +To get a list of **general** options available, you can run the following: ```sh -docker run --rm -v ${PWD}:/local swaggerapi/swagger-codegen-cli generate \ - -i https://petstore.swagger.io/v2/swagger.json \ - -l go \ - -o /local/out/go +java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar help generate ``` -(On Windows replace `${PWD}` with `%CD%`) +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 -The generated code will be located under `./out/go` in the current directory. - -## Getting Started - -To generate a PHP client for https://petstore.swagger.io/v2/swagger.json, please run the following ```sh -git clone https://github.com/swagger-api/swagger-codegen -cd swagger-codegen -mvn clean package -java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ - -i https://petstore.swagger.io/v2/swagger.json \ - -l php \ - -o /var/tmp/php_api_client +java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar config-help -l php ``` -(if you're on Windows, replace the last command with `java -jar modules\swagger-codegen-cli\target\swagger-codegen-cli.jar generate -i https://petstore.swagger.io/v2/swagger.json -l php -o c:\temp\php_api_client`) - -You can also download the JAR (latest release) directly from [maven.org](https://repo1.maven.org/maven2/io/swagger/swagger-codegen-cli/2.4.43/swagger-codegen-cli-2.4.43.jar) - -To get a list of **general** options available, please run `java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar help generate` (for version 3.x check [3.0.0 branch](https://github.com/swagger-api/swagger-codegen/tree/3.0.0)) - -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/swagger-codegen-cli/target/swagger-codegen-cli.jar config-help -l php` ## Generators ### To generate a sample client library + You can build a client against the swagger sample [petstore](https://petstore.swagger.io) API as follows: ```sh @@ -431,7 +134,7 @@ java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ with a number of options. You can get the options with the `help generate` command (below only shows partial results): -``` +```text NAME swagger-codegen-cli generate - Generate code with chosen lang @@ -492,273 +195,22 @@ Other languages have petstore samples, too: ### Generating libraries from your server It's just as easy--just use the `-i` flag to point to either a server or file. -### Modifying the client library format -Don't like the default swagger client syntax? Want a different language supported? No problem! Swagger Codegen processes mustache templates with the [jmustache](https://github.com/samskivert/jmustache) engine. You can modify our templates or make your own. - -You can look at `modules/swagger-codegen/src/main/resources/${your-language}` for examples. To make your own templates, create your own files and use the `-t` flag to specify your template folder. It actually is that easy. - -### Making your own codegen modules -If you're starting a project with a new language and don't see what you need, Swagger Codegen can help you create a project to generate your own libraries: - -```sh -java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar meta \ - -o output/myLibrary -n myClientCodegen -p com.my.company.codegen -``` - -This will write, in the folder `output/myLibrary`, all the files you need to get started, including a `README.md. Once modified and compiled, you can load your library with the codegen and generate clients with your own, custom-rolled logic. - -You would then compile your library in the `output/myLibrary` folder with `mvn package` and execute the codegen like such: - -```sh -java -cp output/myLibrary/target/myClientCodegen-swagger-codegen-1.0.0.jar:modules/swagger-codegen-cli/target/swagger-codegen-cli.jar io.swagger.codegen.SwaggerCodegen -``` -For Windows users, you will need to use `;` instead of `:` in the classpath, e.g. -``` -java -cp output/myLibrary/target/myClientCodegen-swagger-codegen-1.0.0.jar;modules/swagger-codegen-cli/target/swagger-codegen-cli.jar io.swagger.codegen.SwaggerCodegen -``` - -Note the `myClientCodegen` is an option now, and you can use the usual arguments for generating your library: - -```sh -java -cp output/myLibrary/target/myClientCodegen-swagger-codegen-1.0.0.jar:modules/swagger-codegen-cli/target/swagger-codegen-cli.jar \ - io.swagger.codegen.SwaggerCodegen generate -l myClientCodegen\ - -i https://petstore.swagger.io/v2/swagger.json \ - -o myClient -``` - -See also [standalone generator development](https://github.com/swagger-api/swagger-codegen/blob/master/standalone-gen-dev/standalone-generator-development.md) - -### Where is Javascript??? -See our [javascript library](http://github.com/swagger-api/swagger-js)--it's completely dynamic and doesn't require -static code generation. -There is a third-party component called [swagger-js-codegen](https://github.com/wcandillon/swagger-js-codegen) that can generate angularjs or nodejs source code from an OpenAPI Specification. - -:exclamation: On Dec 7th 2015, a Javascript API client generator has been added by @jfiala. - -### Generating a client from local files -If you don't want to call your server, you can save the OpenAPI Spec files into a directory and pass an argument -to the code generator like this: - -``` --i ./modules/swagger-codegen/src/test/resources/2_0/petstore.json -``` - -Great for creating libraries on your ci server, from the [Swagger Editor](http://editor.swagger.io)... or while coding on an airplane. +🔧 Swagger Codegen comes with a tonne of flexibility to support your code generation preferences. Checkout the [generators documentation](./docs/generators.md) which takes you through some of the possibilities as well as showcasing how to generate from local files and ignore file formats. ### Selective generation -You may not want to generate *all* models in your project. Likewise you may want just one or two apis to be written. If that's the case, you can use system properties to control the output: -The default is generate *everything* supported by the specific library. Once you enable a feature, it will restrict the contents generated: +You may not want to generate *all* models in your project. Likewise you may want just one or two apis to be written. If that's the case check the [selective generation](./docs/generation-selective.md) instructions. -```sh -# generate only models -java -Dmodels {opts} - -# generate only apis -java -Dapis {opts} -# generate only supporting files -java -DsupportingFiles - -# generate models and supporting files -java -Dmodels -DsupportingFiles -``` - -To control the specific files being generated, you can pass a CSV list of what you want: -```sh -# generate the User and Pet models only --Dmodels=User,Pet - -# generate the User model and the supportingFile `StringUtil.java`: --Dmodels=User -DsupportingFiles=StringUtil.java -``` - -To control generation of docs and tests for api and models, pass false to the option. For api, these options are `-DapiTests=false` and `-DapiDocs=false`. For models, `-DmodelTests=false` and `-DmodelDocs=false`. -These options default to true and don't limit the generation of the feature options listed above (like `-Dapi`): - -```sh -# generate only models (with tests and documentation) -java -Dmodels {opts} - -# generate only models (with tests but no documentation) -java -Dmodels -DmodelDocs=false {opts} - -# generate only User and Pet models (no tests and no documentation) -java -Dmodels=User,Pet -DmodelTests=false {opts} - -# generate only apis (without tests) -java -Dapis -DapiTests=false {opts} - -# generate only apis (modelTests option is ignored) -java -Dapis -DmodelTests=false {opts} -``` - -When using selective generation, _only_ the templates needed for the specific generation will be used. - -### Ignore file format - -Swagger Codegen supports a `.swagger-codegen-ignore` file, similar to `.gitignore` or `.dockerignore` you're probably already familiar with. - -The ignore file allows for better control over overwriting existing files than the `--skip-overwrite` flag. With the ignore file, you can specify individual files or directories can be ignored. This can be useful, for example if you only want a subset of the generated code. - -Examples: - -```sh -# Swagger Codegen Ignore -# Lines beginning with a # are comments - -# This should match build.sh located anywhere. -build.sh - -# Matches build.sh in the root -/build.sh - -# Exclude all recursively -docs/** - -# Explicitly allow files excluded by other rules -!docs/UserApi.md - -# Recursively exclude directories named Api -# You can't negate files below this directory. -src/**/Api/ - -# When this file is nested under /Api (excluded above), -# this rule is ignored because parent directory is excluded by previous rule. -!src/**/PetApiTests.cs - -# Exclude a single, nested file explicitly -src/IO.Swagger.Test/Model/AnimalFarmTests.cs -``` - -The `.swagger-codegen-ignore` file must exist in the root of the output directory. - -Upon first code generation, you may also pass the CLI option `--ignore-file-override=/path/to/ignore_file` for greater control over generated outputs. Note that this is a complete override, and will override the `.swagger-codegen-ignore` file in an output directory when regenerating code. - -Editor support for `.swagger-codegen-ignore` files is available in IntelliJ via the [.ignore plugin](https://plugins.jetbrains.com/plugin/7495--ignore). - -### Customizing the generator - -There are different aspects of customizing the code generator beyond just creating or modifying templates. Each language has a supporting configuration file to handle different type mappings, etc: - -```sh -$ ls -1 modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/ -AbstractJavaJAXRSServerCodegen.java -AbstractTypeScriptClientCodegen.java -... (results omitted) -TypeScriptAngularClientCodegen.java -TypeScriptNodeClientCodegen.java -``` - -Each of these files creates reasonable defaults so you can get running quickly. But if you want to configure package names, prefixes, model folders, etc. you can use a json config file to pass the values. - -```sh -java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ - -i https://petstore.swagger.io/v2/swagger.json \ - -l java \ - -o samples/client/petstore/java \ - -c path/to/config.json -``` -and `config.json` contains the following as an example: -```json -{ - "apiPackage" : "petstore" -} -``` - -Supported config options can be different per language. Running `config-help -l {lang}` will show available options. -**These options are applied via configuration file (e.g. config.json) or by passing them with `java -jar swagger-codegen-cli.jar -D{optionName}={optionValue}`**. (If `-D{optionName}` does not work, please open a [ticket](https://github.com/swagger-api/swagger-codegen/issues/new) and we'll look into it) - -```sh -java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar config-help -l java -``` - -Output - -``` -CONFIG OPTIONS - modelPackage - package for generated models - - apiPackage - package for generated api classes -...... (results omitted) - library - library template (sub-template) to use: - jersey1 - HTTP client: Jersey client 1.18. JSON processing: Jackson 2.4.2 - jersey2 - HTTP client: Jersey client 2.6 - feign - HTTP client: Netflix Feign 8.1.1. JSON processing: Jackson 2.6.3 - okhttp-gson (default) - HTTP client: OkHttp 2.4.0. JSON processing: Gson 2.3.1 - retrofit - HTTP client: OkHttp 2.4.0. JSON processing: Gson 2.3.1 (Retrofit 1.9.0) - retrofit2 - HTTP client: OkHttp 2.5.0. JSON processing: Gson 2.4 (Retrofit 2.0.0-beta2) - google-api-client - HTTP client: google-api-client 1.23.0. JSON processing: Jackson 2.8.9 - rest-assured - HTTP client: rest-assured : 3.1.0. JSON processing: Gson 2.6.1. Only for Java8 -``` - -Your config file for Java can look like - -```json -{ - "groupId": "com.my.company", - "artifactId": "MyClient", - "artifactVersion": "1.2.0", - "library": "feign" -} -``` - -For all the unspecified options default values will be used. - -Another way to override default options is to extend the config class for the specific language. -To change, for example, the prefix for the Objective-C generated files, simply subclass the `ObjcClientCodegen.java`: - -```java -package com.mycompany.swagger.codegen; - -import io.swagger.codegen.languages.*; - -public class MyObjcCodegen extends ObjcClientCodegen { - static { - PREFIX = "HELO"; - } -} -``` - -and specify the `classname` when running the generator: - -``` --l com.mycompany.swagger.codegen.MyObjcCodegen -``` - -Your subclass will now be loaded and overrides the `PREFIX` value in the superclass. - -### Bringing your own models - -Sometimes you don't want a model generated. In this case, you can simply specify an import mapping to tell -the codegen what _not_ to create. When doing this, every location that references a specific model will -refer back to your classes. Note, this may not apply to all languages... - -To specify an import mapping, use the `--import-mappings` argument and specify the model-to-import logic as such: - -``` ---import-mappings Pet=my.models.MyPet -``` - -Or for multiple mappings: - -``` ---import-mappings Pet=my.models.MyPet,Order=my.models.MyOrder -``` -or -``` ---import-mappings Pet=my.models.MyPet --import-mappings Order=my.models.MyOrder -``` +### Advanced Generator Customization +There are different aspects of customizing the code generator beyond just creating or modifying templates. Each language has a supporting configuration file to handle different type mappings, or bring your own models. For more information check out the [advanced configuration docs](./docs/generators-configuration.md). ### Validating your OpenAPI Spec -You have options. The easiest is to use our [online validator](https://github.com/swagger-api/validator-badge) which not only will let you validate your spec, but with the debug flag, you can see what's wrong with your spec. For example: +You have options. The easiest is to use our [online validator](https://github.com/swagger-api/validator-badge) which not only will let you validate your spec, but with the debug flag, you can see what's wrong with your spec. For example check out [Swagger Validator](http://online.swagger.io/validator/debug?url=https://petstore.swagger.io/v2/swagger.json). -http://online.swagger.io/validator/debug?url=https://petstore.swagger.io/v2/swagger.json +If you want to have validation directly on your own machine, then [Spectral](https://stoplight.io/open-source/spectral) is an excellent option. ### Generating dynamic html api documentation @@ -772,7 +224,6 @@ node . Which launches a node.js server so the AJAX calls have a place to go. - ### Generating static html api documentation To do so, just use the `-l html` flag when reading a spec file. This creates a single, simple HTML file with embedded css so you can ship it as an email attachment, or load it from your filesystem: @@ -782,522 +233,42 @@ cd samples/html/ open index.html ``` - -### To build a server stub - -Please refer to https://github.com/swagger-api/swagger-codegen/wiki/Server-stub-generator-HOWTO for more information. - -### To build the codegen library - -This will create the Swagger Codegen library from source. - -```sh -mvn package -``` - -Note! The templates are included in the library generated. If you want to modify the templates, you'll need to either repackage the library OR specify a path to your scripts - ## Workflow Integration -### Maven Integration +It's possible to leverage Swagger Codegen directly within your preferred CI/CD workflows to streamline your auto-generation requirements. Check out the [workflows integration](./docs/workflow-integration.md) guide to see information on our Maven, Gradle, and GitHub integration options. 🚀 -You can use the [swagger-codegen-maven-plugin](modules/swagger-codegen-maven-plugin/README.md) for integrating with your workflow, and generating any codegen target. +## Online Generators -### Gradle Integration +If you don't want to run and host your own code generation instance, check our our [online generators](./docs/online-generators.md) information. -[Gradle Swagger Generator Plugin](https://github.com/int128/gradle-swagger-generator-plugin) is available for generating source code and API document. - -## GitHub Integration - -To push the auto-generated SDK to GitHub, we provide `git_push.sh` to streamline the process. For example: - - 1) Create a new repository in GitHub (Ref: https://help.github.com/articles/creating-a-new-repository/) - - 2) Generate the SDK -```sh - java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ - -i modules/swagger-codegen/src/test/resources/2_0/petstore.json -l perl \ - --git-user-id "swaggerapi" \ - --git-repo-id "petstore-perl" \ - --release-note "Github integration demo" \ - -o /var/tmp/perl/petstore -``` - 3) Push the SDK to GitHub -```sh -cd /var/tmp/perl/petstore -/bin/sh ./git_push.sh -``` - -## Online generators - -One can also generate API client or server using the online generators (https://generator.swagger.io) - -For example, to generate Ruby API client, simply send the following HTTP request using curl: -```sh -curl -X POST -H "content-type:application/json" -d '{"swaggerUrl":"https://petstore.swagger.io/v2/swagger.json"}' https://generator.swagger.io/api/gen/clients/ruby -``` -Then you will receive a JSON response with the URL to download the zipped code. - -To customize the SDK, you can `POST` to `https://generator.swagger.io/api/gen/clients/{language}` with the following HTTP body: -```json -{ - "options": {}, - "swaggerUrl": "https://petstore.swagger.io/v2/swagger.json" -} -``` -in which the `options` for a language can be obtained by submitting a `GET` request to `https://generator.swagger.io/api/gen/clients/{language}`: - -For example, `curl https://generator.swagger.io/api/gen/clients/python` returns -```json -{ - "packageName": { - "opt": "packageName", - "description": "python package name (convention: snake_case).", - "type": "string", - "default": "swagger_client" - }, - "packageVersion": { - "opt": "packageVersion", - "description": "python package version.", - "type": "string", - "default": "1.0.0" - }, - "sortParamsByRequiredFlag": { - "opt": "sortParamsByRequiredFlag", - "description": "Sort method arguments to place required parameters before optional parameters.", - "type": "boolean", - "default": "true" - } -} -``` -To set package name to `pet_store`, the HTTP body of the request is as follows: -```json -{ - "options": { - "packageName": "pet_store" - }, - "swaggerUrl": "https://petstore.swagger.io/v2/swagger.json" -} -``` -and here is the curl command: -```sh -curl -H "Content-type: application/json" -X POST -d '{"options": {"packageName": "pet_store"},"swaggerUrl": "https://petstore.swagger.io/v2/swagger.json"}' https://generator.swagger.io/api/gen/clients/python -``` - -Instead of using `swaggerUrl` with an URL to the OpenAPI/Swagger spec, one can include the spec in the JSON payload with `spec`, e.g. -```json -{ - "options": {}, - "spec": { - "swagger": "2.0", - "info": { - "version": "1.0.0", - "title": "Test API" - }, - ... - } -} -``` - -Guidelines for Contribution ---------------------------- +## Contributing Please refer to this [page](https://github.com/swagger-api/swagger-codegen/blob/master/CONTRIBUTING.md) -Companies/Projects using Swagger Codegen ----------------------------------------- -Here are some companies/projects using Swagger Codegen in production. To add your company/project to the list, please visit [README.md](https://github.com/swagger-api/swagger-codegen/blob/master/README.md) and click on the icon to edit the page. -- [Acando](https://www.acando.de/) -- [Accengage](https://www.accengage.com/) -- [Accruent](https://www.accruent.com/) -- [Activehours](https://www.activehours.com/) -- [Actonica](https://www.actonica.com) -- [Acunetix](https://www.acunetix.com/) -- [Adaptant](https://www.adaptant.io/) -- [Atlassian](https://www.atlassian.com/) -- [Autodesk](http://www.autodesk.com/) -- [Avenida Compras S.A.](https://www.avenida.com.ar) -- [AYLIEN](http://aylien.com/) -- [Balance Internet](https://www.balanceinternet.com.au/) -- [beemo](http://www.beemo.eu) -- [bitly](https://bitly.com) -- [BeezUP](http://www.beezup.com) -- [Box](https://box.com) -- [Bufferfly Network](https://www.butterflynetinc.com/) -- [Cachet Financial](http://www.cachetfinancial.com/) -- [carpolo](http://www.carpolo.co/) -- [Carus](https://www.carus.com/) -- [Cisco](http://www.cisco.com/) -- [CloudBoost](https://www.CloudBoost.io/) -- [Cloudsmith](https://cloudsmith.io/) -- [Conplement](http://www.conplement.de/) -- [Cummins](http://www.cummins.com/) -- [Cupix](http://www.cupix.com) -- [DBBest Technologies](https://www.dbbest.com) -- [DecentFoX](http://decentfox.com/) -- [DocRaptor](https://docraptor.com) -- [DocuSign](https://www.docusign.com) -- [Elastic](https://www.elastic.co/) -- [Ergon](http://www.ergon.ch/) -- [Dell EMC](https://www.emc.com/) -- [eureka](http://eure.jp/) -- [everystory.us](http://everystory.us) -- [Expected Behavior](http://www.expectedbehavior.com/) -- [fashionTrade](https://www.fashiontrade.com/) -- [Fastly](https://www.fastly.com/) -- [FINRA](https://github.com/FINRAOS/herd/) -- [Flat](https://flat.io) -- [Finder](http://en.finder.pl/) -- [Fitwell](https://fitwell.co/) -- [FH Münster - University of Applied Sciences](http://www.fh-muenster.de) -- [FormAPI](https://formapi.io/) -- [Fotition](https://www.fotition.com/) -- [Gear Zero Network](https://www.gearzero.ca) -- [General Electric](https://www.ge.com/) -- [Genentech](https://gene.com) -- [Genesys - PureCloud](http://developer.mypurecloud.com/) -- [Germin8](http://www.germin8.com) -- [GigaSpaces](http://www.gigaspaces.com) -- [GMO Pepabo](https://pepabo.com/en/) -- [goTransverse](http://www.gotransverse.com/api) -- [GraphHopper](https://graphhopper.com/) -- [Gravitate Solutions](http://gravitatesolutions.com/) -- [HashData](http://www.hashdata.cn/) -- [Hewlett Packard Enterprise](https://hpe.com) -- [High Technologies Center](http://htc-cs.com) -- [Hootsuite](https://hootsuite.com/) -- [Huawei Cloud](http://www.huaweicloud.com/en-us/product/cs.html) -- [Husbanken](https://www.husbanken.no) -- [IBM](https://www.ibm.com) -- [IMS Health](http://www.imshealth.com/en/solution-areas/technology-and-applications) -- [Individual Standard IVS](http://www.individual-standard.com) -- [INSPIDE](http://www.inspide.com) -- [Intent HQ](http://www.intenthq.com) -- [Kabuku](http://www.kabuku.co.jp/en) -- [Kurio](https://kurio.co.id) -- [Kuroi](http://kuroiwebdesign.com/) -- [Kuary](https://kuary.com/) -- [Kubernetes](https://kubernetes.io/) -- [LANDR Audio](https://www.landr.com/) -- [Lascaux](http://www.lascaux.it/) -- [Leanix](http://www.leanix.net/) -- [Leica Geosystems AG](http://leica-geosystems.com) -- [LiveAgent](https://www.ladesk.com/) -- [LXL Tech](http://lxltech.com) -- [Lyft](https://www.lyft.com/developers) -- [MailMojo](https://mailmojo.no/) -- [Metaswitch](https://www.metaswitch.com/) -- [Mindera](http://mindera.com/) -- [ModuleQ](https://moduleq.com) -- [Mporium](http://mporium.com/) -- [Neverfail](https://neverfail.com/) -- [NexCap](http://www.nexess-solutions.com/fr/plateforme-iot/) -- [Nitrobox](https://www.nitrobox.com) -- [Norwegian Air Shuttle](https://www.norwegian.com/) -- [NTT DATA](http://www.nttdata.com/) -- [nViso](http://www.nviso.ch/) -- [NHSD](https://digital.nhs.uk/) -- [Okiok](https://www.okiok.com) -- [Onedata](http://onedata.org) -- [Open International Systems](https://openintl.com/) -- [OrderCloud.io](http://ordercloud.io) -- [OSDN](https://osdn.jp) -- [PagerDuty](https://www.pagerduty.com) -- [PagerTree](https://pagertree.com) -- [Pepipost](https://www.pepipost.com) -- [Peatio Tech](https://www.peatio.tech) -- [Plexxi](http://www.plexxi.com) -- [Pixoneye](http://www.pixoneye.com/) -- [PostAffiliatePro](https://www.postaffiliatepro.com/) -- [PracticeBird](https://www.practicebird.com/) -- [Prill Tecnologia](http://www.prill.com.br) -- [Prokarma](https://www.prokarma.com) -- [QAdept](http://qadept.com/) -- [QuantiModo](https://quantimo.do/) -- [QuickBlox](https://quickblox.com/) -- [Rapid7](https://rapid7.com/) -- [Red Hat](https://www.redhat.com/) -- [Reload! A/S](https://reload.dk/) -- [REstore](https://www.restore.eu) -- [REST United](https://restunited.com) -- [Revault Sàrl](http://revault.ch) -- [Riffyn](https://riffyn.com) -- [Roche](https://roche.com) -- [Royal Bank of Canada (RBC)](http://www.rbc.com/canada.html) -- [Saritasa](https://www.saritasa.com/) -- [SAS](https://www.sas.com) -- [SCOOP Software GmbH](http://www.scoop-software.de) -- [SessionM](https://www.sessionm.com/) -- [Shine Solutions](https://shinesolutions.com/) -- [Simpfony](https://www.simpfony.com/) -- [Skurt](http://www.skurt.com) -- [Slamby](https://www.slamby.com/) -- [SmartRecruiters](https://www.smartrecruiters.com/) -- [snapCX](https://snapcx.io) -- [SPINEN](http://www.spinen.com) -- [Sponsoo](https://www.sponsoo.de) -- [SRC](https://www.src.si/) -- [Stardog Ventures](https://www.stardog.io) -- [Stingray](http://www.stingray.com) -- [StyleRecipe](http://stylerecipe.co.jp) -- [Svenska Spel AB](https://www.svenskaspel.se/) -- [Switch Database](https://www.switchdatabase.com/) -- [TaskData](http://www.taskdata.com/) -- [ThirdWatch.ai](https://www.thirdwatch.ai/) -- [ThoughtWorks](https://www.thoughtworks.com) -- [Tpay](https://tpay.com) -- [Trexle](https://trexle.com/) -- [Upwork](http://upwork.com/) -- [uShip](https://www.uship.com/) -- [Variograma](https://variograma.pt) -- [VMware](https://vmware.com/) -- [Viavi Solutions Inc.](https://www.viavisolutions.com) -- [W.UP](http://wup.hu/?siteLang=en) -- [Wealthfront](https://www.wealthfront.com/) -- [Webever GmbH](https://www.webever.de/) -- [WEXO A/S](https://www.wexo.dk/) -- [XSky](http://www.xsky.com/) -- [Yelp](http://www.yelp.com/) -- [Zalando](https://tech.zalando.com) -- [ZEEF.com](https://zeef.com/) -- [zooplus](https://www.zooplus.com/) -- [Trifork](https://www.trifork.com/) - -Presentations/Videos/Tutorials/Books ----------------------------------------- -- 2011/08/31 - [Introducing Swagger](https://www.slideshare.net/fehguy/introducing-swagger) by [Tony Tam](https://twitter.com/fehguy) -- 2014/05/22 - [Swagger APIs for Humans and Robots](https://www.slideshare.net/fehguy/swagger-apis-for-humans-and-robots-gluecon) by [Tony Tam](https://twitter.com/fehguy) at [Gluecon](http://gluecon.com/) -- 2014/11/11 - [Genie 2.0: Second Wish Granted!](https://medium.com/netflix-techblog/genie-2-0-second-wish-granted-d888d79455c6) by [Tom Gianos](http://www.linkedin.com/in/thomasgianos/) and [Amit Sharma](https://www.linkedin.com/pub/amit-sharma/5/163/a83) @ [Netflix](https://www.netflix.com/) Big Data Platform Team -- 2015/07/28 - [Enriching RESTful Services with Swagger](https://blog.philipphauer.de/enriching-restful-services-swagger/) by [Philipp Hauer](https://blog.philipphauer.de/) -- 2015/11/11 - [Generate client stubs & document your REST-API using Swagger & Spring](https://www.youtube.com/watch?v=43GhBbP--oI) by [Johannes Fiala](https://github.com/jfiala) @ Devoxx Belgium 2015 -- 2015/12/03 - [こんなに簡単! Swagger Codegenのカスタマイズ](http://qiita.com/Quramy/items/c583f3213f0b77ff1bac) by [Quramy](http://qiita.com/Quramy) -- 2016/01/12 - [Generate client side code using Swagger Codegen](http://rnavagamuwa.com/open-source/generate-client-side-code-using-swagger-codegen/) by [RNAVAGAMUWA](http://rnavagamuwa.com/author/admin/) -- 2016/01/15 - [How to end manual REST-API client coding](https://www.youtube.com/watch?v=RzZRdqZp6Oo) by [Johannes Fiala](https://github.com/jfiala) @ dotJS 2015 -- 2016/04/27 - [Automated REST API Development](https://yos.io/2016/04/27/automated-api-development/) by [Yos Riady](https://www.linkedin.com/in/yosriady) -- 2016/05/29 - [Generating Java Spring-MVC code from Swagger Spec](https://www.clianz.com/2016/05/29/java-mvc-swagger-gen/) by [@icha024](https://github.com/icha024) -- 2016/07/22 - [Building Microservices? Here is what you should know](https://cloudncode.blog/2016/07/22/msa-getting-started/) by Sumit Maingi -- 2016/08/23 - [Generating Dreamfactory Client SDKs based on Swagger API Definitions](http://blog.dreamfactory.com/generating-dreamfactory-client-sdks-based-on-swagger-api-definitions) by [Phil Schuler](https://github.com/philicious/) -- 2016/09/28 - [1 UNBELIEVABLE TRICK TO CREATE AN EASY TO CONSUME API IN .NET](https://stapp.space/1-simple-trick-to-create-a-good-api-in-net/) by [Piotr Stapp](https://stapp.space/author/piotr-stapp/) -- 2016/10/10 - [Using swagger-codegen with Marketo](http://developers.marketo.com/blog/using-swagger-codegen-with-marketo/) by [Kenny Elkington](http://developers.marketo.com/blog/using-swagger-codegen-with-marketo/) -- 2016/10/12 - [Designing a Swagger API](https://sookocheff.com/post/api/swagger/) by [Kevin Sookocheff](https://sookocheff.com/) -- 2016/11/05 - [How to generate a REST Application](https://www.youtube.com/watch?v=iyC9BWMe75Q) by [Johannes Fiala](https://github.com/jfiala) @ DevFest Vienna 2016 -- 2016/11/10 - [Building an AEM API clients ecosystem](http://blog.cliffano.com/2016/11/10/adobe-marketing-cloud-community-expo/) by Cliffano Subagio, Michael Diender, Stephen Shim from [Shine Solutions](https://shinesolutions.com/) @ [Adobe Marketing Cloud Community Expo (AMCCE)](https://www.meetup.com/Melbourne-AEM-CQ-Meetup/events/233363101/) -- 2016/11/18 - [How to generate a REST CXF3 application from Swagger-Contract](https://www.slideshare.net/johannes_fiala/how-to-generate-a-rest-cxf3-application-from-swagger-apacheconeu-2016) by [Johannes Fiala](https://github.com/jfiala) @ ApacheConEU 2016 -- 2016/11/25 - [Swagger Codegen for Swift3 and NodeJS](https://normand1.github.io/blog/swift/swagger/codegen/2016/11/25/Swagger-Codegen-for-Swift3-and-NodeJS.html) by [David Norman](https://github.com/normand1) -- 2016/12/08 - [Building an API with Swagger](https://www.youtube.com/watch?v=PbwQWw7xSOM) -- 2016/12/08 - [Generate client side code using Swagger Codegen](https://carra-lucia-ltd.co.uk/2016/12/08/generate-client-side-code-using-swagger-codegen/) by [theFerkel](https://carra-lucia-ltd.co.uk/author/theferkel/) -- 2017/01/16 - [Zero to API in 4 minutes](https://cidrblock.github.io/zero-to-api-in-4-minutes.html) by [Bradley A. Thornton](https://github.com/cidrblock) -- 2017/02/09 - [「Swaggerを利用した新規サービス開発」というタイトルで登壇して来ました](https://techblog.recochoku.jp/1055) by [recotech](https://www.slideshare.net/recotech) -- 2017/03/03 - [Swagger Codegen の使い方の簡単な説明です](https://speakerdeck.com/wagyu298/swagger-codegen) by [wagyu298](https://github.com/wagyu298) -- 2017/03/24 - [Using Open API Specification To Put Lyft SDK Support in the Fast Lane](https://medium.com/lyft-developer-platform/using-open-api-specification-to-put-lyft-sdk-support-in-the-fast-lane-7b623218e4ee) by [Val Polouchkine](https://github.com/vpolouchkine) -- 2017/04/13 - [Automatically Generating your API Client with Swagger and Swagger Codegen](https://www.youtube.com/watch?v=EzKwi-u9jQo) by [Jesse Collis](https://github.com/jessedc) @ Melbourne Cocoaheads -- 2017/04/27 - [Swagger Codegen のPHP実装があまりにアレだったので、ライブラリ自作して公開してみた](http://qiita.com/imunew/items/2e9c472e0097e329f2cd) by [imunew](http://qiita.com/imunew) -- 2017/05/17 - [Diseño de APIs con OpenAPI](https://www.slideshare.net/pjmolina/diseo-de-apis-con-openapi) by [Pedro J. Molina](https://github.com/pjmolina) @ [JSDayES 2017](http://2017.jsday.es/) -- 2017/05/22 - [Presentation of the Vert.x-Swagger project](http://vertx.io/blog/presentation-of-the-vert-x-swagger-project/) by [@phiz71](http://github.com/phiz71) -- 2017/05/22 - [Automatically generating your API from a swagger file using gradle](https://www.jcore.com/2017/05/22/automatically-generating-api-using-swagger-and-gradle/) by [Deniz Turan](https://www.jcore.com/author/deniz/) -- 2017/06/21 - [Swagger Presentation - Warsaw Ruby Users Group](https://www.youtube.com/watch?v=uCnnDMFQB8U) by [@rafalpetryka](http://github.com/rafalpetryka) -- 2017/06/29 - [Making SDKs: the bespoke, the hopeful and the generated](https://devrel.net/developer-experience/making-sdks-bespoke-hopeful-generated) by [Tristan Sokol](https://github.com/tristansokol) ([Square](https://github.com/square)) at DevXcon 2017 -- 2017/07/11 - [OpenAPI development with Python](https://www.slideshare.net/TakuroWada/20170711-euro-python2017) by [和田拓朗](https://github.com/taxpon) at [EuroPython 2017](https://ep2017.europython.eu/en/) -- 2017/07/29 - [How Square makes its SDKs](https://medium.com/square-corner-blog/how-square-makes-its-sdks-6a0fd7ea4b2d) by [Tristan Sokol](https://github.com/tristansokol) ([Square](https://github.com/square)) -- 2017/07/31 - [How to Generate a Deployable REST CXF3 Application from a Swagger-Contract](https://www.youtube.com/watch?v=gM63rJlUHZQ) by [Johannes Fiala](https://github.com/jfiala) @ Voxxed Days Vienna -- 2017/08/11 - [Swagger Codegen 自动生成Retrofit 代码](https://juejin.im/entry/598d8eb86fb9a03c52459e2a) by [徐磊](http://www.jianshu.com/u/792c738b33fc) -- 2017/08/24 - [APIs First](https://engineering.squarespace.com/blog/2017/apis-first) by [roykachouh](https://github.com/roykachouh) ([Square](https://github.com/square)) -- 2017/08/31 - [Bringing Jenkins Remote Access API To The Masses](http://blog.cliffano.com/2017/09/01/jenkins-world-2017/) by [Cliffano Subagio](http://cliffano.com) from [Shine Solutions](https://shinesolutions.com/) @ [Jenkins World 2017](https://jenkinsworld20162017.sched.com/) -- 2017/09/08 - [Swagger Codegen で自動生成したクライアントSDKを使う(iOS編)](http://blog.techium.jp/entry/2017/09/08/071650) by [kfurue](http://profile.hatena.ne.jp/kfurue/) -- 2017/09/09 - [Swagger Codegen で自動生成したクライアントSDKを使う(RxSwift 編)](http://blog.techium.jp/entry/2017/09/09/113003) by [kfurue](http://profile.hatena.ne.jp/kfurue/) -- 2017/09/09 - [OpenAPIを利用したPythonWebアプリケーション開発](https://www.slideshare.net/TakuroWada/openapipythonweb) by [和田拓朗](https://github.com/taxpon) at [PyCon JP 2017](https://pycon.jp/2017/ja/) -- 2017/09/21 - [Generating an Elastic Cloud Enterprise Client](https://www.elastic.co/blog/generating-an-elastic-cloud-enterprise-client) by [Greg Marzouka](https://github.com/gmarz) ([Elastic](https://www.elastic.co/)) -- 2017/09/26 - [How to Use IoT Application Enablement Api Hub JSON Descriptor in Postman and How to Generate Client Code](https://www.linkedin.com/in/radu-simen/) by [Radu Simen](https://www.linkedin.com/in/radu-simen/) ([SAP](https://www.sap.com/)) -- 2017/09/28 - [Swagger Codegenで APIクライアントgem 自動生成 #m3kt](https://speakerdeck.com/juntaki/swagger-codegende-apikuraiantogem-zi-dong-sheng-cheng-number-m3kt) by [Jumpei Takiyasu](https://github.com/juntaki) -- 2017/09/30 - [Swaggerのテンプレートを魔改造した話 #渋谷java](https://www.slideshare.net/int128/swagger-80309224) by [Hidetake Iwata](https://github.com/int128) ([NTT DATA Corporation](http://www.nttdata.com/global/en/)) -- 2017/10/04 - [Enterprise-friendly Java client for Microsoft Machine Learning Server](https://blogs.msdn.microsoft.com/mlserver/2017/10/04/enterprise-friendly-java-client-for-microsoft-machine-learning-server/) by [Pratik Palnitkar](https://www.linkedin.com/in/pratikpalnitkar/) ([Microsoft](https://www.microsoft.com/)) -- 2017/10/08 - [Generating a REST Ada client with OpenAPI and Swagger Codegen](https://blog.vacs.fr/vacs/blogs/post.html?post=2017/10/08/Generating-a-REST-Ada-client-with-OpenAPI-and-Swagger-Codegen) by [Stephane Carrez](https://github.com/stcarrez) -- 2017/11/08 - [A Beginner's Guide to Code Generation for REST APIs](https://gum.co/swagger_codegen_beginner)(eBook) by [William Cheng](https://twitter.com/wing328) -- 2017/11/18 - [10年前のレガシーシステムをサーバーサイドKotlinでフルリニューアルしている話 #jjug_ccc #ccc_g2](https://speakerdeck.com/maeharin/10nian-qian-falseregasisisutemuwosabasaidokotlindehururiniyuarusiteiruhua-number-jjug-ccc-number-ccc-g2) by [Hidenori Maehara](https://github.com/maeharin) -- 2017/11/21 - [swagger-codegen から眺める Swift4](https://speakerdeck.com/d_date/swagger-codegen-karatiao-meru-swift4) by [Daiki Matsudate](https://github.com/d-date) -- 2017/12/07 - [API-driven development with OpenAPI and Swagger, Part 2](https://www.itworld.com/article/3199190/apis/api-driven-development-with-openapi-and-swagger-part-2.html) by Matthew Tyson -- 2017/12/29 - [REST APIs代码生成指南](https://gumroad.com/l/swagger_codegen_beginner_zh)(eBook) by [William Cheng](https://github.com/wing328), [Xin Meng](https://github.com/xmeng1) -- 2017/12/21 - [Using Protocol Buffer to Generate SDK at Hootsuite](http://code.hootsuite.com/using-protocol-buffer-to-generate-sdk-at-hoosuite/?lipi=urn%3Ali%3Apage%3Ad_flagship3_messaging%3By4ATz3SDRXyvXJJ14LQysQ%3D%3D) by [Joy Zhang](https://www.linkedin.com/in/joy8zhang/) -- 2018/01/11 - [Swagger 工具箱介绍及代码自动生成示例](https://github.com/qct/swagger-example) by [qct](https://github.com/qct) -- 2018/01/19 - [Generowanie kodu usług REST - przewodnik dla początkujących](https://gum.co/swagger_codegen_beginner_pl)(eBook) by [William Cheng](https://github.com/wing328), [Tomasz Prus](https://github.com/tomplus), [Bartek Kryza](https://github.com/bkryza) -- 2018/02/03 - [Writing REST APIs with OpenAPI and Swagger Ada](https://www.slideshare.net/StephaneCarrez1/writing-rest-apis-with-openapi-and-swagger-ada/StephaneCarrez1/writing-rest-apis-with-openapi-and-swagger-ada) by [Stephane Carrez](https://github.com/stcarrez) at [FOSDEM 2018](https://fosdem.org/2018) -- 2018/02/28 - [OpenAPI–An eBay Perspective](https://www.ebayinc.com/stories/blogs/tech/openapi-an-ebay-perspective/) by Shekhar Banerjee (eBay) -- 2018/03/16 - [REST APIのためのコード生成入門](https://gumroad.com/l/swagger_codegen_beginner_jp) by [William Cheng](https://github.com/wing328), [中野暁人](https://github.com/ackintosh), [和田拓朗](https://github.com/taxpon) - -# Swagger Codegen Core Team +## Swagger Codegen Core Team Swagger Codegen 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 - - -## Template Creator -Here is a list of template creators: - * API Clients: - * Ada: @stcarrez - * Akka-Scala: @cchafer - * Apex: @asnelling - * Bash: @bkryza - * C++ REST: @Danielku15 - * C# (.NET 2.0): @who - * C# (.NET Standard 1.3 ): @Gronsak - * C# (.NET 4.5 refactored): @jimschubert - * Clojure: @xhh - * Dart: @yissachar - * Dart (refactored in 2.4.0): @joernahrens - * Elixir: @niku - * Elm: @trenneman - * Eiffel: @jvelilla - * Erlang: @tsloughter - * 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 (RESTEasy): @gayathrigs - * Java (Vertx): @lopesmcc - * Java (Google APIs Client Library): @charlescapps - * Java (Rest-assured): @viclovsky - * Javascript/NodeJS: @jfiala - * Javascript (Closure-annotated Angular) @achew22 - * JMeter: @davidkiss - * Kotlin: @jimschubert - * Lua: @daurnimator - * Perl: @wing328 - * PHP (Guzzle): @baartosz - * PowerShell: @beatcracker - * R: @ramnov - * Rust: @farcaller - * Rust (rust-server): @metaswitch - * Scala (scalaz & http4s): @tbrown1979 - * Swift: @tkqubo - * Swift 3: @hexelon - * Swift 4: @ehyche - * TypeScript (Node): @mhardorf - * TypeScript (Angular1): @mhardorf - * TypeScript (Fetch): @leonyu - * TypeScript (Angular2): @roni-frantchi - * TypeScript (jQuery): @bherila - * Server Stubs - * Ada: @stcarrez - * C# ASP.NET5: @jimschubert - * C# NancyFX: @mstefaniuk - * C++ Pistache: @sebymiano - * C++ Restbed: @stkrwork - * Erlang Server: @galaxie - * Go Server: @guohuang - * 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 - * JAX-RS RestEasy: @chameleon82 - * JAX-RS CXF: @hiveship - * JAX-RS CXF (CDI): @nickcmaynard - * JAX-RS RestEasy (JBoss EAP): @jfiala - * Kotlin: @jimschubert - * PHP Lumen: @abcsun - * PHP Slim: @jfastnacht - * PHP Symfony: @ksm2 - * PHP Zend Expressive (with Path Handler): @Articus - * Ruby on Rails 5: @zlx - * Rust (rust-server): @metaswitch - * Scala Finch: @jimschubert - * Scala Lagom: @gmkumar2005 - * Documentation - * HTML Doc 2: @jhitchcock - * Confluence Wiki: @jhitchcock - * Configuration - * Apache2: @stkrwork - -## How to join the core team - -Here are the requirements to become a core team member: -- rank within top 50 in https://github.com/swagger-api/swagger-codegen/graphs/contributors - - to contribute, here are some good [starting points](https://github.com/swagger-api/swagger-codegen/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) -- 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 - - 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. - -# Swagger Codegen Technical Committee - -Members of the Swagger Codegen technical committee shoulder the following responsibilities: +Members of the core team 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) - -## Members of Technical Committee - -| Languages | Member (join date) | -|:-------------|:-------------| -| ActionScript | | -| Ada | @stcarrez (2018/02) | -| Android | | -| Apex | | -| Bash | @kenjones-cisco (2017/09) | -| C++ | | -| C# | @mandrean (2017/08) | -| Clojure | | -| Dart | @ircecho (2017/07) | -| Eiffel | | -| Elixir | | -| Elm | | -| Erlang | | -| Groovy | | -| Go | | -| Haskell | | -| Java | | -| Kotlin | | -| Lua | | -| NodeJS/Javascript | @CodeNinjai (2017/07) | -| ObjC | | -| Perl | | -| PHP | @dkarlovi (2017/07) @mandrean (2017/08) | -| Python | @kenjones-cisco (2017/11)| -| R | | -| Ruby | @zlx (2017/09) | -| Rust | | -| Scala | | -| Swift | @ehyche (2017/08) | -| TypeScript | | - -# Security contact +## Security contact Please disclose any security-related issues or vulnerabilities by emailing [security@swagger.io](mailto:security@swagger.io), instead of using the public issue tracker. -# License information on Generated Code +## License information on Generated Code -The Swagger Codegen project is intended as a benefit for users of the Swagger / Open API Specification. The project itself has the [License](#license) as specified. In addition, please understand the following points: +The Swagger Codegen project is intended as a benefit for users of the Swagger / Open API Specification. The project itself has the [License](./LICENSE) as specified. In addition, please understand the following points: -* The templates included with this project are subject to the [License](#license). -* Generated code is intentionally _not_ subject to the parent project license +- The templates included with this project are subject to the [License](./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. -# License +## Thank You -``` -Copyright 2019 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](http://www.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. -``` +💚💚💚 We'd like to give a big shout our to all those who've contributed to Swagger Codegen, be that in raising issues, fixing bugs, [authoring templates](./docs/template-creators.md), or crafting useful [content](./docs/public-content.md) for others to benefit from. 💚💚💚 diff --git a/docs/Swagger-Codegen-Logo.png b/docs/Swagger-Codegen-Logo.png new file mode 100644 index 0000000000000000000000000000000000000000..681a1fca64a6a99ee66c084e54de9d6176b85fde GIT binary patch literal 26449 zcmYJb1z1$y_dQGrBBi2q2vSNZDKUV7ibDuUrwl16LkL3&0@4UFNOyO4iR1u7Hw;P) zIYSRH#C!Gg{rz8_hv7bR&$;KG*n6+D_Bw>TReeQugXsnV0RffL>lYdX1SB}%`uI92 z@YzUi<^ud7cY3V{B_N=`_4k*spXWfHfZ!g1(u=3>J|*ug7}>E*#jWFag!>>}ncF8> zgv`;!vQl5~lQO1*gy{l$734{7p-C8*KC!(>3;TpYuz=O}2pS$mkUtuV-GHWME*Wdm z#D*o^;~l?8cF*)0&xMG?z0Z9gANf=Y5J@Qba?$1VR;!iqE_sLS6jn3b!J;QEyPUWzsE&0 zceLELCS7#dL@Ssl)j#|!M@3NjZIA5V-C<=Cob#p&Oi99cpVr_Wa;lIN&ox|EIb$Mc zFn}QXS0-J61V^-fdrt4d=EEb$WG$*gLHpzQsr{Ba|25FB;Dpr7n@du;c9_dlG14{j z`q~+Mc0c#OyNQuYi`VsK937q!dv?CAq9)%Jj2`)~@wdYMFk+w+a#ZVm$i;jKA-R~5 zIzD-q-`D~8P&__=%CzbF2$?rDugecpm2eZSpz4zOL@{yHz_bD7EfWfj$;=Z+f= zYC;FC$uAjS8Ez=aT*# zMC<5oGF<4;Bi)5uJ5M|-$TtzFY^B@sF1=$J3nSo4<2f0@i2bn?}>Wi)uF=P+P*&*!~ImQ z0HH&WX#cMy0j2eezcW54g{IpV>hwODV{gLHqHVsbKelP!+eGHhZ%jEL@nLmh?RDeT zkN>N~_x$kR1UzlYJ813((RgpN!8VisF0U?ohJi&7NFMAo5cGF_udp^lk}g)S$^AD4 zk2W%?FgD&G@+B5>?+A19Qu8eiwo2tXznn&12|NPoRs633(-=j@`LXuJP$))W-BxzD z28`K*uvd^sYOp7_+RKDtJL?<~Ri8D29fMvn|5rmpk$!%xn=#CT2o`l=YTNXl^pB1L z9XsKFWBjNh^9IJo)RDXTW6<~{?0j0!9eb%3hI;b-W#x&_!E)2V_@6nap}|ol`hSm8 zPPF!ic@V=!$#oJfx95)(_n3o6jhdYfjztz&SY7MH0-^}m|CRi~piY9@Cppfx>F!`p zhSIQ~)h9t8v+D)TX`mOIESjiIOeKwo{xddH&T+bV1nqR} zndj&e;vIMu_5XEs*t6!}3+1-KIzY$c+EUCxd`f=ULDb@{N}Ewdch9OeWv>5RceTdq z-)XFSMGPY=MtYyG>oHj==U*bR^Oxl1rHo$xdmn`@5?6uiil#IfjcUoLMKYq^*4kg~ z|IEZsqEM_JoosNgJos%T4GHN9wOeD0A}QOyepIVi{97fTTkcPyZ%sefk0d~SQ>}CV z-a+#3zP*Oh;9q-0C&T*AWQkx5YlE8Z_3`w_U&4`fz-r*96!=%pI$$&amXY$2eEWTJ zI{^yrHVo<{_^?swV z$E9A~hu!wynLi4|4@F(B_*|l}uJJ;jc(YYETBSRC|Mr4meB*d61&Z{f9@w<>O|YdP zh~xLtD`h)Zc0F#z3H#1d4-t55w_ZVUDeT_n-hly)Us(QiApPSFD$ItnA*zXKE?X4S zf|s{IKILHZTFHcMldUyI9HclnvZwtkN?@IsDT<>Lq=Az%xpXUzDVWC z+;+KvfTQjqp!AY>gw?5OXhu)a#yFDgqRFw7RS(jV>l-hR{J@J5b&(<^NC#CnN1by) zgF$DwmLSOn4k*b5{>`S^8Wn+`Hh-Z3#y>~K0T*(hJ~abFN2JX8w&J@ZzeT~8zJce& z7iR?+DfWJE82pWTj$}hXJexUg1A=MQ&P%$-F-Xg^Ci?l=ww?Wj#s>@WX#I-}c>dT< z-wQ8onVU!k-W9zSQK|f^)bj?TsVd-m_9CXk*bw}U&w2y|i5YX-&2bIQn%Sid|+undQc{pyk6qM05GMo}nDw0TTwC=CS=E zGWK51dG$zHYC}&8K6s>KQ0&yOZC}!Nrqq?*pd5?7`c$?7bsh2!BTtK9BU=+IN3*UA zcQmTbauY*K_EFRX1VI4!sgl;ohqXpWCw&3$KeuEL8rj!uRk^PNjIJmpk6+>4Zw*!- zUhJM!L}i{vqhwu!VLNE|#se(scE_Yx5(&{NdLm85p6tY|f9U&a!xh%IZEF9!M@v}v zW3hZmlOdACW<2nh0(3cZkqT!byv0cQu#^5zVt?y`W30rM17DGg$p z^=pUCq>y--^=`)GStdXWxYY-3vwD-(u zMNv2g?aeN{@DZZ>^Q>cIZXSHKBR3YK`Q@9wdzStz&U(uJIfPp z0^cG@;t3pY4C83$RZ(DreL(DgZ&6+^BQUb_O=sm% z<&O_vhzR`l09fggHzxzJmL4W464NCn5L2|yM#$Ly^$?l5kxc+9sDV7Z!G%a)70pko z$UuDO{<@&84_ylvvbV2{z0(Vrj&5QJt}%z&{rTI>YXrj#YfGu(wpiw1;TIz>o;Uu< zG~Q<%Z;{nGR_x;veE41#G)`lPST1+vPJyijW&nRrmxKI$kw#DmyYKc`s&o=<5{1?fI%d=#3=@GfdrKPXOe2QBv@NME^ zmx;1HI-D(uI_i^Py(?j2{ya>7 zQY78hJX>9Kymz;z+|S|$%3#O7Yi=l<-cU){ln#xzS0`Sz`G8%fj@kT+CoUqz0e6wx z=pIPXyO@+zzTI-#9?~@Lkyf-BS*JR`3e_7Q_%jo(gr5XLz!DHYrLy6F)~L3X-a0-F z@QkyVuo_@ob5Ydryi1@5Bk+5UcRo+~tRodL;+Ee>F7cF|R zZbUEwf|a+XrdY+n?XsG8L6?_11X;$*EECKDvHB23f?+5407x@DAvmja#4)z>n>sTWo7DzXrSC+2mML$;rD4eiWo2;VxZLK5O>@SuSYrw+UQ|M)rmLot7 zGbWa)1Oy6wH)t@f_ieJjm6OJpD+!%XEF9Hd2jE@Us#bG+p5%8|8^ORlpkA4*t1Wl= zD=J|3{P2-Py;a}Jw{~4-f6xyB8ad~Yzk9G&?5UrSrX&9r3^Gbhpg;kHY+DIm|8`)O z@9y`_9}K-a`@qHOObdX#uJdHFHU|?+=?%B)^sMpz8mOM0&HlUJ6%=FN zh1dRICM0;9_HjegI7Rd?h;YaHV1r21n_`3R(Sk*A<~Eod3S*V*5+e)3ab?@rDtSJ~ z*0hXi{(A;Y!*W^jquib)O5ia7eX)6CMKQDZwBvzcwZ$vF3#bap*H+{cW18JrOM;TO zqgSga^BG8~+bl-~-_Iv)TqSLZmlgRl2645lYGY|+sqNj7XV@J-RXPnvWEMRmMXJm3 zKb#be1eG)q7WJ$rjDMW9@)|{BR&?)(NJI!c7v1P_9NL=U@op<0wL3o4Jx#t}CR2xg za{Oc7<#c~_pl6GG%{7fa=@N4d2jE2u$D$d7vIWc~E($9FD#8Cc-C;k09i4nPz}Fe& zqR-=fPnX@|XQ!Lbf3o4$9I?9#g~79KZ-M>W4A~buVF{1Z2sgs&I}}$h7h+cdTs&F# z&R?3YBk)h??`P_pPv~k_jF1q~0(Qjoss2>y2>3A@jmGC7spU$%u9t09TeHSw?IXFF z!zR%@2<@z(>u`|7d;Q{N-A#`Hd0-J!7Z%L{z_R+ccIrj`FvRpLuwm}0y5F7G?`-Jc z$z-$iUg9pL&^}8|hGfRd{P^^mmGn#KHTJC73cXzr-A301e`=Y@7A_;A$C2Xipqwr?v|Emsq!@n0!ELSn4I(UdIfsD|#o{F;bhV zl*!baQDO$i8}7_#5Q|#~y;48S)D=;1R~DQHN~b66OSyPR=1tBry3TZYZjgWQFBOs(@r`$op>50e;`i6o_lDyR+Zv_RWy3Wx+-(4!Qa4pM<1}$<|_!GKaXSh6T9a3fz_R9{p6~mu>qNrvlOPc%G-N z;widX&v~1qmOJ9qXt zsU8fnzGtN#CGTo=x36o3aUnP>GeO7dA?0??&IDw{jH@TJg6HC7&;vA=jiqPIeQ6&| z8a#CO;q=8&W5cPBx0WDpstDg8kH;?{D#EkvC!a=^ zs<;iBl-20PD+H5BZH)OgrpEQoI`U3??o}Rl=S!K24}6Em=!S4d=b-ydrd&RzxS97> z@D;8O#QL1CHK*E-;=*o;)IAk-GYR36QmFlX)Eq+C33xo=UP?XHb}jT`lw>{5PmsCB zeg-z#hv2$~GmJ=cPbI$i-H6F&622pt)&&5WLRlkAKQ&$z{#zD;F9Y}ba`7wRTZXUm z`mCyNmnXNq?Tn01Y# z9M4oISZ~!*{=>e1KTu$H#-?-kd!rn-`RTZ{f4RlvTv3zK*NHI;fe{rICrFFa!1K`L zvNgTj-V^gNa{J;LYR$&vyh`pJMu+Pz>mCj{+c_rUQ%|eds_JHkzoZL%^F@y4hW65t ze>*eo`c&oc;ZZw%fRg- zMeMQZAsDL{78FON+IJJY(lxYdSF1nrf6 zNqL_MtO>ULi+k=}73j5cIQVN~yaFMX8K2ZfkDa8)p^Z+5r=?OCsody-=C-;@0+Y}5)03uy)qC^NBqzrc=d7!MEnbjr z(=XNrRL{QVGjH}PV?3q|*Gg45{GO_&j7Ap^fUxwBNEC*hD_`IjLktH5VMNh0M}da>X(6KGof3YcW+U~q_5a%5l;Jg!Z_wE7Swc(aK&FRdD0DO zh>?d^Hs>`~6^|w~Xd4B1%nQaE*&JV9W3kkrCnB>gt)ss^pY^Sqpk=t$QXyA~ z>`HODLHfdbE)P|cB_-6(-Cn1?_EA47%7f_kmZz6EneBYd@@Vqq2}^vgOS0{Q=be9} z0NpVKGbqhK`yzRGufjOX(7X9^Xoe+i?CI8#fwq&QNq5_V!iShHLq|2Q-Q#ktp3a&Q zAH(9I7ON|}LM~UF+xFQ{qsFD0YFML+dpY+m5HGew;6h?SmY?40_feKtdu%y?(G+NM`AQWo|49n+(gjuDcalGHJ;E zNLq?moA|(W~Smk@%WMDQ2>my9yPz$L5Rpj zqLQbo%1ua4YkFd9V<6T~r>MY*CH3iL%#{PM4(AK_-G*K14oMDMr0AmnB7k}l9SbvT zcG5iTbXX@@sLf?kC8pO_QeWelL{%A@Yw4Xd^sZKG2@TeG@lHaM6{>`8n*Z5PhGH@X zFDvJF_FIOJdCKZ$OyC#ieSUfDeKTJy7eD1y?~*$_Gl9PJ4K54dc2|LTX%G>;BPW+o zrmvAz^QYeT9>)&A_cmTV#8k(hmntH?l>mw*>B53M=#KN#x5TziQN=CaSqS;1OuPXw zB&*}%LEk`FJ7bbMd5|&jE<}>pyGt#Hp=QBHDT*!etaw(*ZCJgd7#C#$yGM1p(P4t?~ZyD40c)LB_u`GFR=sXsk!={Jiy-y-_y2GM(7>o_j1 zcKSQkDic0?HCmG-k{M+n+vMpu4d0+W#xwoNRS&ffN7)jXK1{TDyZkrL`^FGoEosdSAyBwEIo;RTAH{DZnNl{eiVEL0n(^Jtu<2dEvMZ zBzA+0en0Us>GA*tUS!@;+jMWc?b+Goxv*rk|Napa3CjxuL9v}kf7oODy6Jv{EcN(> z$(9!bi3>N+q;&oLi?m2(h%3Djx~<3)L!>9ig`pOs^;t`uW#79A8;`Ocs?ayWq;D)+ zmx?(>8_5sXa$Mzg%N`PZqhnY~dbkP8J5bmf+>O<`c6{5DazGR(c%ui)|D?<$>LOD& zE&}N%wKYg*r2c5q)CswTNfBfE+LG|{btftK5!n>Q47;2xtGg4Dp*>PgMsT>fqVxs4 zW!8JgZY9C1Vq)PSWms1PNByqcaQ1fn2gL=RmSNEQPyO$f(54Uc4PPyF?8_kX3Hwg? zT7H{Lsg`Umtn^zu*-h-?%^DG?X^VQs;vPdX%iy(nP= zSFzELQ}ChH6g=tji8t%eR_H~hQ(TnVGbG{U#l+SVS%&$8#`RWQMt%HBsQcpdd!M0{ z?#7SxJY2B{DOb~s7uT6KA8BhLiZu#;R%9IEMq`v)qX5`$7I=j6N+43Pu(bU^FmCm% zD&v|xl8GnNLUJ;{aM9SVnAc|P(s3SDyQ!OLcP@*gW3;yPaxhIOpLDy$>eOKZ0D{_U z$A;~LN{uVVkOg)M$K>}pJ#w~|`il;ERfKx5I4eo&`~%(pdG;`~3Gb@%?^{9X10Y+g z@j@lRy67M(8o8g9^RgH*OSx8jFe}Dvg*Af8m0>QiAzp~Z;Dw*?#}_hN{V@w!kIfG@ zSnUxo0cc1Ox2^CNR|n*;Z@qL0{RlTT`(u{d3e+)He(fY z`OJur%t*tr0b!zey!VJ#pJ5tGh-W-HE)^85G2hW@GmVi?bf!$aEm!THu@=Y&4yvm-||54bdr|un}zeu=T5@j-&UJ;$iS4j`rYPP zfv!pY$%gtoa<0Z+20rfJdQ`g6ObDahl0>*jj-IbCtNYwkQRzkCx?YvaW~rcSobfyT zI(fdP?(*9lg7AvM<>}r%Jk!wDRJq9=emEq2gC|JsrdWQ)%Ym8=F52y*SQ8O>ERbl9 zs|3YzWpnh|%C|vBgG(N3fL#!cu@7R~Ol<928{s>No0vETu7i~8!RDBT+f_IoS0#s^ zA{|wv!Gf{#(xRM#gmawOaS^#G-BuKZt2=Chk`+v+&MNtN)0mniHpDUa{kmnEZbbUt zn5!7Y#C{86Y-ijI1g{unp3|CI1Qsq8`p9-#I20<9xk9w%V@r+k5X=j0kXR_{ac=@h zaxv~tea12Yw0{U)Qe#ry-73`n;1CR2s7J3xhXO)iH^^QNj}pf+6fXfdOFqI z(rAYZw>*erqP(7;qTW3^AMFXtx)cm^4H?i)wAr`-ea%09tNF>qFE5}~Jm1!T@Wk+a zL$t&G!j=evlQPs&iaYatpV?e!y>^ys6F}NcVn5hH10L1|FXN5?pVi@`UOeqEsaKlQ z!$Z4}c;4ka!UDdhOyv1D2ixQ@=X-fvHlNeJM!C=?&wkjnic1AskiUUX>9AdJSu+RC z`1lqu`OCO_SEO+099r!Hta1~Lnu+bR+h@kDp6ie)8r={4gmN=Mjx3i|O;%S{Vv;rl zAddlS^^H?MRcksWiL^Veas?027OcrSln8q>3QQl@p-mbuBBkA**bZL7C&On*FQWfe z5}~M|Og}P7QMD0T+jg8e2Qc;Vy6}~ku>0WS9U%Q+Jel0%Ii^NTtL_S!d_2qN5t+1f z5+Sfn-=!C^!=PDhpjn1yosT8ZWc{1D-n!aKnIo);&Z*O51F}7uH^Kg%l~lLG`zs++ z^caA0ugB0H`@K&jY2-?>pT>WuZ0Lzf8Du4iRhS3JW((4n&leGgzbP;P*L~~o)J}Nh zV&(`+FcSo0KeLmu*6kU!L7cqt^SUiev=Uh@);XN`;uU|d+4tfqfQwKgdT{`x{I$J^ z&6Suu)Ol|}HZQ1n6&S-*>(KZuOA5IVRnL}|70!G9f*o8p>Z2pqFg4~z3~e%6aX+mg z?uIL4hsxDY!9h!l#><9NXP^kzV(mjxsLd0f`xJP^-(~_86?AXeAo(u^5#G26Rty03 z`2@;&KWFtsd9Pf2BHzB)Oc17_+9oHDQEK1TLC#lQoZNIwZS1_jvZFxz-u+j2ldHqk zot~g*`~TS9l1>q}SR7~6fw!6 z?59pO!r?uHJ$g{v{5Tc6(4d}T>0R|Fw6w`eZ*y+#OiRHiak0d+b9egTP#v>iSxxYx zNs8fVT!si*)}FEGVQtv5WF_E(iiTF_I`1SZO(!P8IH)g|lIQHLsX0Hl(4blem%lm4 z+~Xbu6>~wbtJkhPWA>+MRPpv>u1MJXC>-ot&)5Q4#O!jL(qpqY5B8<}Md@6-Dh z`?kBsje~XBeR$tT5W)Gp!j4j}n0`)On2_QLyFsKVyvISY`79@N=g*1v{h_UGdPUod zqhP6e-a+2krM)aG6@)Bzz@Q`pJbI0-^7}MrcEy(?soM(5Q+o#-9dE$!bP^ofr3C9& z-UNZEg>7Mk(gw3eUB16vt5r>t!!1I7grX4#?TrNoRH9H;Ez&u7M&pjx_Yjj9146`? z?0(hEfXy42$8rF7+b+kZ2kRZ}#_DBUThJ5$4`#9!g^GNV@{BNGO4zo3y>r|d{ zr5{E^F+VEk0=g&ww(qgnx+P_FgMTH?i`ZT+CDp5H`IzqehIN9MQwK}8hz);ZYNnzQ z_%)BG7g40^W1+j@8`I?z$B~{7CMi;-Ma@6lb!xTi@2a&h!RZU#ar(xF$CXqgW0rAm zlc(&TltoG0LLa)k$e-Y~wMpFr683k-jV5nDVHPXaQydur5AS^26K2v#6ISW|sgd_q z_IMl)TiT+p+d9`0XH$$B`lTrTvEyzcUCTXrX+60@-Zf5{oi|ohHVLMr#@T|5jah>$ zdJg(aG4qEIfjKr=8*$a8Daf0Ush0xy!}IvmWR<8Vy!tZncNKYFBRyLuKT9{dGdF?g zjbI-~dwQ5$J_Qa9-B%gi=h-^_=;@E(ul{W&6SjJ?;bN?HsEFqhez0N-g?6pq z&DSD6C2dc%?ul>BH!sRzcKCYG9p3ii?>-Px*Ft{yLNd=ie}zlR(ePNLpD=~xi+NrN z1Ce*t4ong%{n4rbWBnvE$UH&Kb+s_a=%7f4m{UKLgRmVQ3sV zD?4veQcxvJJs12Xi{(B%6BvYS8^!55hT1wSfOR{`;HYp+dcBHnckVj%4V3$)#!sCI@@UFR`29qt;r2rL*?Ht`rEw;YX zhD7V*jrX0<{%Lw153kMbJJT=CF;r8v=@Ee&Et2`4np|bPg>s7_ckzMl3533psLqeZ zWRyHS_3_cvwUY#CBn!`)NaRm?xv@QRrk}R&frss{veHN{BBRlLx`-ddbRvCo+rr2@ z3@b931qX{R8V&`DcU*2yhJ1CzyCZ(3A4aw%+HWj0whr_)*@clFPKy1&#i%xJ>OM1| zvyE=-Z~6tdpPSwmj<2u}r!lpnGFNqWDvKlXkET`6V^v>jre^q|88cLqeysc256BmH zCO%VUPUR(RBx|*#*;N`Ij5)HJ$(2RkFAr|MLA@U+HeF7V^$c4c7k6suVQ0-@hJXp> zfGaIG1UIP);{`gpb4Nlla>!MzCksO^sS)+a_zKo=nz!WsFoK629<1e$$#Aoyx(fcP zw!H2h^2XBJ`l3_W;NqIkuW(po5}Po>haLa9M5f7ZtP@r1N?F@V&uBmd<9qY4*L`5R zOTzwPdadEz4iL(dl^Oo5xlwFN@?h7=)av)_=1z{kr=zX?FA0nF2(y%XY$L0Efs%ux zc72M^?ce0#KPJ#Rc9WG?SYpI$iV6KJ|1?v7N?bQH(;yof1swyTo)*z9u1`EhW+hyH z$0zD-mDIPVWljR1KmhH7?NRM2y&c;(HdnT=`Ulgx=5+Ixmj{M7yQ>b5Ke zx1Rsik+0Vy5zV)kDBR_0)Lax5_uP}smfn;8Prm3^z7Oq{UwxAf-j_n4S@n4zm4($> zGR4k!w~6R8Tk`aXsBI}tR7gegBIz}0vM_6>3%Gy@Re%W+2HSL?(|^Yg^Jhb(SJ5pi}4Gtfg9?XD{Z<-pa5t$vD_4} z*?e?$q>5WQIL2uz61?%Z)e5f(Uq0Sne6`;)v=t;BWTOLroL0nb9sV+DEVi0^={~|L zkE%n2oDZ~hs*ClDUwnEFhpQerM+PJYs@FnHXk!&2r0reXC^SBw3KJ zs{BXE!9DP}h5S&1*l9Y4Q%a9#WUk;-hO`lYE0)wc#oufZ?OtL-IDbx5-UJBFGwbB3 z-?Q(aYW~mQ(#|$9HkN(E&mxmX}@aa0@(;`_V_qw8>p8 z;E$4G>F)8Q2Xr--kfZ^U?JF&*TOB0vdxYH-Qa$eylg8Va;SwvrP&bkI@vSu^^hW#&kC*WL zv8U=jzg|p{(NMAY-4siGwlT_96r5mJT z1CKI4hDr14$frFNs;|>fd2_t6B5{`fA*`pTu{b7-fReLb@@2bw{euLU1q%%jnqg#X zBE&VorhBQ`=Pv%*yr~r>mi65xrfYgZ>?86LIe_#)%e%c?nCGw*anqJ@H;Oz1F~+B9 zKB@7sp#KC{m>5fqN@1+ct_Ea+4AO0MjPtQO@_$aJXKsPbzyP|TtqJJP>vBR@PlnN! zsMoJI_?B#aw4GhvW0sbGl7*_O;jwh6_V6-C0pQpm2m;=wAI<+^-VP{Ns36_d^OP}= zvK)TcSP9dRn#yUa9+6Iw98FC6tGu}?yUt&e^UEi!kq2k4)51>AosjrHxB#+M^U-ZbTyX$syikkUmW$etddv;9($G_;+z9^)?BGE-uJQt&Jzsp)TzFm zgcR***8oC*8mrW!lNx5G>nZtm%jAq{;?IZQ$7~tAujlSmDgM=LY^WA0DtMl%Cp~H) z5;sXz#){X~b9|!z@m%6hvk&nxg<+e3P8D18rbr93hx-h0zQDm}D0qCH;<#fj;Nzb? zv!QdBT8mj%dS}IJhbQZIXa?iGmM7gfz`RE$C0o-mJEl(bZc#i;gab|H|hKQeUiHUlyWGB)Dmymns2C}Q~T zl62z@j+LO*pI@1u*^kv?6R;orzi>~R>QCIhX;l?tH$Umo5+YozPzWbW1D zR28Olrgy%|+9GEvZvk`;+13jG3KTK-E-RF~Bx~h{s)Pw`Snm~cQ!f#AP%4WfUA6&?;BGp(b@1%?x+A< zy3KglZB%i%bN~$QkEt*pn*6B#2YO40KI0YtG@LbH8=lthy&ihCIg}n?A@E4=aC|<4E7*=$Jh9YPnhNw|@Z4K?Wg+X@n{8 zJ#PWMS~C_Cpug*}$#tfxjk6Tc+)ud&pJDk~mpi%`KFit)X_mG@$QQNpjf7dJg;fTU zp9=s`yI6dThjZ?RWd@Z9oM+|dsApuPxU~h9-Bav|*_mM|1-DUh{yyu!n|Ku8EAS8 z`gYytvr`GS;uSMsonZ*ssM{-F1;!8 z7EHCo>2%H(dC({iti6XiPHM@QxVbFWhA>~A-Rn(bWeLYNBDl>u>t?*+3wJFP62t{9 z3oVvJDgAs`c&QRM=a`VpDzJoGeZO#3_zpMyt2AzzcKYV~Zx*t>(Y$lpuK^*k&6ZEj z!B^U#yzL0Sq;AheeJbn7$0v9Jv%bZm^MgMpDa`-)UY@s>hX`kaC=VM9S#9q1{I{<` zzX}=PD|Fv7zOVrMy7>i=o!7NARfFXd((>8>NRTINOG|+F`u5qD!C3iMzdD-@wY<5a z9Nh+?s!EJ+T%oO9VrJJeq=gUkcDUk}U?w^g?c997Vc6K_BWcJHOdIy@lbn;JxP=G|)0Res_%EU6yK)^i%JS zlj;(Go^Uw9q}=mKgSc2d)P?)(r^gyEoRCanWnQR>un8XJM7nyYj0S%X@2*grx&B8E zzb(7tcr?`QhkQC=>w4mwmAla`=<46E1v`e?4<-xQ)ckEqxF&xjBNdu9T%&G37vRx}m?K&H!Qj&C^g^lB(UZs0AcSPTKW_ms_ox5QZ zRaW*JRv`+>*U_RCPm682iz!s%<-ksuUvXXsC1#8Z55& zSiS4~;VV;YS7xiDv})xqyxy|r>Jy%x%u)2bv?^F!Y^0vB2dn&F*N0!j*}h16Q9H%# z98POS*f@Ok_nyw24FXonkuG&4w{*0!_K|LRW^8I)A*#vv9q=~38i(ZeUCN~~MWHqKOB5rWo8}i+aY-^58CRkXIl7rcsI{5<-3CX*v;;j|E<7)|G zWfLw?zr6-CTVH2H9UO$R#M@xDxq&gqp;f}cg@C`_BcrfCA;>VUk)I<)`+TAhF zW&4-D{>0LM&u|Ian@({Q*}*5_BY3WGNAcOzg;`a>Ce#;pfNdd|fwAEgVi zlDQD79_-df<2L^bqURA{O@sXq$~50A_)dE7-}FG?H+U`;_L5^Uh&^`u^D7}m90oYd z&~q#TRjZ*pE9qD?7r~U$9CN$>oD5C=H7hei35HnF*YT{F3rJ#%{7`F0NJTt>SSY#H%!BxssIi zS*6=bJw7xNvf(~?)C6b2L9ZFSr7k$lrteg=5N01|?<JwY<&%fQ-o^5(B%C^S)ptHuhUuK6d1v?TvcTw%tUtnaF}Kr(FXkEzImeTI&}MD;2FbXB zstnrxhYrz?G|B>2HHsFw>9*N)ER)!Gmkdk?66zHr3e z>Z48>YbuB%!D+abZ#rP!SLjr^aB2RrPDtvmOF(JZ!sKB< zD7O?<+-w@%n=_WGHQEt=(~W&XZw%OT#M?Ci^%Xr(Z{`@@s(U;b4{Z3=K@!0Z*yGlW zr%UgT#z&8{iKxd2KO?D9qP|Re4FxXa!~tjizDbx7$La&_wL6t2CLu-A~g6kgPFMhm8T^G+F;SEI{x^H*j&cIGn^k&<(4 zVR0OFfaRfAf)$EUPp#yhLEmjaDy%aX;T?&Zax!iUx*!Vhx)JVS;?nBltn-f83+V$R z*pTf2RnZVJeE_682eWlDJ3xlEQr2rUenq0=!?n+#JjUeKlGESQA2XH#h^Xju|{1SI=jpS-kauEI@n_AmZDsQMInU%}>}V@|H9sjLCeHNaO&1rsWd zbz_)?6IgtTg2+ECE*Vnd-!0nn)y%JDwbU;4nbY5_k|45qt z>zJ0)Ihpwe+#kJJrWkJOl@CS#rv*6X=m0s!9Pu2{3A*__NF4yp=%6k-sZqg>6Hq(%nsV?rJ$%sGT(Mp2RW$b-JJZai!u4C<&HDUEoNrxNl9}veS$Ba^ zco_Tb?Zx-kpJ_kG96NfrDJ!bDq{Tp%pOc)HGW6Poufl3`idb?XKLXYnfCHntBv5to z@NlMhKDkaMX+YSC>+xVUR%aYk-j!1V`w7!==$TbaP>094{MZ3frfVfl?pJvu%~_X7 zl{wUGam%}%P~Q7SY~L)N^ZMg~@En-JP;z*}AZ@8W?l_K=ce!0|JaOB)p;MUtzO%YU z7Zwq%eAdHC@uop{)Pm1eFnK-~BuIN2%_}1JekHfp(pO6Avggy|^3u6lVfX-Jcy7-o zS1-;iz=6%-yQ|O0K=;bI7Wz~2@PY0s!l`GZVctbW&uf3?YUgYC`HOcs9IdVjeTZ4QD|yoK8uDY; zSVY&3rXe#D-MqY1`of!C<937K)X5{S>K7?Ype&URZb{!i}3)Yab8J2Nohw(_3a^9B>##I&!%T87s9_)n|)Cl9tf zosB~T(%s`!pP4+CQ-QC*CppG}Ep{LJ%(Gpy?f>iP%mbnPzCS*;k)onh$dvNP7~l6CB4>||s&lXWnd-}UL+Z~h#fXYO=Bh7qj6rQB+^chbGKYi*$;>P3E+U&PwYQ9sfCJ~?lQLiNZFR?83^RxTVU#-_NzzG2MjalgSDkJ4@9; zz_e+PLnloOZwRm6J%0VYTljXuA;D?v^ptr2g8|8n@}a=F-Ilb%#s0CT77BX=rNyIl zfui=iTZ$elUpOe_G#U2Wf9}fU1ub&#*9TIRG$dq~^Lh*pShAYY`1IO*lSb<>HWJ;9 z?Rh$G(J(%%%x8zbA5|#QQsrVccRoq=3$9$4M0N;kBR*iR(X3~)dvmO=H!(b=Po^`I zJrl<1<)2Y&6{vn@n57q&_x1(JaMN*V^WoTT(fD~3P)_=LpPnqFz%Nf%z|J)Nol!pt z#$wi+#SUo#kgwshWT#cXaE-M9u0fCHx+Owx zvp?H@6Djs#JEAS1#E-$Xz3uI(HeUIO!zH;55rx*_A0Us#Rf~B%lOS$^PWs3pcO&D# z9;p2!Mt`!Sk;#SKMC-VE1I3d451+Ih3HS5rg**M0F_gFMWVE>Q@i<%6 zgaJ_%N~Bv35(^*&HBxVaCn0xoVkPHtZW@ktTNqb5uZI3Y*=V@aWfaz)10qwV<-NlD zrECdce=OaQ-dfwb!{A_@A_H%g28e+wm(DLS1~4tl%?TkDpkRDLj{LG`+xGt2^`XSD zEg~Ra2Du!vbLTOu*L(1)2Y`Q3TjMyPopaDn*yHjBhBMa07^~QET%One^Rxs7007KQ zPCd6cKupK%LFEJEI ztmiDx?vO!=kx;SG z9~9YE+Ua}GJGeH=A&?(oJHF!`P-lh!a(wkp;1l$( zcl{nC4%I~9Ot$>WET5<>8Bxk-fY@QvOzU3x1+n@Of`2^_elt#``T4CORODQNd!>g+ zD~~OI1w<`VRKo0KTxj|W`jI^N)S>Aw0lAPTG)Q)T8bKKdq>_Bu>nW$VtENyYNb*q3 z?f>lFHtJq`|Av&FS!Q=@U-LmQT>l>N?{XZ*C7@5H+ZI0macky{#Y&*$;}-Ynv%35E z?|BeNK)ecuo#_J|fICcv>`2_vdAO85a%4ID+q!4D6(QwKn1j=Jnc311zsgqLH&&y2 z#Y!BHejJkc#&#AoBFcrUwwR)E=sN&83^Jvnw2~f7qU=%hIwZk!#|I^o^~+g}{f*wL zUGCG_R2wa%kch$6{RS6ejTbX?9YCbFKi?2pKzq%&LKGF96VrUSTz}Z2^&VX6yzXvf zSKRa?k0?_<`B`VX`<1dVv>=)UA_sFdAy?#<@Y0~Cesz5W2J&!5gk|sT!^|f!<;x>i zIjlZ#(nD^UuaYj;k7mCFB}SaJ>$rBZC1C~n@Z=VHJPaU1-?IgQQl{W2kqnc}tQ%<7QSa3AeEt~U4 z_<-n$`cnwxMZ1q514#L26-8dFi2wafn?aozE;261J>l)Yr)gR}HZf%eT5(R_`F@x2 z26vPNh!=C31@m~9cJd9GpEco9|GFH}<9E5MG)f~08unk#ikWtjzB@{m;ljnsmY+vn zV9_3{9~NjA8QKI46%ZL}c&itF#b{X{p8U^<$hi4*H4-G6Y<(h057EAFPDG~CRxP?v>mZ#u5u()`4wWwKg3~i*TVfJ&33*_w;Y2MN_jy|?v(FSRrd`l zIGuj{!VFo|zeXMEQcq818@sCAE;vgf6CiD*(EUZyyM69Pka8d=6mo;Jx(e4+hW2R> zsfT!K^N?lRxNA6GS>HAoLksnDmo9je~=pPkQ_ZqKLlu(SYK=khc-y?&~23+n+@A(vIqvoa_Ga(hjINpW-_1{%-*@tDOvnVGNQtA1lLF&sb4@AlvVb z!w@O~Ql?l2NVxGoW&I|M>n@M(yaE07E=#P}^1EbVz%wr!SetlF?(%jVIN2J6qx=80 zis2{yw1+qeT=Jz~xp4>#T>=MQn}BoQ}34aoR(V7#@?fr=5<9Hh=@dQvcbxe?gSe8dSA>L;3sL%sMvm8Hd*Y z;QD(Fr}1v9v^PhKSh3eZ?sh|@=V+V(ocCw(*#AxtX?a(iU$lvf)dL!p!z}mTi>{VZ zgNuqUW>`8f_Tmi?Piyc$d}{Eg10N>tTT0+&`7i+GL0e9W8oK|NNHwn*L4n}_D{q4b zX5yB~2VeN_=u8u^*w={#z?8H~HU0kfb0B5J1P%1*ke)E_V4eDo)y zdl8xcI+F?M`WKO-Xlv;@U~HIMzmh6xH0ppb5>um)m+ln$+ZBOZ^bFIgwqi4HZXph6 z@XRMa06HSHO28BI(dE>20-?QC^g zNr;?1GeY1P;9usN$fvoGJJ~*Q$*Bqf&K&qW2?o-^=_&*GuoiAr$i$T1RXN%P?9dB< zfurppe01mB3P*Zukt$;EZv)BOi1<2UaQEhMX;k{KNWGHr36z4zzi`SWbZkQ&i z()7m4awuQ{d#v!FsxU^so5lzdmJt6f@nwJCiej$Ir{dhxrZaxtaT0F4WCAxL6V-RfTBX5Y$qT=GB3n(~`l z#`NQ5ON&XcXLE9SuHH&Ax`uI-M^@NnFci9Xt?;xRkV-^exjqe0{8=J>e-XP)uTh^a z;Jlv@1*NPf6)@SFo^@HQg_v#?4d7Gz8Q<^L{i>>_43aaQwU7$;@26Qb9v+YoNsM!l zlq${*9z`!QF?d_SMLn4fdGESD>#C-5)6o+65_Avw(m;mURA@Osbl}2@41b|od}2K@ zBsp`hwefX&;`PFF+Z^myG=gnIf<(Ii#G1`v@Ul}TJv?6c|A;??*k(iFQ}*ZHS``=> zDZlmoxtzjHu-JGpH~2Z|()qMq9wiCvvJ*{mX>mx+Pt_N0vKFxzd^qRuE20KYYFVJ( zy|0-3$n#0SlH^Q!>hkql>6$$D@0iI?#r1$SS38DG-_p-;Iy z^aD>2a}AmDUEjiLD)?y{B(l-M6kefy_*&9NHUZQv)cI!MO9?=&*-0Qz>I`)1*4X9q zKs?Lx8r&h%|MK=n4$3)Dax-vwoFq{3c>zx>UtUPvr||;2*2X()!?f~<(fe4Nl;NX+ z*vvls!ANpDAl7(t@_V>M&)!ZQqGwgA(oni0;J#Lw6FWv$H%BbzVS5e#m2#ho>NM@= zhD=_PrOFdNlH1me` zzqZ@mEGh;pIJ#P)mS2Bod8`(>DMy)(d1n^*8AaM;FXhW*peyR4MqEiCm*d`D0^$_z zDr03MftO3SN=ax)&Qp=dRZtl!e#_a@u841pq|_j_9*L-sVE=Q^0Z7lgCMEOtsvZkx z&CY5gQgwr&bW`Pe!JM?yQnCD{79qS$R_fQ_vVhlu&|`ZGU`{uw|X-0Hy!&f-<^&HP<^M;+UFaI0$Xd`vM}|QmX)p-bD<+Y>XboMCt`Gdhm%s&Sbb*p#9PGy9ZPZU%;WE{W88`_PoJ zd!S7vWE^kr%~ZYwJz)t?^HL9GFq%6J3csopl4eR1?)g_8*8Lm&4~xh&&N#7xy`4 zNNjco{HXcbm5F_9Jik|U&=|6VO%s>qA^US<)Epoz0T&I6>;D!2%4P}a@}ve92K^Qv z(-{!_m6v>-UBXq}E9_5-sq8Rfe#I%?m4M>wg3GA=Dp9PEo>M1MRrEIWUbdE21)w6&3by582l&U2Z zw|ft$Uj)6O5E0_m#`AW3jAG6UG3SYo?x*+~vw%$blq@LI3!K>k&Yvc9zpq}zL-X|b zGk@Pnn3hYEMh))5a;l}XOcMz9+*?Hp%8$JzZH!#`W-F7sL=RF7Bb!!EI~$2|Gi3`n zud%7A9*Kacb9LJ2Lh(?t4nuKM1}ztt=XWavy>Ppn;t zY7)8%_-+`_NcV;P*t2l=RDPEH!ByW&OATKOT}=T(tKpP32!uWuppf#A4p#;atkFYH zvhQ7t$gc?7k1=Z-5{$@PBuMkgCTqRa7MM)1KQF?!wr^Au5o33MVd?p^B@^AC_~`lB zo@hBGM^z6ljz8sRkV}}9^UH@xaj_gfV^g-KtIx9PeFJn=R0^kl(=xNK>tOiMV|*Du zfRm1bpAMAgtw@v7H~uI{RB1g~WMZr7(}Zq2+6m_WXgnxq%7H|&2Lh5#wNSM;r^7@x zzd*mQi>?*x#S4KE7vLhFF|%dA`<*VpHyF2l4h#g!Lw~ongx7F~z^KP&7^vQ<;vRst9(~c$xVhnsaJ$YN#w>q%Hqf-4l47ca5*jV~8~NG5k-Azi(3LJfuKA2uBK9n^k^%ZnLQ(k2tn}oi{0s!=sgd& z9Gg-FkDt!po%VIoJ?QKZXyK@#6Q;Gd-$8o(c9TtT6O9k`EP3hq9;{nS)-u!(`qwJ( zW_c1sW9su1`G!>LukQ5Ghjw{W__WW8X8NTmq%)_BsW5-#wE9J_xnW3ZY5neA^Tg_Y z462#`iDX&$QHsKB!n>x7nq3@KWXN&kvK0(I_kmRA9{2tSR=PLaF3r)Mw$YWm%s$S@ zuYU6h`OSt+daIquA)T!3gOxy=PFb1&FHLxBX=)-)CK?UHS-38MET zn)O`jMfOwoAL#R3N#18Fc_!)ns=XriSeKj)xsI?7CKMUHrz8SFU1$))aP{DcmbIvg zYdILgh%Vd7Ou=!g^pXXbR&2D@G8?mS7KJ*8NMQQUS}r%C+zwF)!~z7|odO3d*Wk?Q&qPo*Q>E zUlj2c&%s)_Zp3o5u!X!4pSfqve30v`AOvmO4?^c-f8umza)noE<`*jxIGUT8_YM$X zo^kBhYlTn)Xi|n%J$a>y(uAs~rZs7zH94`jzCO&5_Sy#XwJ(YLw!wFK6-tZhVCZDU zjUl=I+TMa}G8a9{YN-VJOUO~rqsBx5bGWE|2|?76Ib*2zr&cJLB(k7htmLpu=7h47 zak=1*ECdoL2F$lwrLp>{Yqy=5La-pSo!mkKwRh)9eG$tSsD*|d=fY3O2U2UP5Y9IZ zC6Nxk6h)-1r>tnNn$EhB%@gf}V1FGF>FsF-CRrAWhiPLQ^$6KQ&yHEIy;B;R+ELs# z!gb(AnCYoAo*-w}tJs)#nru-voDL>scL z?WpUPRr2#x*kI+VpMce!Lm$Srw)vY@XQr`INb?WMa~J zh%FHqo)WfJ%Hs0Bp_}^9DnC>ti4x-7Buz%F#d^FccESh|BPsCQ_ zhvuE05)raYktu%t_xL{6pq|~+MTXJslkf+J*8LGvLVN{o{RAyiNDIhl5x$I-rl5FlLP6 zrejY0lH+m8E+4Sio6`Z%H{n_nSd=%jvMeTaK&65ZlevylvNTsrt4er8;@B2!<>l3v z#&{sSY59ies|p3CJF%a7yk4Fmf$LK8C%@xILi-R%dG-=h;KvvVSAz?f+s0Wbq+FIs z7`?Tk_GNs1m7Vf-hDAc{wd1i1Ol%0)kc|o3Mc-XdG*!IpX*DWSGUd*R#*6A|#j-#k!R5Ty1K(K-ABrfS zqt<~GD(eXtNikTk_f9xEncd7*9K@G(o+={>*;dpJ!|1#zXfmn zzJd506cvb~-%pi@=eu~p`R2RIZl$zPRHnrpz`mS2dq+TolA%QLHAIwysL`{{-kx>L zYBeR&M7p3AtUy^0!Tbr^jcI*AEclry4d{evFW)?u8{S9BbKs>Q{AbvLMn}}}=w!Na z!nCRTAT}<^nkgF*5*X^oa#E|6p<``9<>!xJPAl+8s*f|-u;#PypoQXu>X&?FN_dMY zF?L+z=8Q4j_I0ymY8}Jydl0&*o%`zhB0@%E!`_ zQ*R_*O;$8_-lVSDR7+j=fl0-N+Q0)GUvYNAF=1C|n$u>J3h6#E>|B>~7JKvI_qwU8 zSz_x%1+S$>EAOYr967SZ$33I7ekT{QPq%rR`ep+FOe?>BBX4ocRCRuK zmyI!OQh@Fm6H)6R%aBew(MQj_?YON+jTiwPqSQR#^>4YMKhp)R3f```Xm}*N+Z`$y z=PNrWz|FFU-@Rcq`UR=I81sj>2_MLD-@B?j6dolqpCCoZE(n3uZ8&LEY{W2&@!th5 zp7lK)o^|56pM$qOtsX)@BdI;_GU&Jrq*mp4k=5KOs9&~_7fwXXS{OQDH@A##Nq}Rl zMb-+oqp1O@M?$>y2wJKnU0Sllwxf{T`2+_1K0YB_AO%-YP56$hODaHQ+WRWmuryD9+j{v2^^{M1W zZodtt_aJ896^Lx^&3j0iu%y;K7MA2qQEa?3V_9ue8 zUvJ5uI|*>f38rR_=;Br-7hm)Wkht*>7$nV&qxM>}gtr-M>!#Nehfx7OWmob)=jwkf zg&ALo0mqj5*77mA!s96{G&pp1Ii9s~M$^g><&}{F%^aTEg^%G?qzP}2Jba#C*6ZYN z6zFz1y=AdsB?~u^6xA~ymvL3b&3IgqmFAf-RiKS!DL;ZB>b0ZnnwJeN2p_9oH;LiqZ z98u~d*yRJcYk62a-ETUommEQTSO*r*aUK8C3|%cR0@QRWuFOT8YC$@uG%ftl&N$1k zDy!lJyKw&Ye5BbaK_Hf6tYVvS zeRpFzz3LiEZR54a)*rjBJlzIKlmYs$6QxsxTHd&yC}tyiU!#Dx9Lmqe);afZ&X0fE zGxSPGmgpPFP;s2kPI?oNW|^O3g3H$G4P9r%X9EzuiE`Ob&=kgiFCp8vJiz_kQ|Y^=r@*T+HUwhJ&w~1y zch54QNke}z{}6hhr9Jy^0M%7E<3|7YN$wKI5lAq?S|t>64Q6LwsXWqnSn|Lu`2PS% CGEYkY literal 0 HcmV?d00001 diff --git a/docs/building.md b/docs/building.md new file mode 100644 index 00000000000..aa81cf91112 --- /dev/null +++ b/docs/building.md @@ -0,0 +1,37 @@ +# Building + +After cloning the project, you can build it from source with this command: + +```sh +mvn clean package +``` + +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 +./mvnw clean package +``` + +## Homebrew + +To install, run `brew install swagger-codegen` + +Here is an example usage: + +```sh +swagger-codegen generate -i https://petstore.swagger.io/v2/swagger.json -l ruby -o /tmp/test/ +``` + +## To build a server stub + +Please refer to https://github.com/swagger-api/swagger-codegen/wiki/Server-stub-generator-HOWTO for more information. + +## To build the codegen library + +This will create the Swagger Codegen library from source. + +```sh +mvn package +``` + +Note! The templates are included in the library generated. If you want to modify the templates, you'll need to either repackage the library OR specify a path to your scripts. diff --git a/docs/compatibility.md b/docs/compatibility.md new file mode 100644 index 00000000000..f3af0f9c327 --- /dev/null +++ b/docs/compatibility.md @@ -0,0 +1,120 @@ +# Compatibility with OpenAPI / Swagger + +The Swagger Codegen project has the following compatibilities with the OpenAPI Specification (formerly known as Swagger): + +Swagger Codegen Version | Release Date | OpenAPI Spec compatibility | Notes +-------------------------- |--------------| -------------------------- | ----- +3.0.63-SNAPSHOT (current 3.0.0, upcoming minor release) [SNAPSHOT](https://oss.sonatype.org/content/repositories/snapshots/io/swagger/codegen/v3/swagger-codegen-cli/3.0.63-SNAPSHOT/)| TBD | 1.0, 1.1, 1.2, 2.0, 3.0 | Minor release +[3.0.62](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.62) (**current stable**) | 2024-08-27 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.62](https://github.com/swagger-api/swagger-codegen/tree/v3.0.62) +[3.0.61](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.61) | 2024-08-09 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.61](https://github.com/swagger-api/swagger-codegen/tree/v3.0.61) +[3.0.60](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.60) | 2024-08-01 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.60](https://github.com/swagger-api/swagger-codegen/tree/v3.0.60) +[3.0.59](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.59) | 2024-07-22 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.59](https://github.com/swagger-api/swagger-codegen/tree/v3.0.59) +[3.0.58](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.58) | 2024-07-08 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.58](https://github.com/swagger-api/swagger-codegen/tree/v3.0.58) +[3.0.57](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.57) | 2024-05-27 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.57](https://github.com/swagger-api/swagger-codegen/tree/v3.0.57) +[3.0.56](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.56) | 2024-05-10 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.56](https://github.com/swagger-api/swagger-codegen/tree/v3.0.56) +[3.0.55](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.55) | 2024-04-22 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.55](https://github.com/swagger-api/swagger-codegen/tree/v3.0.55) +[3.0.54](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.54) | 2024-02-19 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.54](https://github.com/swagger-api/swagger-codegen/tree/v3.0.54) +[3.0.53](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.53) | 2024-02-14 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.53](https://github.com/swagger-api/swagger-codegen/tree/v3.0.53) +[3.0.52](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.52) | 2023-12-30 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.52](https://github.com/swagger-api/swagger-codegen/tree/v3.0.52) +[3.0.51](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.51) | 2023-11-21 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.51](https://github.com/swagger-api/swagger-codegen/tree/v3.0.51) +[3.0.50](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.50) | 2023-10-26 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.50](https://github.com/swagger-api/swagger-codegen/tree/v3.0.50) +[3.0.49](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.49) | 2023-10-23 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.49](https://github.com/swagger-api/swagger-codegen/tree/v3.0.49) +[3.0.48](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.48) | 2023-10-19 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.48](https://github.com/swagger-api/swagger-codegen/tree/v3.0.48) +[3.0.47](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.47) | 2023-10-02 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.47](https://github.com/swagger-api/swagger-codegen/tree/v3.0.47) +[3.0.46](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.46) | 2023-06-07 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.46](https://github.com/swagger-api/swagger-codegen/tree/v3.0.46) +[3.0.45](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.45) | 2023-06-02 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.45](https://github.com/swagger-api/swagger-codegen/tree/v3.0.45) +[3.0.44](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.44) | 2023-05-23 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.44](https://github.com/swagger-api/swagger-codegen/tree/v3.0.44) +[3.0.43](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.43) | 2023-05-17 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.43](https://github.com/swagger-api/swagger-codegen/tree/v3.0.43) +[3.0.42](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.42) | 2023-04-05 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.42](https://github.com/swagger-api/swagger-codegen/tree/v3.0.42) +[3.0.41](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.41) | 2023-02-16 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.41](https://github.com/swagger-api/swagger-codegen/tree/v3.0.41) +[3.0.40](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.40) | 2023-01-27 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.40](https://github.com/swagger-api/swagger-codegen/tree/v3.0.40) +[3.0.39](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.39) | 2023-01-25 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.39](https://github.com/swagger-api/swagger-codegen/tree/v3.0.39) +[3.0.38](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.38) | 2023-01-22 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.38](https://github.com/swagger-api/swagger-codegen/tree/v3.0.38) +[3.0.37](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.37) | 2023-01-19 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.37](https://github.com/swagger-api/swagger-codegen/tree/v3.0.37) +[3.0.36](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.36) | 2022-11-10 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.36](https://github.com/swagger-api/swagger-codegen/tree/v3.0.36) +[3.0.35](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.35) | 2022-08-15 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.35](https://github.com/swagger-api/swagger-codegen/tree/v3.0.35) +[3.0.34](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.34) | 2022-04-12 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.34](https://github.com/swagger-api/swagger-codegen/tree/v3.0.34) +[3.0.33](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.33) | 2022-02-07 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.33](https://github.com/swagger-api/swagger-codegen/tree/v3.0.33) +[3.0.32](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.32) | 2022-01-11 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.32](https://github.com/swagger-api/swagger-codegen/tree/v3.0.32) +[3.0.31](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.31) | 2021-12-28 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.31](https://github.com/swagger-api/swagger-codegen/tree/v3.0.31) +[3.0.30](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.30) | 2021-11-18 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.30](https://github.com/swagger-api/swagger-codegen/tree/v3.0.30) +[3.0.29](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.29) | 2021-10-05 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.29](https://github.com/swagger-api/swagger-codegen/tree/v3.0.29) +[3.0.28](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.28) | 2021-09-30 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.28](https://github.com/swagger-api/swagger-codegen/tree/v3.0.28) +[3.0.27](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.27) | 2021-06-28 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.27](https://github.com/swagger-api/swagger-codegen/tree/v3.0.27) +[3.0.26](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.26) | 2021-05-28 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.26](https://github.com/swagger-api/swagger-codegen/tree/v3.0.26) +[3.0.25](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.25) | 2021-03-04 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.25](https://github.com/swagger-api/swagger-codegen/tree/v3.0.25) +[3.0.24](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.24) | 2020-12-29 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.24](https://github.com/swagger-api/swagger-codegen/tree/v3.0.24) +[3.0.23](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.23) | 2020-11-02 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.23](https://github.com/swagger-api/swagger-codegen/tree/v3.0.23) +[3.0.22](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.22) | 2020-10-05 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.22](https://github.com/swagger-api/swagger-codegen/tree/v3.0.22) +[3.0.21](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.21) | 2020-07-28 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.21](https://github.com/swagger-api/swagger-codegen/tree/v3.0.21) +[3.0.20](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.20) | 2020-05-18 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.20](https://github.com/swagger-api/swagger-codegen/tree/v3.0.20) +[3.0.19](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.19) | 2020-04-02 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.19](https://github.com/swagger-api/swagger-codegen/tree/v3.0.19) +[3.0.18](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.18) | 2020-02-26 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.18](https://github.com/swagger-api/swagger-codegen/tree/v3.0.18) +[3.0.17](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.17) | 2020-02-23 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.17](https://github.com/swagger-api/swagger-codegen/tree/v3.0.17) +[3.0.17](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.16) | 2020-01-15 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.16](https://github.com/swagger-api/swagger-codegen/tree/v3.0.16) +[3.0.15](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.15) | 2020-01-03 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.15](https://github.com/swagger-api/swagger-codegen/tree/v3.0.15) +[3.0.14](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.14) | 2019-11-16 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.14](https://github.com/swagger-api/swagger-codegen/tree/v3.0.14) +[3.0.13](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.13) | 2019-10-16 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.13](https://github.com/swagger-api/swagger-codegen/tree/v3.0.13) +[3.0.12](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.12) | 2019-10-14 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.12](https://github.com/swagger-api/swagger-codegen/tree/v3.0.12) +[3.0.11](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.11) | 2019-08-24 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.11](https://github.com/swagger-api/swagger-codegen/tree/v3.0.11) +[3.0.10](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.10) | 2019-07-11 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.10](https://github.com/swagger-api/swagger-codegen/tree/v3.0.10) +[3.0.9](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.9) | 2019-06-28 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.9](https://github.com/swagger-api/swagger-codegen/tree/v3.0.9) +[3.0.8](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.8) | 2019-04-25 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.8](https://github.com/swagger-api/swagger-codegen/tree/v3.0.8) +[3.0.7](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.7) | 2019-03-26 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.7](https://github.com/swagger-api/swagger-codegen/tree/v3.0.7) +[3.0.5](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.5) | 2019-02-18 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.5](https://github.com/swagger-api/swagger-codegen/tree/v3.0.5) +[3.0.4](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.4) | 2019-01-16 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.4](https://github.com/swagger-api/swagger-codegen/tree/v3.0.4) +[3.0.3](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.3) | 2018-11-30 | 1.0, 1.1, 1.2, 2.0, 3.0 | [tag v3.0.3](https://github.com/swagger-api/swagger-codegen/tree/v3.0.3) +[3.0.2](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.2)| 2018-10-19 | 1.0, 1.1, 1.2, 2.0, 3.0 | Minor release +[3.0.1](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.1)| 2018-10-05 | 1.0, 1.1, 1.2, 2.0, 3.0 | Major release with breaking changes +[3.0.0](https://github.com/swagger-api/swagger-codegen/releases/tag/v3.0.0)| 2018-09-06 | 1.0, 1.1, 1.2, 2.0, 3.0 | Major release with breaking changes +2.4.44-SNAPSHOT (current master, upcoming minor release) [SNAPSHOT](https://oss.sonatype.org/content/repositories/snapshots/io/swagger/swagger-codegen-cli/2.4.44-SNAPSHOT/)| TBD | 1.0, 1.1, 1.2, 2.0 | Minor release +[2.4.43](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.43) (**current stable**) | 2024-08-09 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.42](https://github.com/swagger-api/swagger-codegen/tree/v2.4.43) +[2.4.42](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.42) | 2024-07-29 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.42](https://github.com/swagger-api/swagger-codegen/tree/v2.4.42) +[2.4.41](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.41) | 2024-04-22 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.41](https://github.com/swagger-api/swagger-codegen/tree/v2.4.41) +[2.4.39](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.39) | 2024-01-02 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.39](https://github.com/swagger-api/swagger-codegen/tree/v2.4.39) +[2.4.38](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.38) | 2023-12-29 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.38](https://github.com/swagger-api/swagger-codegen/tree/v2.4.38) +[2.4.37](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.37) | 2023-11-21 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.37](https://github.com/swagger-api/swagger-codegen/tree/v2.4.37) +[2.4.36](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.36) | 2023-10-26 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.36](https://github.com/swagger-api/swagger-codegen/tree/v2.4.36) +[2.4.35](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.35) | 2023-10-26 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.35](https://github.com/swagger-api/swagger-codegen/tree/v2.4.35) +[2.4.34](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.34) | 2023-10-19 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.34](https://github.com/swagger-api/swagger-codegen/tree/v2.4.34) +[2.4.33](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.33) | 2023-10-02 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.33](https://github.com/swagger-api/swagger-codegen/tree/v2.4.33) +[2.4.32](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.32) | 2023-05-17 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.32](https://github.com/swagger-api/swagger-codegen/tree/v2.4.32) +[2.4.31](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.31) | 2023-04-02 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.31](https://github.com/swagger-api/swagger-codegen/tree/v2.4.31) +[2.4.30](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.30) | 2023-02-16 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.30](https://github.com/swagger-api/swagger-codegen/tree/v2.4.30) +[2.4.29](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.29) | 2022-11-10 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.29](https://github.com/swagger-api/swagger-codegen/tree/v2.4.29) +[2.4.28](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.28) | 2022-08-15 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.28](https://github.com/swagger-api/swagger-codegen/tree/v2.4.28) +[2.4.27](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.27) | 2022-04-12 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.27](https://github.com/swagger-api/swagger-codegen/tree/v2.4.27) +[2.4.26](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.26) | 2022-02-07 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.26](https://github.com/swagger-api/swagger-codegen/tree/v2.4.26) +[2.4.25](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.25) | 2021-12-28 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.25](https://github.com/swagger-api/swagger-codegen/tree/v2.4.25) +[2.4.24](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.24) | 2021-11-18 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.24](https://github.com/swagger-api/swagger-codegen/tree/v2.4.24) +[2.4.23](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.23) | 2021-10-08 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.23](https://github.com/swagger-api/swagger-codegen/tree/v2.4.23) +[2.4.22](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.22) | 2021-09-30 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.22](https://github.com/swagger-api/swagger-codegen/tree/v2.4.22) +[2.4.21](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.21) | 2021-06-28 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.21](https://github.com/swagger-api/swagger-codegen/tree/v2.4.21) +[2.4.20](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.20) | 2021-05-28 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.20](https://github.com/swagger-api/swagger-codegen/tree/v2.4.20) +[2.4.19](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.19) | 2021-03-04 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.19](https://github.com/swagger-api/swagger-codegen/tree/v2.4.19) +[2.4.18](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.18) | 2020-12-29 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.18](https://github.com/swagger-api/swagger-codegen/tree/v2.4.18) +[2.4.17](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.17) | 2020-11-02 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.17](https://github.com/swagger-api/swagger-codegen/tree/v2.4.17) +[2.4.16](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.16) | 2020-10-05 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.16](https://github.com/swagger-api/swagger-codegen/tree/v2.4.16) +[2.4.15](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.15) | 2020-07-28 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.15](https://github.com/swagger-api/swagger-codegen/tree/v2.4.15) +[2.4.14](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.14) | 2020-05-18 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.14](https://github.com/swagger-api/swagger-codegen/tree/v2.4.14) +[2.4.13](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.13) | 2020-04-02 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.13](https://github.com/swagger-api/swagger-codegen/tree/v2.4.13) +[2.4.12](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.12) | 2020-01-15 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.12](https://github.com/swagger-api/swagger-codegen/tree/v2.4.12) +[2.4.11](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.11) | 2020-01-03 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.11](https://github.com/swagger-api/swagger-codegen/tree/v2.4.11) +[2.4.10](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.10) | 2019-11-16 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.10](https://github.com/swagger-api/swagger-codegen/tree/v2.4.10) +[2.4.9](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.9) | 2019-10-14 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.9](https://github.com/swagger-api/swagger-codegen/tree/v2.4.9) +[2.4.8](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.8) | 2019-08-24 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.8](https://github.com/swagger-api/swagger-codegen/tree/v2.4.8) +[2.4.7](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.7) | 2019-07-11 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.7](https://github.com/swagger-api/swagger-codegen/tree/v2.4.7) +[2.4.6](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.6) | 2019-06-28 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.6](https://github.com/swagger-api/swagger-codegen/tree/v2.4.6) +[2.4.5](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.5) | 2019-04-25 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.5](https://github.com/swagger-api/swagger-codegen/tree/v2.4.5) +[2.4.4](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.4) | 2019-03-26 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.4](https://github.com/swagger-api/swagger-codegen/tree/v2.4.4) +[2.4.2](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.2) | 2019-02-18 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.2](https://github.com/swagger-api/swagger-codegen/tree/v2.4.2) +[2.4.1](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.1) | 2019-01-16 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.1](https://github.com/swagger-api/swagger-codegen/tree/v2.4.1) +[2.4.0](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.4.0) | 2018-11-30 | 1.0, 1.1, 1.2, 2.0 | [tag v2.4.0](https://github.com/swagger-api/swagger-codegen/tree/v2.4.0) +[2.3.1](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.3.1) | 2018-01-17 | 1.0, 1.1, 1.2, 2.0 | [tag v2.3.1](https://github.com/swagger-api/swagger-codegen/tree/v2.3.1) +[2.3.0](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.3.0) | 2017-12-21 | 1.0, 1.1, 1.2, 2.0 | [tag v2.3.0](https://github.com/swagger-api/swagger-codegen/tree/v2.3.0) +[2.2.3](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.2.3) | 2017-07-15 | 1.0, 1.1, 1.2, 2.0 | [tag v2.2.3](https://github.com/swagger-api/swagger-codegen/tree/v2.2.3) +[2.2.2](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.2.2) | 2017-03-01 | 1.0, 1.1, 1.2, 2.0 | [tag v2.2.2](https://github.com/swagger-api/swagger-codegen/tree/v2.2.2) +[2.2.1](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.2.1) | 2016-08-07 | 1.0, 1.1, 1.2, 2.0 | [tag v2.2.1](https://github.com/swagger-api/swagger-codegen/tree/v2.2.1) +[2.1.6](https://github.com/swagger-api/swagger-codegen/releases/tag/v2.1.6) | 2016-04-06 | 1.0, 1.1, 1.2, 2.0 | [tag v2.1.6](https://github.com/swagger-api/swagger-codegen/tree/v2.1.6) +2.0.17 | 2014-08-22 | 1.1, 1.2 | [tag v2.0.17](https://github.com/swagger-api/swagger-codegen/tree/2.0.17) +1.0.4 | 2012-04-12 | 1.0, 1.1 | [tag v1.0.4](https://github.com/swagger-api/swagger-codegen/tree/swagger-codegen_2.9.1-1.1) \ No newline at end of file diff --git a/docs/consumers.md b/docs/consumers.md new file mode 100644 index 00000000000..86c18c882b7 --- /dev/null +++ b/docs/consumers.md @@ -0,0 +1,159 @@ +# Companies leveraging Swagger Codegen + +Here are some companies/projects using Swagger Codegen in production. To add your company/project to the list, please raise a PR. + +- [Acando](https://www.acando.de/) +- [Accengage](https://www.accengage.com/) +- [Accruent](https://www.accruent.com/) +- [Activehours](https://www.activehours.com/) +- [Actonica](https://www.actonica.com) +- [Acunetix](https://www.acunetix.com/) +- [Adaptant](https://www.adaptant.io/) +- [Atlassian](https://www.atlassian.com/) +- [Autodesk](http://www.autodesk.com/) +- [Avenida Compras S.A.](https://www.avenida.com.ar) +- [AYLIEN](http://aylien.com/) +- [Balance Internet](https://www.balanceinternet.com.au/) +- [beemo](http://www.beemo.eu) +- [bitly](https://bitly.com) +- [BeezUP](http://www.beezup.com) +- [Box](https://box.com) +- [Bufferfly Network](https://www.butterflynetinc.com/) +- [Cachet Financial](http://www.cachetfinancial.com/) +- [carpolo](http://www.carpolo.co/) +- [Carus](https://www.carus.com/) +- [Cisco](http://www.cisco.com/) +- [CloudBoost](https://www.CloudBoost.io/) +- [Cloudsmith](https://cloudsmith.io/) +- [Conplement](http://www.conplement.de/) +- [Cummins](http://www.cummins.com/) +- [Cupix](http://www.cupix.com) +- [DBBest Technologies](https://www.dbbest.com) +- [DecentFoX](http://decentfox.com/) +- [DocRaptor](https://docraptor.com) +- [DocuSign](https://www.docusign.com) +- [Elastic](https://www.elastic.co/) +- [Ergon](http://www.ergon.ch/) +- [Dell EMC](https://www.emc.com/) +- [eureka](http://eure.jp/) +- [everystory.us](http://everystory.us) +- [Expected Behavior](http://www.expectedbehavior.com/) +- [fashionTrade](https://www.fashiontrade.com/) +- [Fastly](https://www.fastly.com/) +- [FINRA](https://github.com/FINRAOS/herd/) +- [Flat](https://flat.io) +- [Finder](http://en.finder.pl/) +- [Fitwell](https://fitwell.co/) +- [FH Münster - University of Applied Sciences](http://www.fh-muenster.de) +- [FormAPI](https://formapi.io/) +- [Fotition](https://www.fotition.com/) +- [Gear Zero Network](https://www.gearzero.ca) +- [General Electric](https://www.ge.com/) +- [Genentech](https://gene.com) +- [Genesys - PureCloud](http://developer.mypurecloud.com/) +- [Germin8](http://www.germin8.com) +- [GigaSpaces](http://www.gigaspaces.com) +- [GMO Pepabo](https://pepabo.com/en/) +- [goTransverse](http://www.gotransverse.com/api) +- [GraphHopper](https://graphhopper.com/) +- [Gravitate Solutions](http://gravitatesolutions.com/) +- [HashData](http://www.hashdata.cn/) +- [Hewlett Packard Enterprise](https://hpe.com) +- [High Technologies Center](http://htc-cs.com) +- [Hootsuite](https://hootsuite.com/) +- [Huawei Cloud](http://www.huaweicloud.com/en-us/product/cs.html) +- [Husbanken](https://www.husbanken.no) +- [IBM](https://www.ibm.com) +- [IMS Health](http://www.imshealth.com/en/solution-areas/technology-and-applications) +- [Individual Standard IVS](http://www.individual-standard.com) +- [INSPIDE](http://www.inspide.com) +- [Intent HQ](http://www.intenthq.com) +- [Kabuku](http://www.kabuku.co.jp/en) +- [Kurio](https://kurio.co.id) +- [Kuroi](http://kuroiwebdesign.com/) +- [Kuary](https://kuary.com/) +- [Kubernetes](https://kubernetes.io/) +- [LANDR Audio](https://www.landr.com/) +- [Lascaux](http://www.lascaux.it/) +- [Leanix](http://www.leanix.net/) +- [Leica Geosystems AG](http://leica-geosystems.com) +- [LiveAgent](https://www.ladesk.com/) +- [LXL Tech](http://lxltech.com) +- [Lyft](https://www.lyft.com/developers) +- [MailMojo](https://mailmojo.no/) +- [Metaswitch](https://www.metaswitch.com/) +- [Mindera](http://mindera.com/) +- [ModuleQ](https://moduleq.com) +- [Mporium](http://mporium.com/) +- [Neverfail](https://neverfail.com/) +- [NexCap](http://www.nexess-solutions.com/fr/plateforme-iot/) +- [Nitrobox](https://www.nitrobox.com) +- [Norwegian Air Shuttle](https://www.norwegian.com/) +- [NTT DATA](http://www.nttdata.com/) +- [nViso](http://www.nviso.ch/) +- [NHSD](https://digital.nhs.uk/) +- [Okiok](https://www.okiok.com) +- [Onedata](http://onedata.org) +- [Open International Systems](https://openintl.com/) +- [OrderCloud.io](http://ordercloud.io) +- [OSDN](https://osdn.jp) +- [PagerDuty](https://www.pagerduty.com) +- [PagerTree](https://pagertree.com) +- [Pepipost](https://www.pepipost.com) +- [Peatio Tech](https://www.peatio.tech) +- [Plexxi](http://www.plexxi.com) +- [Pixoneye](http://www.pixoneye.com/) +- [PostAffiliatePro](https://www.postaffiliatepro.com/) +- [PracticeBird](https://www.practicebird.com/) +- [Prill Tecnologia](http://www.prill.com.br) +- [Prokarma](https://www.prokarma.com) +- [QAdept](http://qadept.com/) +- [QuantiModo](https://quantimo.do/) +- [QuickBlox](https://quickblox.com/) +- [Rapid7](https://rapid7.com/) +- [Red Hat](https://www.redhat.com/) +- [Reload! A/S](https://reload.dk/) +- [REstore](https://www.restore.eu) +- [REST United](https://restunited.com) +- [Revault Sàrl](http://revault.ch) +- [Riffyn](https://riffyn.com) +- [Roche](https://roche.com) +- [Royal Bank of Canada (RBC)](http://www.rbc.com/canada.html) +- [Saritasa](https://www.saritasa.com/) +- [SAS](https://www.sas.com) +- [SCOOP Software GmbH](http://www.scoop-software.de) +- [SessionM](https://www.sessionm.com/) +- [Shine Solutions](https://shinesolutions.com/) +- [Simpfony](https://www.simpfony.com/) +- [Skurt](http://www.skurt.com) +- [Slamby](https://www.slamby.com/) +- [SmartRecruiters](https://www.smartrecruiters.com/) +- [snapCX](https://snapcx.io) +- [SPINEN](http://www.spinen.com) +- [Sponsoo](https://www.sponsoo.de) +- [SRC](https://www.src.si/) +- [Stardog Ventures](https://www.stardog.io) +- [Stingray](http://www.stingray.com) +- [StyleRecipe](http://stylerecipe.co.jp) +- [Svenska Spel AB](https://www.svenskaspel.se/) +- [Switch Database](https://www.switchdatabase.com/) +- [TaskData](http://www.taskdata.com/) +- [ThirdWatch.ai](https://www.thirdwatch.ai/) +- [ThoughtWorks](https://www.thoughtworks.com) +- [Tpay](https://tpay.com) +- [Trexle](https://trexle.com/) +- [Upwork](http://upwork.com/) +- [uShip](https://www.uship.com/) +- [Variograma](https://variograma.pt) +- [VMware](https://vmware.com/) +- [Viavi Solutions Inc.](https://www.viavisolutions.com) +- [W.UP](http://wup.hu/?siteLang=en) +- [Wealthfront](https://www.wealthfront.com/) +- [Webever GmbH](https://www.webever.de/) +- [WEXO A/S](https://www.wexo.dk/) +- [XSky](http://www.xsky.com/) +- [Yelp](http://www.yelp.com/) +- [Zalando](https://tech.zalando.com) +- [ZEEF.com](https://zeef.com/) +- [zooplus](https://www.zooplus.com/) +- [Trifork](https://www.trifork.com/) \ No newline at end of file diff --git a/docs/docker.md b/docs/docker.md new file mode 100644 index 00000000000..f9ad0fb4fae --- /dev/null +++ b/docs/docker.md @@ -0,0 +1,92 @@ +# Docker + +## 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`: + +```sh +git clone https://github.com/swagger-api/swagger-codegen +cd swagger-codegen +./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 swagger-codegen-cli. To generate code, you'll need to output to a directory under `/gen` (e.g. `/gen/out`). For example: + +```sh +./run-in-docker.sh help # Executes 'help' command for swagger-codegen-cli +./run-in-docker.sh langs # Executes 'langs' command for swagger-codegen-cli +./run-in-docker.sh /gen/bin/go-petstore.sh # Builds the Go client +./run-in-docker.sh generate -i modules/swagger-codegen/src/test/resources/2_0/petstore.yaml \ + -l go -o /gen/out/go-petstore -DpackageName=petstore # generates go client, outputs locally to ./out/go-petstore +``` + +## Standalone generator Development in docker + +See [standalone generator development](https://github.com/swagger-api/swagger-codegen/blob/master/standalone-gen-dev/standalone-generator-development.md) + +## Run Docker in Vagrant + +Prerequisite: install [Vagrant](https://www.vagrantup.com/downloads.html) and [VirtualBox](https://www.virtualbox.org/wiki/Downloads). + + ```sh +git clone http://github.com/swagger-api/swagger-codegen.git +cd swagger-codegen +vagrant up +vagrant ssh +cd /vagrant +./run-in-docker.sh mvn package + ``` + +## Public Pre-built Docker images + +- https://hub.docker.com/r/swaggerapi/swagger-generator/ (official web service) +- https://hub.docker.com/r/swaggerapi/swagger-codegen-cli/ (official CLI) + +### Swagger Generator Docker Image + +The Swagger Generator 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 (note this assumes `jq` is installed for command line processing of JSON): + +```sh +# Start container and save the container id +CID=$(docker run -d swaggerapi/swagger-generator) +# allow for startup +sleep 5 +# Get the IP of the running container +GEN_IP=$(docker inspect --format '{{.NetworkSettings.IPAddress}}' $CID) +# Execute an HTTP request and store the download link +RESULT=$(curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{ + "swaggerUrl": "https://petstore.swagger.io/v2/swagger.json" +}' 'http://localhost:8188/api/gen/clients/javascript' | jq '.link' | tr -d '"') +# Download the generated zip and redirect to a file +curl $RESULT > result.zip +# Shutdown the swagger generator image +docker stop $CID && docker rm $CID +``` + +In the example above, `result.zip` will contain the generated client. + +### Swagger Codegen CLI Docker Image + +The Swagger Codegen 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: + +```sh +docker run --rm -v ${PWD}:/local swaggerapi/swagger-codegen-cli generate \ + -i https://petstore.swagger.io/v2/swagger.json \ + -l go \ + -o /local/out/go +``` + +(On Windows replace `${PWD}` with `%CD%`) + +The generated code will be located under `./out/go` in the current directory. diff --git a/docs/generation-selective.md b/docs/generation-selective.md new file mode 100644 index 00000000000..76eb93762e8 --- /dev/null +++ b/docs/generation-selective.md @@ -0,0 +1,51 @@ +# Selective generation + +You may not want to generate *all* models in your project. Likewise you may want just one or two apis to be written. If that's the case, you can use system properties to control the output: + +The default is generate *everything* supported by the specific library. Once you enable a feature, it will restrict the contents generated: + +```sh +# generate only models +java -Dmodels {opts} + +# generate only apis +java -Dapis {opts} + +# generate only supporting files +java -DsupportingFiles + +# generate models and supporting files +java -Dmodels -DsupportingFiles +``` + +To control the specific files being generated, you can pass a CSV list of what you want: + +```sh +# generate the User and Pet models only +-Dmodels=User,Pet + +# generate the User model and the supportingFile `StringUtil.java`: +-Dmodels=User -DsupportingFiles=StringUtil.java +``` + +To control generation of docs and tests for api and models, pass false to the option. For api, these options are `-DapiTests=false` and `-DapiDocs=false`. For models, `-DmodelTests=false` and `-DmodelDocs=false`. +These options default to true and don't limit the generation of the feature options listed above (like `-Dapi`): + +```sh +# generate only models (with tests and documentation) +java -Dmodels {opts} + +# generate only models (with tests but no documentation) +java -Dmodels -DmodelDocs=false {opts} + +# generate only User and Pet models (no tests and no documentation) +java -Dmodels=User,Pet -DmodelTests=false {opts} + +# generate only apis (without tests) +java -Dapis -DapiTests=false {opts} + +# generate only apis (modelTests option is ignored) +java -Dapis -DmodelTests=false {opts} +``` + +When using selective generation, _only_ the templates needed for the specific generation will be used. diff --git a/docs/generators-configuration.md b/docs/generators-configuration.md new file mode 100644 index 00000000000..db85239ae58 --- /dev/null +++ b/docs/generators-configuration.md @@ -0,0 +1,119 @@ +# Advanced Generator Customization + +There are different aspects of customizing the code generator beyond just creating or modifying templates. Each language has a supporting configuration file to handle different type mappings, etc: + +```sh +$ ls -1 modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/ +AbstractJavaJAXRSServerCodegen.java +AbstractTypeScriptClientCodegen.java +... (results omitted) +TypeScriptAngularClientCodegen.java +TypeScriptNodeClientCodegen.java +``` + +Each of these files creates reasonable defaults so you can get running quickly. But if you want to configure package names, prefixes, model folders, etc. you can use a json config file to pass the values. + +```sh +java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ + -i https://petstore.swagger.io/v2/swagger.json \ + -l java \ + -o samples/client/petstore/java \ + -c path/to/config.json +``` + +and `config.json` contains the following as an example: + +```json +{ + "apiPackage" : "petstore" +} +``` + +Supported config options can be different per language. Running `config-help -l {lang}` will show available options. +**These options are applied via configuration file (e.g. config.json) or by passing them with `java -jar swagger-codegen-cli.jar -D{optionName}={optionValue}`**. (If `-D{optionName}` does not work, please open a [ticket](https://github.com/swagger-api/swagger-codegen/issues/new) and we'll look into it) + +```sh +java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar config-help -l java +``` + +Output + +```text +CONFIG OPTIONS +modelPackage + package for generated models + +apiPackage + package for generated api classes +...... (results omitted) +library + library template (sub-template) to use: + jersey1 - HTTP client: Jersey client 1.18. JSON processing: Jackson 2.4.2 + jersey2 - HTTP client: Jersey client 2.6 + feign - HTTP client: Netflix Feign 8.1.1. JSON processing: Jackson 2.6.3 + okhttp-gson (default) - HTTP client: OkHttp 2.4.0. JSON processing: Gson 2.3.1 + retrofit - HTTP client: OkHttp 2.4.0. JSON processing: Gson 2.3.1 (Retrofit 1.9.0) + retrofit2 - HTTP client: OkHttp 2.5.0. JSON processing: Gson 2.4 (Retrofit 2.0.0-beta2) + google-api-client - HTTP client: google-api-client 1.23.0. JSON processing: Jackson 2.8.9 + rest-assured - HTTP client: rest-assured : 3.1.0. JSON processing: Gson 2.6.1. Only for Java8 +``` + +Your config file for Java can look like + +```json +{ + "groupId": "com.my.company", + "artifactId": "MyClient", + "artifactVersion": "1.2.0", + "library": "feign" +} +``` + +For all the unspecified options default values will be used. + +Another way to override default options is to extend the config class for the specific language. +To change, for example, the prefix for the Objective-C generated files, simply subclass the `ObjcClientCodegen.java`: + +```java +package com.mycompany.swagger.codegen; + +import io.swagger.codegen.languages.*; + +public class MyObjcCodegen extends ObjcClientCodegen { + static { + PREFIX = "HELO"; + } +} +``` + +and specify the `classname` when running the generator: + +```sh +-l com.mycompany.swagger.codegen.MyObjcCodegen +``` + +Your subclass will now be loaded and overrides the `PREFIX` value in the superclass. + +## Bringing your own models + +Sometimes you don't want a model generated. In this case, you can simply specify an import mapping to tell +the codegen what _not_ to create. When doing this, every location that references a specific model will +refer back to your classes. Note, this may not apply to all languages... + +To specify an import mapping, use the `--import-mappings` argument and specify the model-to-import logic as such: + +```sh +--import-mappings Pet=my.models.MyPet +``` + +Or for multiple mappings: + +```sh +--import-mappings Pet=my.models.MyPet,Order=my.models.MyOrder +``` + +or + +```sh +--import-mappings Pet=my.models.MyPet --import-mappings Order=my.models.MyOrder +``` diff --git a/docs/generators.md b/docs/generators.md new file mode 100644 index 00000000000..d87580b21ad --- /dev/null +++ b/docs/generators.md @@ -0,0 +1,96 @@ +# Generators + +If the default generator configuration does not meet your needs, you have various options to modify or create new modules or templates. + +## Modifying the client library format + +Don't like the default swagger client syntax? Want a different language supported? No problem! Swagger Codegen processes mustache templates with the [jmustache](https://github.com/samskivert/jmustache) engine. You can modify our templates or make your own. + +You can look at `modules/swagger-codegen/src/main/resources/${your-language}` for examples. To make your own templates, create your own files and use the `-t` flag to specify your template folder. It actually is that easy. + +## Making your own codegen modules + +If you're starting a project with a new language and don't see what you need, Swagger Codegen can help you create a project to generate your own libraries: + +```sh +java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar meta \ + -o output/myLibrary -n myClientCodegen -p com.my.company.codegen +``` + +This will write, in the folder `output/myLibrary`, all the files you need to get started, including a `README.md. Once modified and compiled, you can load your library with the codegen and generate clients with your own, custom-rolled logic. + +You would then compile your library in the `output/myLibrary` folder with `mvn package` and execute the codegen like such: + +```sh +java -cp output/myLibrary/target/myClientCodegen-swagger-codegen-1.0.0.jar:modules/swagger-codegen-cli/target/swagger-codegen-cli.jar io.swagger.codegen.SwaggerCodegen +``` + +For Windows users, you will need to use `;` instead of `:` in the classpath, e.g.: + +```sh +java -cp output/myLibrary/target/myClientCodegen-swagger-codegen-1.0.0.jar;modules/swagger-codegen-cli/target/swagger-codegen-cli.jar io.swagger.codegen.SwaggerCodegen +``` + +Note the `myClientCodegen` is an option now, and you can use the usual arguments for generating your library: + +```sh +java -cp output/myLibrary/target/myClientCodegen-swagger-codegen-1.0.0.jar:modules/swagger-codegen-cli/target/swagger-codegen-cli.jar \ + io.swagger.codegen.SwaggerCodegen generate -l myClientCodegen\ + -i https://petstore.swagger.io/v2/swagger.json \ + -o myClient +``` + +See also [standalone generator development](https://github.com/swagger-api/swagger-codegen/blob/master/standalone-gen-dev/standalone-generator-development.md). + +## Generating a client from local files + +If you don't want to call your server, you can save the OpenAPI Spec files into a directory and pass an argument +to the code generator like this: + +```sh +-i ./modules/swagger-codegen/src/test/resources/2_0/petstore.json +``` + +Great for creating libraries on your ci server, from the [Swagger Editor](http://editor.swagger.io)... or while coding on an airplane. + +## Ignore file format + +Swagger Codegen supports a `.swagger-codegen-ignore` file, similar to `.gitignore` or `.dockerignore` you're probably already familiar with. + +The ignore file allows for better control over overwriting existing files than the `--skip-overwrite` flag. With the ignore file, you can specify individual files or directories can be ignored. This can be useful, for example if you only want a subset of the generated code. + +Examples: + +```sh +# Swagger Codegen Ignore +# Lines beginning with a # are comments + +# This should match build.sh located anywhere. +build.sh + +# Matches build.sh in the root +/build.sh + +# Exclude all recursively +docs/** + +# Explicitly allow files excluded by other rules +!docs/UserApi.md + +# Recursively exclude directories named Api +# You can't negate files below this directory. +src/**/Api/ + +# When this file is nested under /Api (excluded above), +# this rule is ignored because parent directory is excluded by previous rule. +!src/**/PetApiTests.cs + +# Exclude a single, nested file explicitly +src/IO.Swagger.Test/Model/AnimalFarmTests.cs +``` + +The `.swagger-codegen-ignore` file must exist in the root of the output directory. + +Upon first code generation, you may also pass the CLI option `--ignore-file-override=/path/to/ignore_file` for greater control over generated outputs. Note that this is a complete override, and will override the `.swagger-codegen-ignore` file in an output directory when regenerating code. + +Editor support for `.swagger-codegen-ignore` files is available in IntelliJ via the [.ignore plugin](https://plugins.jetbrains.com/plugin/7495--ignore). diff --git a/docs/online-generators.md b/docs/online-generators.md new file mode 100644 index 00000000000..8217ab61427 --- /dev/null +++ b/docs/online-generators.md @@ -0,0 +1,81 @@ + +# Online generators + +One can also generate API client or server using the online generators (https://generator.swagger.io) + +For example, to generate Ruby API client, simply send the following HTTP request using curl: + +```sh +curl -X POST -H "content-type:application/json" -d '{"swaggerUrl":"https://petstore.swagger.io/v2/swagger.json"}' https://generator.swagger.io/api/gen/clients/ruby +``` + +Then you will receive a JSON response with the URL to download the zipped code. + +To customize the SDK, you can `POST` to `https://generator.swagger.io/api/gen/clients/{language}` with the following HTTP body: + +```json +{ + "options": {}, + "swaggerUrl": "https://petstore.swagger.io/v2/swagger.json" +} +``` + +in which the `options` for a language can be obtained by submitting a `GET` request to `https://generator.swagger.io/api/gen/clients/{language}`: + +For example, `curl https://generator.swagger.io/api/gen/clients/python` returns + +```json +{ + "packageName": { + "opt": "packageName", + "description": "python package name (convention: snake_case).", + "type": "string", + "default": "swagger_client" + }, + "packageVersion": { + "opt": "packageVersion", + "description": "python package version.", + "type": "string", + "default": "1.0.0" + }, + "sortParamsByRequiredFlag": { + "opt": "sortParamsByRequiredFlag", + "description": "Sort method arguments to place required parameters before optional parameters.", + "type": "boolean", + "default": "true" + } +} +``` + +To set package name to `pet_store`, the HTTP body of the request is as follows: + +```json +{ + "options": { + "packageName": "pet_store" + }, + "swaggerUrl": "https://petstore.swagger.io/v2/swagger.json" +} +``` + +and here is the curl command: + +```sh +curl -H "Content-type: application/json" -X POST -d '{"options": {"packageName": "pet_store"},"swaggerUrl": "https://petstore.swagger.io/v2/swagger.json"}' https://generator.swagger.io/api/gen/clients/python +``` + +Instead of using `swaggerUrl` with an URL to the OpenAPI/Swagger spec, one can include the spec in the JSON payload with `spec`, e.g. + +```json +{ + "options": {}, + "spec": { + "swagger": "2.0", + "info": { + "version": "1.0.0", + "title": "Test API" + }, + ... + } +} +``` diff --git a/docs/prerequisites.md b/docs/prerequisites.md new file mode 100644 index 00000000000..89e77872328 --- /dev/null +++ b/docs/prerequisites.md @@ -0,0 +1,46 @@ +# Prerequisites + +If you're looking for the latest stable version, you can grab it directly from Maven.org (Java 8 runtime at a minimum): + +```sh +# Download current stable 2.x.x branch (Swagger and OpenAPI version 2) +wget https://repo1.maven.org/maven2/io/swagger/swagger-codegen-cli/2.4.43/swagger-codegen-cli-2.4.43.jar -O swagger-codegen-cli.jar + +java -jar swagger-codegen-cli.jar help + +# Download current stable 3.x.x branch (OpenAPI version 3) +wget https://repo1.maven.org/maven2/io/swagger/codegen/v3/swagger-codegen-cli/3.0.62/swagger-codegen-cli-3.0.62.jar -O swagger-codegen-cli.jar + +java -jar swagger-codegen-cli.jar --help +``` + +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+). + +example: + +```powershell +Invoke-WebRequest -OutFile swagger-codegen-cli.jar https://repo1.maven.org/maven2/io/swagger/swagger-codegen-cli/2.4.43/swagger-codegen-cli-2.4.43.jar +``` + +On a mac, it's even easier with `brew`: + +```sh +brew install swagger-codegen +``` + +To build from source, you need the following installed and available in your `$PATH:` + +- [Java 11+](http://java.oracle.com) + +- [Apache maven 3.6.2 or greater](http://maven.apache.org/) + +## OS X Users + +Don't forget to install Java 11+. + +Export `JAVA_HOME` in order to use the supported Java version: + +```sh +export JAVA_HOME=`/usr/libexec/java_home -v 11` +export PATH=${JAVA_HOME}/bin:$PATH +``` \ No newline at end of file diff --git a/docs/public-content.md b/docs/public-content.md new file mode 100644 index 00000000000..d0570a65925 --- /dev/null +++ b/docs/public-content.md @@ -0,0 +1,62 @@ +# Content and material showcasing Swagger Codegen + +Here's a legacy list of useful content on Swagger Codegen. If you would like to add to the listing, please raise a PR. + +- 2011/08/31 - [Introducing Swagger](https://www.slideshare.net/fehguy/introducing-swagger) by [Tony Tam](https://twitter.com/fehguy) +- 2014/05/22 - [Swagger APIs for Humans and Robots](https://www.slideshare.net/fehguy/swagger-apis-for-humans-and-robots-gluecon) by [Tony Tam](https://twitter.com/fehguy) at [Gluecon](http://gluecon.com/) +- 2014/11/11 - [Genie 2.0: Second Wish Granted!](https://medium.com/netflix-techblog/genie-2-0-second-wish-granted-d888d79455c6) by [Tom Gianos](http://www.linkedin.com/in/thomasgianos/) and [Amit Sharma](https://www.linkedin.com/pub/amit-sharma/5/163/a83) @ [Netflix](https://www.netflix.com/) Big Data Platform Team +- 2015/07/28 - [Enriching RESTful Services with Swagger](https://blog.philipphauer.de/enriching-restful-services-swagger/) by [Philipp Hauer](https://blog.philipphauer.de/) +- 2015/11/11 - [Generate client stubs & document your REST-API using Swagger & Spring](https://www.youtube.com/watch?v=43GhBbP--oI) by [Johannes Fiala](https://github.com/jfiala) @ Devoxx Belgium 2015 +- 2015/12/03 - [こんなに簡単! Swagger Codegenのカスタマイズ](http://qiita.com/Quramy/items/c583f3213f0b77ff1bac) by [Quramy](http://qiita.com/Quramy) +- 2016/01/12 - [Generate client side code using Swagger Codegen](http://rnavagamuwa.com/open-source/generate-client-side-code-using-swagger-codegen/) by [RNAVAGAMUWA](http://rnavagamuwa.com/author/admin/) +- 2016/01/15 - [How to end manual REST-API client coding](https://www.youtube.com/watch?v=RzZRdqZp6Oo) by [Johannes Fiala](https://github.com/jfiala) @ dotJS 2015 +- 2016/04/27 - [Automated REST API Development](https://yos.io/2016/04/27/automated-api-development/) by [Yos Riady](https://www.linkedin.com/in/yosriady) +- 2016/05/29 - [Generating Java Spring-MVC code from Swagger Spec](https://www.clianz.com/2016/05/29/java-mvc-swagger-gen/) by [@icha024](https://github.com/icha024) +- 2016/07/22 - [Building Microservices? Here is what you should know](https://cloudncode.blog/2016/07/22/msa-getting-started/) by Sumit Maingi +- 2016/08/23 - [Generating Dreamfactory Client SDKs based on Swagger API Definitions](http://blog.dreamfactory.com/generating-dreamfactory-client-sdks-based-on-swagger-api-definitions) by [Phil Schuler](https://github.com/philicious/) +- 2016/09/28 - [1 UNBELIEVABLE TRICK TO CREATE AN EASY TO CONSUME API IN .NET](https://stapp.space/1-simple-trick-to-create-a-good-api-in-net/) by [Piotr Stapp](https://stapp.space/author/piotr-stapp/) +- 2016/10/10 - [Using swagger-codegen with Marketo](http://developers.marketo.com/blog/using-swagger-codegen-with-marketo/) by [Kenny Elkington](http://developers.marketo.com/blog/using-swagger-codegen-with-marketo/) +- 2016/10/12 - [Designing a Swagger API](https://sookocheff.com/post/api/swagger/) by [Kevin Sookocheff](https://sookocheff.com/) +- 2016/11/05 - [How to generate a REST Application](https://www.youtube.com/watch?v=iyC9BWMe75Q) by [Johannes Fiala](https://github.com/jfiala) @ DevFest Vienna 2016 +- 2016/11/10 - [Building an AEM API clients ecosystem](http://blog.cliffano.com/2016/11/10/adobe-marketing-cloud-community-expo/) by Cliffano Subagio, Michael Diender, Stephen Shim from [Shine Solutions](https://shinesolutions.com/) @ [Adobe Marketing Cloud Community Expo (AMCCE)](https://www.meetup.com/Melbourne-AEM-CQ-Meetup/events/233363101/) +- 2016/11/18 - [How to generate a REST CXF3 application from Swagger-Contract](https://www.slideshare.net/johannes_fiala/how-to-generate-a-rest-cxf3-application-from-swagger-apacheconeu-2016) by [Johannes Fiala](https://github.com/jfiala) @ ApacheConEU 2016 +- 2016/11/25 - [Swagger Codegen for Swift3 and NodeJS](https://normand1.github.io/blog/swift/swagger/codegen/2016/11/25/Swagger-Codegen-for-Swift3-and-NodeJS.html) by [David Norman](https://github.com/normand1) +- 2016/12/08 - [Building an API with Swagger](https://www.youtube.com/watch?v=PbwQWw7xSOM) +- 2016/12/08 - [Generate client side code using Swagger Codegen](https://carra-lucia-ltd.co.uk/2016/12/08/generate-client-side-code-using-swagger-codegen/) by [theFerkel](https://carra-lucia-ltd.co.uk/author/theferkel/) +- 2017/01/16 - [Zero to API in 4 minutes](https://cidrblock.github.io/zero-to-api-in-4-minutes.html) by [Bradley A. Thornton](https://github.com/cidrblock) +- 2017/02/09 - [「Swaggerを利用した新規サービス開発」というタイトルで登壇して来ました](https://techblog.recochoku.jp/1055) by [recotech](https://www.slideshare.net/recotech) +- 2017/03/03 - [Swagger Codegen の使い方の簡単な説明です](https://speakerdeck.com/wagyu298/swagger-codegen) by [wagyu298](https://github.com/wagyu298) +- 2017/03/24 - [Using Open API Specification To Put Lyft SDK Support in the Fast Lane](https://medium.com/lyft-developer-platform/using-open-api-specification-to-put-lyft-sdk-support-in-the-fast-lane-7b623218e4ee) by [Val Polouchkine](https://github.com/vpolouchkine) +- 2017/04/13 - [Automatically Generating your API Client with Swagger and Swagger Codegen](https://www.youtube.com/watch?v=EzKwi-u9jQo) by [Jesse Collis](https://github.com/jessedc) @ Melbourne Cocoaheads +- 2017/04/27 - [Swagger Codegen のPHP実装があまりにアレだったので、ライブラリ自作して公開してみた](http://qiita.com/imunew/items/2e9c472e0097e329f2cd) by [imunew](http://qiita.com/imunew) +- 2017/05/17 - [Diseño de APIs con OpenAPI](https://www.slideshare.net/pjmolina/diseo-de-apis-con-openapi) by [Pedro J. Molina](https://github.com/pjmolina) @ [JSDayES 2017](http://2017.jsday.es/) +- 2017/05/22 - [Presentation of the Vert.x-Swagger project](http://vertx.io/blog/presentation-of-the-vert-x-swagger-project/) by [@phiz71](http://github.com/phiz71) +- 2017/05/22 - [Automatically generating your API from a swagger file using gradle](https://www.jcore.com/2017/05/22/automatically-generating-api-using-swagger-and-gradle/) by [Deniz Turan](https://www.jcore.com/author/deniz/) +- 2017/06/21 - [Swagger Presentation - Warsaw Ruby Users Group](https://www.youtube.com/watch?v=uCnnDMFQB8U) by [@rafalpetryka](http://github.com/rafalpetryka) +- 2017/06/29 - [Making SDKs: the bespoke, the hopeful and the generated](https://devrel.net/developer-experience/making-sdks-bespoke-hopeful-generated) by [Tristan Sokol](https://github.com/tristansokol) ([Square](https://github.com/square)) at DevXcon 2017 +- 2017/07/11 - [OpenAPI development with Python](https://www.slideshare.net/TakuroWada/20170711-euro-python2017) by [和田拓朗](https://github.com/taxpon) at [EuroPython 2017](https://ep2017.europython.eu/en/) +- 2017/07/29 - [How Square makes its SDKs](https://medium.com/square-corner-blog/how-square-makes-its-sdks-6a0fd7ea4b2d) by [Tristan Sokol](https://github.com/tristansokol) ([Square](https://github.com/square)) +- 2017/07/31 - [How to Generate a Deployable REST CXF3 Application from a Swagger-Contract](https://www.youtube.com/watch?v=gM63rJlUHZQ) by [Johannes Fiala](https://github.com/jfiala) @ Voxxed Days Vienna +- 2017/08/11 - [Swagger Codegen 自动生成Retrofit 代码](https://juejin.im/entry/598d8eb86fb9a03c52459e2a) by [徐磊](http://www.jianshu.com/u/792c738b33fc) +- 2017/08/24 - [APIs First](https://engineering.squarespace.com/blog/2017/apis-first) by [roykachouh](https://github.com/roykachouh) ([Square](https://github.com/square)) +- 2017/08/31 - [Bringing Jenkins Remote Access API To The Masses](http://blog.cliffano.com/2017/09/01/jenkins-world-2017/) by [Cliffano Subagio](http://cliffano.com) from [Shine Solutions](https://shinesolutions.com/) @ [Jenkins World 2017](https://jenkinsworld20162017.sched.com/) +- 2017/09/08 - [Swagger Codegen で自動生成したクライアントSDKを使う(iOS編)](http://blog.techium.jp/entry/2017/09/08/071650) by [kfurue](http://profile.hatena.ne.jp/kfurue/) +- 2017/09/09 - [Swagger Codegen で自動生成したクライアントSDKを使う(RxSwift 編)](http://blog.techium.jp/entry/2017/09/09/113003) by [kfurue](http://profile.hatena.ne.jp/kfurue/) +- 2017/09/09 - [OpenAPIを利用したPythonWebアプリケーション開発](https://www.slideshare.net/TakuroWada/openapipythonweb) by [和田拓朗](https://github.com/taxpon) at [PyCon JP 2017](https://pycon.jp/2017/ja/) +- 2017/09/21 - [Generating an Elastic Cloud Enterprise Client](https://www.elastic.co/blog/generating-an-elastic-cloud-enterprise-client) by [Greg Marzouka](https://github.com/gmarz) ([Elastic](https://www.elastic.co/)) +- 2017/09/26 - [How to Use IoT Application Enablement Api Hub JSON Descriptor in Postman and How to Generate Client Code](https://www.linkedin.com/in/radu-simen/) by [Radu Simen](https://www.linkedin.com/in/radu-simen/) ([SAP](https://www.sap.com/)) +- 2017/09/28 - [Swagger Codegenで APIクライアントgem 自動生成 #m3kt](https://speakerdeck.com/juntaki/swagger-codegende-apikuraiantogem-zi-dong-sheng-cheng-number-m3kt) by [Jumpei Takiyasu](https://github.com/juntaki) +- 2017/09/30 - [Swaggerのテンプレートを魔改造した話 #渋谷java](https://www.slideshare.net/int128/swagger-80309224) by [Hidetake Iwata](https://github.com/int128) ([NTT DATA Corporation](http://www.nttdata.com/global/en/)) +- 2017/10/04 - [Enterprise-friendly Java client for Microsoft Machine Learning Server](https://blogs.msdn.microsoft.com/mlserver/2017/10/04/enterprise-friendly-java-client-for-microsoft-machine-learning-server/) by [Pratik Palnitkar](https://www.linkedin.com/in/pratikpalnitkar/) ([Microsoft](https://www.microsoft.com/)) +- 2017/10/08 - [Generating a REST Ada client with OpenAPI and Swagger Codegen](https://blog.vacs.fr/vacs/blogs/post.html?post=2017/10/08/Generating-a-REST-Ada-client-with-OpenAPI-and-Swagger-Codegen) by [Stephane Carrez](https://github.com/stcarrez) +- 2017/11/08 - [A Beginner's Guide to Code Generation for REST APIs](https://gum.co/swagger_codegen_beginner)(eBook) by [William Cheng](https://twitter.com/wing328) +- 2017/11/18 - [10年前のレガシーシステムをサーバーサイドKotlinでフルリニューアルしている話 #jjug_ccc #ccc_g2](https://speakerdeck.com/maeharin/10nian-qian-falseregasisisutemuwosabasaidokotlindehururiniyuarusiteiruhua-number-jjug-ccc-number-ccc-g2) by [Hidenori Maehara](https://github.com/maeharin) +- 2017/11/21 - [swagger-codegen から眺める Swift4](https://speakerdeck.com/d_date/swagger-codegen-karatiao-meru-swift4) by [Daiki Matsudate](https://github.com/d-date) +- 2017/12/07 - [API-driven development with OpenAPI and Swagger, Part 2](https://www.itworld.com/article/3199190/apis/api-driven-development-with-openapi-and-swagger-part-2.html) by Matthew Tyson +- 2017/12/29 - [REST APIs代码生成指南](https://gumroad.com/l/swagger_codegen_beginner_zh)(eBook) by [William Cheng](https://github.com/wing328), [Xin Meng](https://github.com/xmeng1) +- 2017/12/21 - [Using Protocol Buffer to Generate SDK at Hootsuite](http://code.hootsuite.com/using-protocol-buffer-to-generate-sdk-at-hoosuite/?lipi=urn%3Ali%3Apage%3Ad_flagship3_messaging%3By4ATz3SDRXyvXJJ14LQysQ%3D%3D) by [Joy Zhang](https://www.linkedin.com/in/joy8zhang/) +- 2018/01/11 - [Swagger 工具箱介绍及代码自动生成示例](https://github.com/qct/swagger-example) by [qct](https://github.com/qct) +- 2018/01/19 - [Generowanie kodu usług REST - przewodnik dla początkujących](https://gum.co/swagger_codegen_beginner_pl)(eBook) by [William Cheng](https://github.com/wing328), [Tomasz Prus](https://github.com/tomplus), [Bartek Kryza](https://github.com/bkryza) +- 2018/02/03 - [Writing REST APIs with OpenAPI and Swagger Ada](https://www.slideshare.net/StephaneCarrez1/writing-rest-apis-with-openapi-and-swagger-ada/StephaneCarrez1/writing-rest-apis-with-openapi-and-swagger-ada) by [Stephane Carrez](https://github.com/stcarrez) at [FOSDEM 2018](https://fosdem.org/2018) +- 2018/02/28 - [OpenAPI–An eBay Perspective](https://www.ebayinc.com/stories/blogs/tech/openapi-an-ebay-perspective/) by Shekhar Banerjee (eBay) +- 2018/03/16 - [REST APIのためのコード生成入門](https://gumroad.com/l/swagger_codegen_beginner_jp) by [William Cheng](https://github.com/wing328), [中野暁人](https://github.com/ackintosh), [和田拓朗](https://github.com/taxpon) \ No newline at end of file diff --git a/docs/template-creators.md b/docs/template-creators.md new file mode 100644 index 00000000000..24b30147716 --- /dev/null +++ b/docs/template-creators.md @@ -0,0 +1,93 @@ +# Template Creators + +Here is a list of template creators: + +**API Clients:** + +- Ada: @stcarrez +- Akka-Scala: @cchafer +- Apex: @asnelling +- Bash: @bkryza +- C++ REST: @Danielku15 +- C# (.NET 2.0): @who +- C# (.NET Standard 1.3 ): @Gronsak +- C# (.NET 4.5 refactored): @jimschubert +- Clojure: @xhh +- Dart: @yissachar +- Dart (refactored in 2.4.0): @joernahrens +- Elixir: @niku +- Elm: @trenneman +- Eiffel: @jvelilla +- Erlang: @tsloughter +- 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 (RESTEasy): @gayathrigs +- Java (Vertx): @lopesmcc +- Java (Google APIs Client Library): @charlescapps +- Java (Rest-assured): @viclovsky +- Javascript/NodeJS: @jfiala +- Javascript (Closure-annotated Angular) @achew22 +- JMeter: @davidkiss +- Kotlin: @jimschubert +- Lua: @daurnimator +- Perl: @wing328 +- PHP (Guzzle): @baartosz +- PowerShell: @beatcracker +- R: @ramnov +- Rust: @farcaller +- Rust (rust-server): @metaswitch +- Scala (scalaz & http4s): @tbrown1979 +- Swift: @tkqubo +- Swift 3: @hexelon +- Swift 4: @ehyche +- TypeScript (Node): @mhardorf +- TypeScript (Angular1): @mhardorf +- TypeScript (Fetch): @leonyu +- TypeScript (Angular2): @roni-frantchi +- TypeScript (jQuery): @bherila + +**Server Stubs:** + +- Ada: @stcarrez +- C# ASP.NET5: @jimschubert +- C# NancyFX: @mstefaniuk +- C++ Pistache: @sebymiano +- C++ Restbed: @stkrwork +- Erlang Server: @galaxie +- Go Server: @guohuang +- 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 +- JAX-RS RestEasy: @chameleon82 +- JAX-RS CXF: @hiveship +- JAX-RS CXF (CDI): @nickcmaynard +- JAX-RS RestEasy (JBoss EAP): @jfiala +- Kotlin: @jimschubert +- PHP Lumen: @abcsun +- PHP Slim: @jfastnacht +- PHP Symfony: @ksm2 +- PHP Zend Expressive (with Path Handler): @Articus +- Ruby on Rails 5: @zlx +- Rust (rust-server): @metaswitch +- Scala Finch: @jimschubert +- Scala Lagom: @gmkumar2005 + +**Documentation:** + +- HTML Doc 2: @jhitchcock +- Confluence Wiki: @jhitchcock + +**Configuration:** + +- Apache2: @stkrwork diff --git a/docs/versioning.md b/docs/versioning.md new file mode 100644 index 00000000000..c579378137b --- /dev/null +++ b/docs/versioning.md @@ -0,0 +1,51 @@ +## Versioning + +Both 2.X and 3.X version lines of Swagger Codegen are available and are independently maintained. + +**NOTE:** version 2.X (`io.swagger`) and 3.X (`io.swagger.codegen.v3`) have **different** group ids. + +### Swagger Codegen 2.X + +||| +|----|-----| +|Version:| 2.X| +|Repository branch:|[master](https://github.com/swagger-api/swagger-codegen/tree/master)| +|groupId:| `io.swagger`| +|Swagger/OpenAPI support:| 2.0| +|maven central (maven plugin):|[swagger-codegen-maven-plugin](https://mvnrepository.com/artifact/io.swagger/swagger-codegen-maven-plugin)| + +dependency example: + +```xml + + io.swagger + swagger-codegen-maven-plugin + 2.4.43 + +``` + +### Swagger Codegen 3.X ([`3.0.0` branch](https://github.com/swagger-api/swagger-codegen/tree/3.0.0)) + +||| +|----|-----| +|Version:| 3.X| +|Repository branch:|[3.0.0](https://github.com/swagger-api/swagger-codegen/tree/3.0.0)| +|groupId:| `io.swagger.codegen.v3`| +|Swagger/OpenAPI support:| 2.0 (_by using engine + generators of 2.X_), 3.0.X| +|maven central:|[io.swagger.codegen.v3](https://mvnrepository.com/artifact/io.swagger.codegen.v3) + +dependency example: + +```xml + + io.swagger.codegen.v3 + swagger-codegen-maven-plugin + 3.0.61 + +``` + + +(for main ReadMe) +[Online generator of version 3.X](https://github.com/swagger-api/swagger-codegen/tree/3.0.0#online-generators) supports both generation from Swagger/OpenAPI version 2 (by using engine + generators of 2.X) and version 3 specifications. + + diff --git a/docs/workflow-integration.md b/docs/workflow-integration.md new file mode 100644 index 00000000000..0c001136ba3 --- /dev/null +++ b/docs/workflow-integration.md @@ -0,0 +1,33 @@ +# Worklfow Integrations + +## Maven Integration + +You can use the [swagger-codegen-maven-plugin](modules/swagger-codegen-maven-plugin/README.md) for integrating with your workflow, and generating any codegen target. + +## Gradle Integration + +[Gradle Swagger Generator Plugin](https://github.com/int128/gradle-swagger-generator-plugin) is available for generating source code and API document. + +## GitHub Integration + +To push the auto-generated SDK to GitHub, we provide `git_push.sh` to streamline the process. For example: + + 1) Create a new repository in GitHub (Ref: https://help.github.com/articles/creating-a-new-repository/) + + 2) Generate the SDK + +```sh + java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \ + -i modules/swagger-codegen/src/test/resources/2_0/petstore.json -l perl \ + --git-user-id "swaggerapi" \ + --git-repo-id "petstore-perl" \ + --release-note "Github integration demo" \ + -o /var/tmp/perl/petstore +``` + + 3) Push the SDK to GitHub + +```sh +cd /var/tmp/perl/petstore +/bin/sh ./git_push.sh +```