Skip to content

Commit bf3284c

Browse files
committed
Swagger Codegen Rebranding in 3.0.0
1 parent e479bec commit bf3284c

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Swagger Code Generator V3
22

33
## 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:
55

66
- **API clients**: **Java** (Jersey1.x, Jersey2.x, OkHttp, Retrofit1.x, Retrofit2.x, Feign, RestTemplate, RESTEasy, Vertx, Google API Client Library for Java)
77
- **Server stubs**: **Java** (Inflector)
@@ -50,7 +50,7 @@ Check out [OpenAPI Specification](https://github.com/OAI/OpenAPI-Specification)
5050

5151

5252
## 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:
5454

5555
Swagger Codegen Version | Release Date | OpenAPI Spec compatibility | Notes
5656
-------------------------- | ------------ | -------------------------- | -----
@@ -345,12 +345,12 @@ Other languages have petstore samples, too:
345345
It's just as easy--just use the `-i` flag to point to either a server or file.
346346

347347
### 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.
349349

350350
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.
351351

352352
### 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:
354354

355355
```sh
356356
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
440440

441441
### Ignore file format
442442

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.
444444

445445
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.
446446

@@ -621,7 +621,7 @@ Please refer to https://github.com/swagger-api/swagger-codegen/wiki/Server-stub-
621621

622622
### To build the codegen library
623623

624-
This will create the swagger-codegen library from source.
624+
This will create the Swagger Codegen library from source.
625625

626626
```sh
627627
mvn package

0 commit comments

Comments
 (0)