|
1 | 1 | # Swagger Code Generator V3
|
2 | 2 |
|
3 | 3 | ## Overview
|
4 |
| -This is the swagger codegen project, which allows generation of API client libraries (SDK generation), server stubs and documentation automatically given an [OpenAPI Definition](https://github.com/OAI/OpenAPI-Specification). Currently, the following languages/frameworks are supported: |
| 4 | +This is the Swagger Codegen project, which allows generation of API client libraries (SDK generation), server stubs and documentation automatically given an [OpenAPI Definition](https://github.com/OAI/OpenAPI-Specification). Currently, the following languages/frameworks are supported: |
5 | 5 |
|
6 | 6 | - **API clients**: **Java** (Jersey1.x, Jersey2.x, OkHttp, Retrofit1.x, Retrofit2.x, Feign, RestTemplate, RESTEasy, Vertx, Google API Client Library for Java)
|
7 | 7 | - **Server stubs**: **Java** (Inflector)
|
@@ -50,7 +50,7 @@ Check out [OpenAPI Specification](https://github.com/OAI/OpenAPI-Specification)
|
50 | 50 |
|
51 | 51 |
|
52 | 52 | ## Compatibility
|
53 |
| -The OpenAPI Specification has undergone 3 revisions since initial creation in 2010.. The swagger-codegen project has the following compatibilities with the OpenAPI Specification: |
| 53 | +The OpenAPI Specification has undergone 3 revisions since initial creation in 2010.. The Swagger Codegen project has the following compatibilities with the OpenAPI Specification: |
54 | 54 |
|
55 | 55 | Swagger Codegen Version | Release Date | OpenAPI Spec compatibility | Notes
|
56 | 56 | -------------------------- | ------------ | -------------------------- | -----
|
@@ -345,12 +345,12 @@ Other languages have petstore samples, too:
|
345 | 345 | It's just as easy--just use the `-i` flag to point to either a server or file.
|
346 | 346 |
|
347 | 347 | ### Modifying the client library format
|
348 |
| -Don't like the default swagger client syntax? Want a different language supported? No problem! Swagger codegen processes mustache templates with the [jmustache](https://github.com/samskivert/jmustache) engine. You can modify our templates or make your own. |
| 348 | +Don't like the default swagger client syntax? Want a different language supported? No problem! Swagger Codegen processes mustache templates with the [jmustache](https://github.com/samskivert/jmustache) engine. You can modify our templates or make your own. |
349 | 349 |
|
350 | 350 | You can look at `modules/swagger-codegen/src/main/resources/${your-language}` for examples. To make your own templates, create your own files and use the `-t` flag to specify your template folder. It actually is that easy.
|
351 | 351 |
|
352 | 352 | ### Making your own codegen modules
|
353 |
| -If you're starting a project with a new language and don't see what you need, swagger-codegen can help you create a project to generate your own libraries: |
| 353 | +If you're starting a project with a new language and don't see what you need, Swagger Codegen can help you create a project to generate your own libraries: |
354 | 354 |
|
355 | 355 | ```sh
|
356 | 356 | java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar meta \
|
@@ -440,7 +440,7 @@ When using selective generation, _only_ the templates needed for the specific ge
|
440 | 440 |
|
441 | 441 | ### Ignore file format
|
442 | 442 |
|
443 |
| -Swagger codegen supports a `.swagger-codegen-ignore` file, similar to `.gitignore` or `.dockerignore` you're probably already familiar with. |
| 443 | +Swagger Codegen supports a `.swagger-codegen-ignore` file, similar to `.gitignore` or `.dockerignore` you're probably already familiar with. |
444 | 444 |
|
445 | 445 | The ignore file allows for better control over overwriting existing files than the `--skip-overwrite` flag. With the ignore file, you can specify individual files or directories can be ignored. This can be useful, for example if you only want a subset of the generated code.
|
446 | 446 |
|
@@ -621,7 +621,7 @@ Please refer to https://github.com/swagger-api/swagger-codegen/wiki/Server-stub-
|
621 | 621 |
|
622 | 622 | ### To build the codegen library
|
623 | 623 |
|
624 |
| -This will create the swagger-codegen library from source. |
| 624 | +This will create the Swagger Codegen library from source. |
625 | 625 |
|
626 | 626 | ```sh
|
627 | 627 | mvn package
|
|
0 commit comments