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
Copy file name to clipboardExpand all lines: README.md
+19-19Lines changed: 19 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -76,9 +76,9 @@ OpenAPI Generator allows generation of API client libraries (SDK generation), se
76
76
-[6.3 - History of OpenAPI Generator](#63---history-of-openapi-generator)
77
77
-[7 - License](#7---license)
78
78
79
-
## 1 - Installation
79
+
## [1 - Installation](#table-of-contents)
80
80
81
-
### 1.1 - Compatibility
81
+
### [1.1 - Compatibility](#table-of-contents)
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,7 @@ 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
-
### 1.2 - Download JAR
92
+
### [1.2 - Download JAR](#table-of-contents)
93
93
94
94
If you're looking for the latest stable version, you can grab it directly from Maven.org (Java 8 runtime at a minimum):
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
231
231
```sh
@@ -245,7 +245,7 @@ To get a list of **general** options available, please run `java -jar modules/op
245
245
246
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`
247
247
248
-
## 3 - Usage
248
+
## [3 - Usage](#table-of-contents)
249
249
250
250
### To generate a sample client library
251
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:
@@ -324,19 +324,19 @@ Other languages have petstore samples, too:
324
324
./bin/java-petstore.sh
325
325
./bin/objc-petstore.sh
326
326
```
327
-
### 3.1 - Customization
327
+
### [3.1 - Customization](#table-of-contents)
328
328
329
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`.
338
338
339
-
### 3.4 - License information on Generated Code
339
+
### [3.4 - License information on Generated Code](#table-of-contents)
340
340
341
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:
342
342
@@ -345,17 +345,17 @@ The OpenAPI Generator project is intended as a benefit for users of the Open API
345
345
346
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.
347
347
348
-
## 4 - Companies/Projects using OpenAPI Generator
348
+
## [4 - Companies/Projects using OpenAPI Generator](#table-of-contents)
349
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.
361
361
@@ -466,7 +466,7 @@ Here are the requirements to become a core team member:
466
466
467
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.
### [6.3 - History of OpenAPI Generator](#table-of-contents)
518
518
519
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.
520
520
@@ -566,7 +566,7 @@ OpenAPI Generator is a fork of [Swagger Codegen](https://github.com/swagger-api/
0 commit comments