Skip to content

Commit 935790e

Browse files
committed
Numbering
1 parent 8b67250 commit 935790e

File tree

1 file changed

+40
-39
lines changed

1 file changed

+40
-39
lines changed

README.md

Lines changed: 40 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -56,29 +56,29 @@ OpenAPI Generator allows generation of API client libraries (SDK generation), se
5656
- [OpenAPI Generator](#openapi-generator)
5757
- [Overview](#overview)
5858
- [Table of Contents](#table-of-contents)
59-
- [Installation](#installation)
60-
- [Compatibility](#compatibility)
61-
- [Download JAR](#download-jar)
62-
- [Build Projects](#building-projects)
63-
- [Homebrew](#homebrew)
64-
- [Docker](#docker)
65-
- [Getting Started](#getting-started)
66-
- [Usage](#usage)
67-
- [Customization](#customization)
68-
- [Workflow Integration](#workflow-integration)
69-
- [Online Generators](#online-generators)
70-
- [License Information on Generated Code](#license-information-on-generated-code)
71-
- [Companies/Projects using OpenAPI Generator](#companiesprojects-using-openapi-generator)
72-
- [Presentations/Videos/Tutorials/Books](#presentationsvideostutorialsbooks)
73-
- [About Us](#about-us)
74-
- [OpenAPI Generator Core Team](#openapi-generator-core-team)
75-
- [OpenAPI Generator Technical Committee](#openapi-generator-technical-committee)
76-
- [History of OpenAPI Generator](#history-of-openapi-generator)
77-
- [License](#license)
78-
79-
## Installation
80-
81-
### Compatibility
59+
- [1 - Installation](#installation)
60+
- [1.1 - Compatibility](#compatibility)
61+
- [1.2 - Download JAR](#download-jar)
62+
- [1.3 - Build Projects](#building-projects)
63+
- [1.4 - Homebrew](#homebrew)
64+
- [1.5 - Docker](#docker)
65+
- [2 - Getting Started](#getting-started)
66+
- [3 - Usage](#usage)
67+
- [3.1 - Customization](#customization)
68+
- [3.2 - Workflow Integration](#workflow-integration)
69+
- [3.3 - Online Generators](#online-generators)
70+
- [3.4 - License Information on Generated Code](#license-information-on-generated-code)
71+
- [4 - Companies/Projects using OpenAPI Generator](#companiesprojects-using-openapi-generator)
72+
- [5 - Presentations/Videos/Tutorials/Books](#presentationsvideostutorialsbooks)
73+
- [6 - About Us](#about-us)
74+
- [6.1 - OpenAPI Generator Core Team](#openapi-generator-core-team)
75+
- [6.2 - OpenAPI Generator Technical Committee](#openapi-generator-technical-committee)
76+
- [6.3 - History of OpenAPI Generator](#history-of-openapi-generator)
77+
- [7 - License](#license)
78+
79+
## 1 - Installation
80+
81+
### 1.1 - Compatibility
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,8 @@ 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-
### Download JAR
92+
### 1.2 - Download JAR
93+
9394
If you're looking for the latest stable version, you can grab it directly from Maven.org (Java 8 runtime at a minimum):
9495

9596
JAR location: `http://central.maven.org/maven2/org/openapitools/openapi-generator-cli/3.0.0/openapi-generator-cli-3.0.0.jar`
@@ -112,7 +113,7 @@ export JAVA_HOME=`/usr/libexec/java_home -v 1.8`
112113
export PATH=${JAVA_HOME}/bin:$PATH
113114
```
114115

115-
### Build Projects
116+
### 1.3 - Build Projects
116117

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

@@ -130,7 +131,7 @@ If you don't have maven installed, you may directly use the included [maven wrap
130131
./mvnw clean install
131132
```
132133

133-
### Homebrew
134+
### 1.4 - Homebrew
134135

135136
To install, run `brew install openapi-generator`
136137

@@ -139,7 +140,7 @@ Here is an example usage to generate a Ruby client:
139140
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/
140141
```
141142

142-
### Docker
143+
### 1.5 - Docker
143144

144145
#### Public Pre-built Docker images
145146

@@ -224,7 +225,7 @@ cd /vagrant
224225
./run-in-docker.sh mvn package
225226
```
226227

227-
## Getting Started
228+
## 2 - Getting Started
228229

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

245246
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`
246247

247-
## Usage
248+
## 3 - Usage
248249

249250
### To generate a sample client library
250251
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:
323324
./bin/java-petstore.sh
324325
./bin/objc-petstore.sh
325326
```
326-
### Customization
327+
### 3.1 - Customization
327328

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

330-
### Workflow Integration (Maven, Gradle, Github, CI/CD)
331+
### 3.2 - Workflow Integration (Maven, Gradle, Github, CI/CD)
331332

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

334-
### Online OpenAPI generator
335+
### 3.3 - Online OpenAPI generator
335336

336337
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`.
337338

338-
### License information on Generated Code
339+
### 3.4 - License information on Generated Code
339340

340341
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:
341342

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

345346
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.
346347

347-
# Companies/Projects using OpenAPI Generator
348+
# 4 - Companies/Projects using OpenAPI Generator
348349
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.
349350

350351
- [REST United](https://restunited.com)
351352

352-
# Presentations/Videos/Tutorials/Books
353+
# 5 - Presentations/Videos/Tutorials/Books
353354

354355

355-
# About Us
356+
# 6 - About Us
356357

357-
## OpenAPI Generator Core Team
358+
## 6.1 - OpenAPI Generator Core Team
358359

359360
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.
360361

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

466467
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.
467468

468-
## OpenAPI Generator Technical Committee
469+
## 6.2 - OpenAPI Generator Technical Committee
469470

470471
Members of the OpenAPI Generator technical committee shoulder the following responsibilities:
471472

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

516-
## History of OpenAPI Generator
517+
## 6.3 - History of OpenAPI Generator
517518

518519
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.
519520

0 commit comments

Comments
 (0)