Skip to content

Commit acaf1b1

Browse files
committed
added Table of Contents
Initial version of table of contents - showing all headers in the current shape.
1 parent 2711e37 commit acaf1b1

File tree

1 file changed

+35
-4
lines changed

1 file changed

+35
-4
lines changed

README.md

Lines changed: 35 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,36 @@ This is the swagger codegen project, which allows generation of client libraries
77

88
Check out [Swagger-Spec](https://github.com/swagger-api/swagger-spec) for additional information about the Swagger project, including additional libraries with support for other languages and more.
99

10+
# Table of contents
11+
12+
- [Swagger Code Generator](#swagger-code-generator)
13+
- [Overview](#overview)
14+
- [Table of Contents](#table-of-contents)
15+
- [Build and run using docker](#build-and-run-using-docker)
16+
- [Build a nodejs server stub](#build-a-nodejs-server-stub)
17+
- [Compatibility](#compatibility)
18+
- [Prerequisites](#prerequisites)
19+
- [OS X Users](#os-x-users)
20+
- [Building](#building)
21+
- [To generate a sample client library](#to-generate-a-sample-client-library)
22+
- [Generating libraries from your server](#generating-libraries-from-your-server)
23+
- [Modifying the client library format](#modifying-the-client-library-format)
24+
- [Making your own codegen modules](#making-your-own-codegen-modules)
25+
- [Where is Javascript???](#where-is-javascript)
26+
- [Generating a client from local files](#generating-a-client-from-local-files)
27+
- [Customizing the generator](#customizing-the-generator)
28+
- [Validating your swagger spec](#validating-your-swagger-spec)
29+
- [Generating dynamic html api documentation](#generating-dynamic-html-api-documentation)
30+
- [Generating static html api documentation](#generating-static-html-api-documentation)
31+
- [To build a server stub](#to-build-a-server-stub)
32+
- [node.js](#nodejs)
33+
- [rails-grape](#rails-grape)
34+
- [scala scalatra](#scala-scalatra)
35+
- [java jax-rs](#java-jax-rs)
36+
- [java spring-mvc](#java-spring-mvc)
37+
- [To build the codegen library](#to-build-the-codegen-library)
38+
- [License](#license)
39+
1040
## Build and run using docker
1141

1242
```
@@ -17,7 +47,7 @@ cd swagger-codegen
1747
./run-in-docker.sh mvn package
1848
```
1949

20-
Build a nodejs server stub:
50+
## Build a nodejs server stub
2151

2252
```
2353
./run-in-docker.sh generate \
@@ -31,7 +61,7 @@ The Swagger Specification has undergone 3 revisions since initial creation in 20
3161

3262
Swagger Codegen Version | Release Date | Swagger Spec compatibility | Notes
3363
-------------------------- | ------------ | -------------------------- | -----
34-
2.1.4-SNAPSHOT | | 1.0, 1.1, 1.2, 2.0 | [master](https://github.com/swagger-api/swagger-codegen)
64+
2.1.4-SNAPSHOT | | 1.0, 1.1, 1.2, 2.0 | [master](https://github.com/swagger-api/swagger-codegen)
3565
2.1.3 (**current stable**) | 2015-08-24 | 1.0, 1.1, 1.2, 2.0 | [tag v2.1.3](https://github.com/swagger-api/swagger-codegen/tree/v2.1.3)
3666
2.0.17 | 2014-08-22 | 1.1, 1.2 | [tag v2.0.17](https://github.com/swagger-api/swagger-codegen/tree/v2.0.17)
3767
1.0.4 | 2012-04-12 | 1.0, 1.1 | [tag v1.0.4](https://github.com/swagger-api/swagger-codegen/tree/swagger-codegen_2.9.1-1.1)
@@ -169,7 +199,7 @@ static code generation.
169199
There is a third-party component called [swagger-js-codegen](https://github.com/wcandillon/swagger-js-codegen) that can generate angularjs or nodejs source code from a swagger specification.
170200

171201

172-
#### Generating a client from flat files (i.e. no remote server calls)
202+
#### Generating a client from local files
173203
If you don't want to call your server, you can save the swagger spec files into a directory and pass an argument
174204
to the code generator like this:
175205

@@ -336,6 +366,7 @@ open index.html
336366
You can also use the codegen to generate a server for a couple different frameworks. Take a look here:
337367

338368
### node.js
369+
339370
```
340371
java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \
341372
-i http://petstore.swagger.io/v2/swagger.json \
@@ -344,8 +375,8 @@ java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \
344375
```
345376

346377
### rails-grape
347-
#### Not yet migrated to this branch
348378

379+
*Not yet migrated to this branch*
349380

350381
### scala scalatra
351382
```

0 commit comments

Comments
 (0)