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
-[6.3 - History of OpenAPI Generator](#history-of-openapi-generator)
77
+
-[7 - License](#license)
78
+
79
+
## 1 - Installation
80
+
81
+
### 1.1 - Compatibility
82
82
83
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:
84
84
@@ -89,7 +89,8 @@ OpenAPI Generator Version | Release Date | OpenAPI Spec compatibility | Notes
89
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
90
90
91
91
92
-
### Download JAR
92
+
### 1.2 - Download JAR
93
+
93
94
If you're looking for the latest stable version, you can grab it directly from Maven.org (Java 8 runtime at a minimum):
94
95
95
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
230
231
```sh
@@ -244,7 +245,7 @@ To get a list of **general** options available, please run `java -jar modules/op
244
245
245
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`
246
247
247
-
## Usage
248
+
## 3 - Usage
248
249
249
250
### To generate a sample client library
250
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:
@@ -323,19 +324,19 @@ Other languages have petstore samples, too:
323
324
./bin/java-petstore.sh
324
325
./bin/objc-petstore.sh
325
326
```
326
-
### Customization
327
+
### 3.1 - Customization
327
328
328
329
Please refer to [customization.md](docs/customization.md) on how to customize the output (e.g. package name, version)
Please refer to [integration.md](docs/integration.md) on how to integrate OpenAPI generator with Maven, Gradle, Github and CI/CD.
333
334
334
-
### Online OpenAPI generator
335
+
### 3.3 - Online OpenAPI generator
335
336
336
337
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`.
337
338
338
-
### License information on Generated Code
339
+
### 3.4 - License information on Generated Code
339
340
340
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:
341
342
@@ -344,17 +345,17 @@ The OpenAPI Generator project is intended as a benefit for users of the Open API
344
345
345
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.
346
347
347
-
# Companies/Projects using OpenAPI Generator
348
+
# 4 - Companies/Projects using OpenAPI Generator
348
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.
349
350
350
351
-[REST United](https://restunited.com)
351
352
352
-
# Presentations/Videos/Tutorials/Books
353
+
# 5 - Presentations/Videos/Tutorials/Books
353
354
354
355
355
-
# About Us
356
+
# 6 - About Us
356
357
357
-
## OpenAPI Generator Core Team
358
+
## 6.1 - OpenAPI Generator Core Team
358
359
359
360
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.
360
361
@@ -465,7 +466,7 @@ Here are the requirements to become a core team member:
465
466
466
467
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.
467
468
468
-
## OpenAPI Generator Technical Committee
469
+
## 6.2 - OpenAPI Generator Technical Committee
469
470
470
471
Members of the OpenAPI Generator technical committee shoulder the following responsibilities:
471
472
@@ -513,7 +514,7 @@ If you want to join the committee, please kindly apply by sending an email to wi
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.
0 commit comments