Skip to content

Commit efa27ce

Browse files
committed
Add link
1 parent 94dfb6b commit efa27ce

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

README.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -76,9 +76,9 @@ OpenAPI Generator allows generation of API client libraries (SDK generation), se
7676
- [6.3 - History of OpenAPI Generator](#63---history-of-openapi-generator)
7777
- [7 - License](#7---license)
7878

79-
## 1 - Installation
79+
## [1 - Installation](#table-of-contents)
8080

81-
### 1.1 - Compatibility
81+
### [1.1 - Compatibility](#table-of-contents)
8282

8383
The OpenAPI Specification has undergone 3 revisions since initial creation in 2010. The openapi-generator project has the following compatibilities with the OpenAPI Specification:
8484

@@ -89,7 +89,7 @@ OpenAPI Generator Version | Release Date | OpenAPI Spec compatibility | Notes
8989
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
9090

9191

92-
### 1.2 - Download JAR
92+
### [1.2 - Download JAR](#table-of-contents)
9393

9494
If you're looking for the latest stable version, you can grab it directly from Maven.org (Java 8 runtime at a minimum):
9595

@@ -113,7 +113,7 @@ export JAVA_HOME=`/usr/libexec/java_home -v 1.8`
113113
export PATH=${JAVA_HOME}/bin:$PATH
114114
```
115115

116-
### 1.3 - Build Projects
116+
### [1.3 - Build Projects](#table-of-contents)
117117

118118
To build from source, you need the following installed and available in your `$PATH:`
119119

@@ -131,7 +131,7 @@ If you don't have maven installed, you may directly use the included [maven wrap
131131
./mvnw clean install
132132
```
133133

134-
### 1.4 - Homebrew
134+
### [1.4 - Homebrew](#table-of-contents)
135135

136136
To install, run `brew install openapi-generator`
137137

@@ -140,7 +140,7 @@ Here is an example usage to generate a Ruby client:
140140
openapi-generator generate -i https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/2_0/petstore.yaml -l ruby -o /tmp/test/
141141
```
142142

143-
### 1.5 - Docker
143+
### [1.5 - Docker](#table-of-contents)
144144

145145
#### Public Pre-built Docker images
146146

@@ -225,7 +225,7 @@ cd /vagrant
225225
./run-in-docker.sh mvn package
226226
```
227227

228-
## 2 - Getting Started
228+
## [2 - Getting Started](#table-of-contents)
229229

230230
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
231231
```sh
@@ -245,7 +245,7 @@ To get a list of **general** options available, please run `java -jar modules/op
245245

246246
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`
247247

248-
## 3 - Usage
248+
## [3 - Usage](#table-of-contents)
249249

250250
### To generate a sample client library
251251
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:
324324
./bin/java-petstore.sh
325325
./bin/objc-petstore.sh
326326
```
327-
### 3.1 - Customization
327+
### [3.1 - Customization](#table-of-contents)
328328

329329
Please refer to [customization.md](docs/customization.md) on how to customize the output (e.g. package name, version)
330330

331-
### 3.2 - Workflow Integration (Maven, Gradle, Github, CI/CD)
331+
### [3.2 - Workflow Integration (Maven, Gradle, Github, CI/CD)](#table-of-contents)
332332

333333
Please refer to [integration.md](docs/integration.md) on how to integrate OpenAPI generator with Maven, Gradle, Github and CI/CD.
334334

335-
### 3.3 - Online OpenAPI generator
335+
### [3.3 - Online OpenAPI generator](#table-of-contents)
336336

337337
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`.
338338

339-
### 3.4 - License information on Generated Code
339+
### [3.4 - License information on Generated Code](#table-of-contents)
340340

341341
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:
342342

@@ -345,17 +345,17 @@ The OpenAPI Generator project is intended as a benefit for users of the Open API
345345

346346
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.
347347

348-
## 4 - Companies/Projects using OpenAPI Generator
348+
## [4 - Companies/Projects using OpenAPI Generator](#table-of-contents)
349349
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.
350350

351351
- [REST United](https://restunited.com)
352352

353-
## 5 - Presentations/Videos/Tutorials/Books
353+
## [5 - Presentations/Videos/Tutorials/Books](#table-of-contents)
354354

355355

356-
## 6 - About Us
356+
## [6 - About Us](#table-of-contents)
357357

358-
### 6.1 - OpenAPI Generator Core Team
358+
### [6.1 - OpenAPI Generator Core Team](#table-of-contents)
359359

360360
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.
361361

@@ -466,7 +466,7 @@ Here are the requirements to become a core team member:
466466

467467
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.
468468

469-
### 6.2 - OpenAPI Generator Technical Committee
469+
### [6.2 - OpenAPI Generator Technical Committee](#table-of-contents)
470470

471471
Members of the OpenAPI Generator technical committee shoulder the following responsibilities:
472472

@@ -514,7 +514,7 @@ If you want to join the committee, please kindly apply by sending an email to wi
514514
| Swift | @jgavris (2017/07) @ehyche (2017/08) @Edubits (2017/09) @jaz-ah (2017/09) @d-date (2018/03) |
515515
| TypeScript | @TiFu (2017/07) @taxpon (2017/07) @sebastianhaas (2017/07) @kenisteward (2017/07) @Vrolijkx (2017/09) @macjohnny (2018/01) |
516516

517-
### 6.3 - History of OpenAPI Generator
517+
### [6.3 - History of OpenAPI Generator](#table-of-contents)
518518

519519
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.
520520

@@ -566,7 +566,7 @@ OpenAPI Generator is a fork of [Swagger Codegen](https://github.com/swagger-api/
566566

567567

568568

569-
## 7 - License
569+
## [7 - License](#table-of-contents)
570570
-------
571571

572572
Copyright 2018 OpenAPI-Generator Contributors (https://openapi-generator.tech)

0 commit comments

Comments
 (0)