|
24 | 24 | :notebook_with_decorative_cover: The eBook [A Beginner's Guide to Code Generation for REST APIs](https://gumroad.com/l/swagger_codegen_beginner) is a good starting point for beginners.
|
25 | 25 |
|
26 | 26 | ## Overview
|
27 |
| -This is the swagger codegen project, which allows generation of API client libraries (SDK generation), server stubs and documentation automatically given an [OpenAPI Spec](https://github.com/OAI/OpenAPI-Specification). Currently, the following languages/frameworks are supported: |
| 27 | +This is the Swagger Codegen project, which allows generation of API client libraries (SDK generation), server stubs and documentation automatically given an [OpenAPI Spec](https://github.com/OAI/OpenAPI-Specification). Currently, the following languages/frameworks are supported: |
28 | 28 |
|
29 | 29 | - **API clients**: **ActionScript**, **Ada**, **Apex**, **Bash**, **C#** (.net 2.0, 3.5 or later), **C++** (cpprest, Qt5, Tizen), **Clojure**, **Dart**, **Elixir**, **Elm**, **Eiffel**, **Erlang**, **Go**, **Groovy**, **Haskell** (http-client, Servant), **Java** (Jersey1.x, Jersey2.x, OkHttp, Retrofit1.x, Retrofit2.x, Feign, RestTemplate, RESTEasy, Vertx, Google API Client Library for Java, Rest-assured), **Kotlin**, **Lua**, **Node.js** (ES5, ES6, AngularJS with Google Closure Compiler annotations) **Objective-C**, **Perl**, **PHP**, **PowerShell**, **Python**, **R**, **Ruby**, **Rust** (rust, rust-server), **Scala** (akka, http4s, swagger-async-httpclient), **Swift** (2.x, 3.x, 4.x), **Typescript** (Angular1.x, Angular2.x, Fetch, jQuery, Node)
|
30 | 30 | - **Server stubs**: **Ada**, **C#** (ASP.NET Core, NancyFx), **C++** (Pistache, Restbed), **Erlang**, **Go**, **Haskell** (Servant), **Java** (MSF4J, Spring, Undertow, JAX-RS: CDI, CXF, Inflector, RestEasy, Play Framework, [PKMST](https://github.com/ProKarma-Inc/pkmst-getting-started-examples)), **Kotlin**, **PHP** (Lumen, Slim, Silex, [Symfony](https://symfony.com/), [Zend Expressive](https://github.com/zendframework/zend-expressive)), **Python** (Flask), **NodeJS**, **Ruby** (Sinatra, Rails5), **Rust** (rust-server), **Scala** ([Finch](https://github.com/finagle/finch), [Lagom](https://github.com/lagom/lagom), Scalatra)
|
@@ -77,7 +77,7 @@ Check out [OpenAPI-Spec](https://github.com/OAI/OpenAPI-Specification) for addit
|
77 | 77 |
|
78 | 78 |
|
79 | 79 | ## Compatibility
|
80 |
| -The OpenAPI Specification has undergone 3 revisions since initial creation in 2010. The swagger-codegen project has the following compatibilities with the OpenAPI Specification: |
| 80 | +The OpenAPI Specification has undergone 3 revisions since initial creation in 2010. The Swagger Codegen project has the following compatibilities with the OpenAPI Specification: |
81 | 81 |
|
82 | 82 | Swagger Codegen Version | Release Date | OpenAPI Spec compatibility | Notes
|
83 | 83 | -------------------------- | ------------ | -------------------------- | -----
|
@@ -342,12 +342,12 @@ Other languages have petstore samples, too:
|
342 | 342 | It's just as easy--just use the `-i` flag to point to either a server or file.
|
343 | 343 |
|
344 | 344 | ### Modifying the client library format
|
345 |
| -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. |
| 345 | +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. |
346 | 346 |
|
347 | 347 | 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.
|
348 | 348 |
|
349 | 349 | ### Making your own codegen modules
|
350 |
| -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: |
| 350 | +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: |
351 | 351 |
|
352 | 352 | ```sh
|
353 | 353 | java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar meta \
|
@@ -444,7 +444,7 @@ When using selective generation, _only_ the templates needed for the specific ge
|
444 | 444 |
|
445 | 445 | ### Ignore file format
|
446 | 446 |
|
447 |
| -Swagger codegen supports a `.swagger-codegen-ignore` file, similar to `.gitignore` or `.dockerignore` you're probably already familiar with. |
| 447 | +Swagger Codegen supports a `.swagger-codegen-ignore` file, similar to `.gitignore` or `.dockerignore` you're probably already familiar with. |
448 | 448 |
|
449 | 449 | 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.
|
450 | 450 |
|
@@ -636,7 +636,7 @@ Please refer to https://github.com/swagger-api/swagger-codegen/wiki/Server-stub-
|
636 | 636 |
|
637 | 637 | ### To build the codegen library
|
638 | 638 |
|
639 |
| -This will create the swagger-codegen library from source. |
| 639 | +This will create the Swagger Codegen library from source. |
640 | 640 |
|
641 | 641 | ```sh
|
642 | 642 | mvn package
|
|
0 commit comments