|
22 | 22 | :rocket: ProductHunt: https://producthunt.com/posts/swagger-codegen :rocket:
|
23 | 23 |
|
24 | 24 | ## Overview
|
25 |
| -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: |
| 25 | +This is the swagger codegen project, which allows generation of API client libraries (SDK generation), server stubs and documentation automatically given an [OpenAPI Spec v2 and v3](https://github.com/OAI/OpenAPI-Specification). Currently, the following languages/frameworks are supported: |
26 | 26 |
|
27 |
| -- **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), **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), **Typescript** (Angular1.x, Angular2.x, Fetch, jQuery, Node) |
28 |
| -- **Server stubs**: **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)), **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) |
| 27 | +- **API clients**: **Java** (Jersey1.x, Jersey2.x, OkHttp, Retrofit1.x, Retrofit2.x, Feign, RestTemplate, RESTEasy, Vertx, Google API Client Library for Java) |
| 28 | +- **Server stubs**: **Java** (Inflector) |
29 | 29 | - **API documentation generators**: **HTML**, **Confluence Wiki**
|
30 | 30 | - **Configuration files**: [**Apache2**](https://httpd.apache.org/)
|
31 | 31 | - **Others**: **JMeter**
|
@@ -91,15 +91,15 @@ Swagger Codegen Version | Release Date | OpenAPI Spec compatibility | Notes
|
91 | 91 |
|
92 | 92 |
|
93 | 93 | ### Prerequisites
|
94 |
| -If you're looking for the latest stable version, you can grab it directly from Maven.org (Java 7 runtime at a minimum): |
| 94 | +Right now there is a release candidate (rc0) version, which you can grab it directly from Maven.org (Java 8 runtime at a minimum): |
95 | 95 |
|
96 | 96 | ```sh
|
97 |
| -wget http://central.maven.org/maven2/io/swagger/swagger-codegen-cli/2.3.0/swagger-codegen-cli-2.3.0.jar -O swagger-codegen-cli.jar |
| 97 | +wget http://central.maven.org/maven2/io/swagger/swagger-codegen-cli/3.0.0-rc0/swagger-codegen-cli-3.0.0-rc0.jar -O swagger-codegen-cli.jar |
98 | 98 |
|
99 | 99 | java -jar swagger-codegen-cli.jar help
|
100 | 100 | ```
|
101 | 101 |
|
102 |
| -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 http://central.maven.org/maven2/io/swagger/swagger-codegen-cli/2.3.0/swagger-codegen-cli-2.3.0.jar` |
| 102 | +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 http://central.maven.org/maven2/io/swagger/swagger-codegen-cli/3.0.0-rc0/swagger-codegen-cli-3.0.0-rc0.jar` |
103 | 103 |
|
104 | 104 | On a mac, it's even easier with `brew`:
|
105 | 105 | ```sh
|
@@ -733,7 +733,9 @@ Instead of using `swaggerUrl` with an URL to the OpenAPI/Swagger spec, one can i
|
733 | 733 | Guidelines for Contribution
|
734 | 734 | ---------------------------
|
735 | 735 |
|
736 |
| -Please refer to this [page](https://github.com/swagger-api/swagger-codegen/blob/master/CONTRIBUTING.md) |
| 736 | +Please refer to this [page.](https://github.com/swagger-api/swagger-codegen/blob/master/CONTRIBUTING.md) |
| 737 | +Also for `swagger-codegen version 3` templates and classes for code generation are being migrated to[swagger-codegen-generators](https://github.com/swagger-api/swagger-codegen-generators) |
| 738 | +repo. In order to know this migration process you can refer this [page.](https://github.com/swagger-api/swagger-codegen/wiki/Swagger-Codegen-migration-(swagger-codegen-generators-repository)) |
737 | 739 |
|
738 | 740 | Companies/Projects using Swagger Codegen
|
739 | 741 | ----------------------------------------
|
|
0 commit comments