You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
: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:
17
20
@@ -23,6 +26,55 @@
23
26
24
27
: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.
25
28
29
+
## Versioning
30
+
31
+
**NOTE:** version 2.X (`io.swagger`) and 3.X (`io.swagger.codegen.v3`) have **different** group ids.
32
+
33
+
2.X and 3.X version lines of Swagger Codegen are available; 2.X (`master` branch) supports Swagger/OpenAPI version 2,
34
+
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).
35
+
[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.
36
+
37
+
38
+
**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 supports OpenAPI version 3 (and version 2 via spec conversion to version 3)
61
+
[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 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:
28
80
@@ -81,15 +133,25 @@ The OpenAPI Specification has undergone 3 revisions since initial creation in 20
81
133
82
134
Swagger Codegen Version | Release Date | OpenAPI Spec compatibility | Notes
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.1/swagger-codegen-cli-2.3.1.jar`
176
+
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.4.8/swagger-codegen-cli-2.4.8.jar`
(if you're on Windows, replace the last command with `java -jar modules\swagger-codegen-cli\target\swagger-codegen-cli.jar generate -i http://petstore.swagger.io/v2/swagger.json -l php -o c:\temp\php_api_client`)
258
320
259
-
You can also download the JAR (latest release) directly from [maven.org](http://central.maven.org/maven2/io/swagger/swagger-codegen-cli/2.3.1/swagger-codegen-cli-2.3.1.jar)
321
+
You can also download the JAR (latest release) directly from [maven.org](http://central.maven.org/maven2/io/swagger/swagger-codegen-cli/2.4.8/swagger-codegen-cli-2.4.8.jar)
260
322
261
323
To get a list of **general** options available, please run `java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar help generate`
262
324
@@ -840,6 +902,7 @@ Here are some companies/projects using Swagger Codegen in production. To add you
@@ -1115,6 +1178,9 @@ Who is eligible? Those who want to join must have at least 3 PRs merged into a g
1115
1178
| Swift |@ehyche (2017/08) |
1116
1179
| TypeScript ||
1117
1180
1181
+
# Security contact
1182
+
1183
+
Please disclose any security-related issues or vulnerabilities by emailing [[email protected]](mailto:[email protected]), instead of using the public issue tracker.
1118
1184
1119
1185
# License information on Generated Code
1120
1186
@@ -1125,10 +1191,10 @@ The Swagger Codegen project is intended as a benefit for users of the Swagger /
1125
1191
1126
1192
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.
1127
1193
1128
-
License
1129
-
-------
1194
+
# License
1130
1195
1131
-
Copyright 2018 SmartBear Software
1196
+
```
1197
+
Copyright 2019 SmartBear Software
1132
1198
1133
1199
Licensed under the Apache License, Version 2.0 (the "License");
1134
1200
you may not use this file except in compliance with the License.
@@ -1139,3 +1205,4 @@ distributed under the License is distributed on an "AS IS" BASIS,
1139
1205
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1140
1206
See the License for the specific language governing permissions and
0 commit comments