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
{{ message }}
This repository was archived by the owner on Feb 9, 2021. It is now read-only.
:star::star::star: If you would like to contribute, please refer to [guidelines](CONTRIBUTING.md) and a list of [open tasks](https://github.com/openapitools/openapi-generator/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22).:star::star::star:
16
32
17
33
:bangbang: To migrate from Swagger Codegen to OpenAPI Generator, please refer to the [migration guide](docs/migration-from-swagger-codegen.md):bangbang:
18
34
19
35
:notebook_with_decorative_cover: For more information, please refer to the [Wiki page](https://github.com/openapitools/openapi-generator/wiki) and [FAQ](https://github.com/openapitools/openapi-generator/wiki/FAQ):notebook_with_decorative_cover:
20
36
37
+
: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 begineers :notebook_with_decorative_cover:
38
+
21
39
:warning: If the OpenAPI spec is obtained from an untrusted source, please make sure you've reviewed the spec before using OpenAPI Generator to generate the API client, server stub or documentation as [code injection](https://en.wikipedia.org/wiki/Code_injection) may occur :warning:
22
40
23
-
: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 begineers.
41
+
</div>
24
42
25
43
## Overview
26
44
OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an [OpenAPI Spec](https://github.com/OAI/OpenAPI-Specification). Currently, the following languages/frameworks are supported:
-[6.3 - History of OpenAPI Generator](#63---history-of-openapi-generator)
77
+
-[7 - License](#7---license)
78
+
79
+
## [1 - Installation](#table-of-contents)
80
+
81
+
### [1.1 - Compatibility](#table-of-contents)
63
82
64
83
The OpenAPI Specification has undergone 3 revisions since initial creation in 2010. The openapi-generator project has the following compatibilities with the OpenAPI Specification:
65
84
@@ -70,7 +89,8 @@ OpenAPI Generator Version | Release Date | OpenAPI Spec compatibility | Notes
70
89
3.0.0 (current master, upcoming release) [SNAPSHOT](https://oss.sonatype.org/content/repositories/snapshots/org/openapitools/openapi-generator-cli/3.0.0-SNAPSHOT/)| TBD | 1.0, 1.1, 1.2, 2.0, 3.0 | Minor release without breaking changes
71
90
72
91
73
-
### Download JAR
92
+
### [1.2 - Download JAR](#table-of-contents)
93
+
74
94
If you're looking for the latest stable version, you can grab it directly from Maven.org (Java 8 runtime at a minimum):
75
95
76
96
JAR location: `http://central.maven.org/maven2/org/openapitools/openapi-generator-cli/3.0.0/openapi-generator-cli-3.0.0.jar`
To generate a PHP client for [petstore.yaml](https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/2_0/petstore.yaml), please run the following
211
231
```sh
@@ -225,7 +245,7 @@ To get a list of **general** options available, please run `java -jar modules/op
225
245
226
246
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/openapi-generator-cli/target/openapi-generator-cli.jar config-help -l php`
227
247
228
-
## Usage
248
+
## [3 - Usage](#table-of-contents)
229
249
230
250
### To generate a sample client library
231
251
You can build a client against the [Petstore API](https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/2_0/petstore.yaml) as follows:
@@ -304,19 +324,19 @@ Other languages have petstore samples, too:
304
324
./bin/java-petstore.sh
305
325
./bin/objc-petstore.sh
306
326
```
307
-
### Customization
327
+
### [3.1 - Customization](#table-of-contents)
308
328
309
329
Please refer to [customization.md](docs/customization.md) on how to customize the output (e.g. package name, version)
Please refer to [online-openapi-generator.md](docs/online-openapi-generator.md) on how to run and use the `openapi-generator-online` - a web service for `openapi-generator`.
318
338
319
-
### License information on Generated Code
339
+
### [3.4 - License information on Generated Code](#table-of-contents)
320
340
321
341
The OpenAPI Generator project is intended as a benefit for users of the Open API Specification. The project itself has the [License](#license) as specified. In addition, please understand the following points:
322
342
@@ -325,21 +345,21 @@ The OpenAPI Generator project is intended as a benefit for users of the Open API
325
345
326
346
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.
327
347
328
-
#Companies/Projects using OpenAPI Generator
348
+
## [4 - Companies/Projects using OpenAPI Generator](#table-of-contents)
329
349
Here are some companies/projects using OpenAPI Generator in production. To add your company/project to the list, please visit [README.md](README.md) and click on the icon to edit the page.
OpenAPI Generator 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.
Members of the OpenAPI Generator technical committee shoulder the following responsibilities:
452
472
@@ -459,7 +479,7 @@ Who is eligible? Those who want to join must have at least 3 PRs merged into a g
459
479
460
480
If you want to join the committee, please kindly apply by sending an email to wing328hk@gmail.com ([@wing328](https://github.com/wing328)) with your Github ID.
461
481
462
-
### Members of Technical Committee
482
+
####Members of Technical Committee
463
483
464
484
| Languages | Member (join date) |
465
485
|:-------------|:-------------|
@@ -494,11 +514,11 @@ If you want to join the committee, please kindly apply by sending an email to wi
### [6.3 - History of OpenAPI Generator](#table-of-contents)
498
518
499
519
OpenAPI Generator is a fork of [Swagger Codegen](https://github.com/swagger-api/swagger-codegen). In view of the issues with the Swagger Codegen 3.0.0 (beta) release and the disagreement on the project's direction, more than 40 top contributors and template creators of Swagger Codegen decided to fork Swagger Codegen and maintain a community-driven version called "OpenAPI Generator". Please refer to the [Q&A](docs/qna.md) for more information.
500
520
501
-
### Founding Members (alphabetical order):
521
+
####Founding Members (alphabetical order):
502
522
503
523
-[Akihito Nakano](https://github.com/ackintosh)
504
524
-[Artem Ocheredko](https://github.com/galaxie)
@@ -546,7 +566,7 @@ OpenAPI Generator is a fork of [Swagger Codegen](https://github.com/swagger-api/
0 commit comments