[rust-server] Plaintext support; encode params (#7082)

* MMORCH-428: Export the Authorization struct

This is needed so that code can check that the version of Authorization
in the auto-generated code is the same as the version it is using. If
the versions are not exactly the same then the lookup into the TypeMap
will not work.

* Add Rust as a supported language for client and server.

Clarify that there are two Rust client implementations, and one Rust server implementation.

* Percent-encode path and query parameters in client URLs
Fixes #122

Also don't include a question mark at the end of the path when there are no query paramters.
Fixes #121

* Rust2 client: add --host and --port parameters to example client.

Allows the example command-line client to override the default host and port.

* Extract default host and port from Swagger file.

* Derive 'Eq' and 'Ord' on enums

* Rust2: improve server code structure.

    server.rs (main.rs) - main entry point for binary; starts the web server and points it at the server code within the library.
    server_lib/mod.rs (lib.rs) - root of library; creates the server.
    server_lib/server.rs (server.rs) - actual server code

The old server_lib/mod.rs is now server_lib/server.rs; server_lib/mod.rs is new.

This structure is easy to map onto a server implementation; unfortunately we can't get it exactly right here because of the limitations of cargo's examples/ folder.

* Rust2: Explain fully how to use the example code in your project.

* Added plaintext support

* Linting

* MGJ Markups

Author: bjgill

README.md

@@ -24,9 +24,9 @@
 ## Overview
 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:
 
-- **API clients**: **ActionScript**, **Ada**, **Apex**, **Bash**, **C#** (.net 2.0, 3.5 or later), **C++** (cpprest, Qt5, Tizen), **Clojure**, **Dart**, **Elixir**, **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), **Kotlin**, **Lua**, **Node.js** (ES5, ES6, AngularJS with Google Closure Compiler annotations) **Objective-C**, **Perl**, **PHP**, **PowerShell**, **Python**, **R**, **Ruby**, **Rust**, **Scala** (akka, http4s, swagger-async-httpclient), **Swift** (2.x, 3.x, 4.x), **Typescript** (Angular1.x, Angular2.x, Fetch, jQuery, Node)
-- **Server stubs**: **C#** (ASP.NET Core, NancyFx), **C++** (Pistache, Restbed), **Erlang**, **Go**, **Haskell** (Servant), **Java** (MSF4J, Spring, Undertow, JAX-RS: CDI, CXF, Inflector, RestEasy, Play Framework), **PHP** (Lumen, Slim, Silex, [Symfony](https://symfony.com/), [Zend Expressive](https://github.com/zendframework/zend-expressive)), **Python** (Flask), **NodeJS**, **Ruby** (Sinatra, Rails5), **Rust**, **Scala** ([Finch](https://github.com/finagle/finch), [Lagom](https://github.com/lagom/lagom), Scalatra)
-- **API documentation generators**: **HTML**, **Confluence Wiki** 
+- **API clients**: **ActionScript**, **Ada**, **Apex**, **Bash**, **C#** (.net 2.0, 3.5 or later), **C++** (cpprest, Qt5, Tizen), **Clojure**, **Dart**, **Elixir**, **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), **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)
+- **Server stubs**: **C#** (ASP.NET Core, NancyFx), **C++** (Pistache, Restbed), **Erlang**, **Go**, **Haskell** (Servant), **Java** (MSF4J, Spring, Undertow, JAX-RS: CDI, CXF, Inflector, RestEasy, Play Framework), **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)
+- **API documentation generators**: **HTML**, **Confluence Wiki**
 - **Configuration files**: [**Apache2**](https://httpd.apache.org/)
 - **Others**: **JMeter**
 
@@ -300,8 +300,8 @@ OPTIONS
             adds authorization headers when fetching the swagger definitions
             remotely. Pass in a URL-encoded string of name:header with a comma
             separating multiple values
-	    
-...... (results omitted)    
+
+...... (results omitted)
 
         -v, --verbose
             verbose mode
@@ -497,7 +497,7 @@ and `config.json` contains the following as an example:
 }
 ```
 
-Supported config options can be different per language. Running `config-help -l {lang}` will show available options.  
+Supported config options can be different per language. Running `config-help -l {lang}` will show available options.
 **These options are applied via configuration file (e.g. config.json) or by passing them with `-D{optionName}={optionValue}`**. (If `-D{optionName}` does not work, please open a [ticket](https://github.com/swagger-api/swagger-codegen/issues/new) and we'll look into it)
 
 ```sh
@@ -789,7 +789,7 @@ Here are some companies/projects using Swagger Codegen in production. To add you
 - [High Technologies Center](http://htc-cs.com)
 - [IBM](https://www.ibm.com)
 - [IMS Health](http://www.imshealth.com/en/solution-areas/technology-and-applications)
-- [Individual Standard IVS](http://www.individual-standard.com) 
+- [Individual Standard IVS](http://www.individual-standard.com)
 - [Intent HQ](http://www.intenthq.com)
 - [Kabuku](http://www.kabuku.co.jp/en)
 - [Kurio](https://kurio.co.id)
@@ -890,7 +890,7 @@ Presentations/Videos/Tutorials/Books
 - 2016/11/25 - [Swagger Codegen for Swift3 and NodeJS](https://normand1.github.io/blog/swift/swagger/codegen/2016/11/25/Swagger-Codegen-for-Swift3-and-NodeJS.html) by [David Norman](https://github.com/normand1)
 - 2016/12/08 - [Generate client side code using Swagger Codegen](https://carra-lucia-ltd.co.uk/2016/12/08/generate-client-side-code-using-swagger-codegen/) by [theFerkel](https://carra-lucia-ltd.co.uk/author/theferkel/)
 - 2017/01/16 - [Zero to API in 4 minutes](https://cidrblock.github.io/zero-to-api-in-4-minutes.html) by [Bradley A. Thornton](https://github.com/cidrblock)
-- 2017/02/09 - [「Swaggerを利用した新規サービス開発」というタイトルで登壇して来ました](https://techblog.recochoku.jp/1055) by [recotech](https://www.slideshare.net/recotech) 
+- 2017/02/09 - [「Swaggerを利用した新規サービス開発」というタイトルで登壇して来ました](https://techblog.recochoku.jp/1055) by [recotech](https://www.slideshare.net/recotech)
 - 2017/03/03 - [Swagger Codegen の使い方の簡単な説明です](https://speakerdeck.com/wagyu298/swagger-codegen) by [wagyu298](https://github.com/wagyu298)
 - 2017/03/24 - [Using Open API Specification To Put Lyft SDK Support in the Fast Lane](https://medium.com/lyft-developer-platform/using-open-api-specification-to-put-lyft-sdk-support-in-the-fast-lane-7b623218e4ee) by [Val Polouchkine](https://github.com/vpolouchkine)
 - 2017/04/13 - [Automatically Generating your API Client with Swagger and Swagger Codegen](https://www.youtube.com/watch?v=EzKwi-u9jQo) by [Jesse Collis](https://github.com/jessedc) @ Melbourne Cocoaheads
@@ -903,7 +903,7 @@ Presentations/Videos/Tutorials/Books
 - 2017/07/11 - [OpenAPI development with Python](https://www.slideshare.net/TakuroWada/20170711-euro-python2017) by [和田拓朗](https://github.com/taxpon) at [EuroPython 2017](https://ep2017.europython.eu/en/)
 - 2017/07/29 - [How Square makes its SDKs](https://medium.com/square-corner-blog/how-square-makes-its-sdks-6a0fd7ea4b2d) by [Tristan Sokol](https://github.com/tristansokol) ([Square](https://github.com/square))
 - 2017/07/31 - [How to Generate a Deployable REST CXF3 Application from a Swagger-Contract](https://www.youtube.com/watch?v=gM63rJlUHZQ) by [Johannes Fiala](https://github.com/jfiala) @ Voxxed Days Vienna
-- 2017/08/11 - [Swagger Codegen 自动生成Retrofit 代码](https://juejin.im/entry/598d8eb86fb9a03c52459e2a) by [徐磊](http://www.jianshu.com/u/792c738b33fc) 
+- 2017/08/11 - [Swagger Codegen 自动生成Retrofit 代码](https://juejin.im/entry/598d8eb86fb9a03c52459e2a) by [徐磊](http://www.jianshu.com/u/792c738b33fc)
 - 2017/08/24 - [APIs First](https://engineering.squarespace.com/blog/2017/apis-first) by [roykachouh](https://github.com/roykachouh) ([Square](https://github.com/square))
 - 2017/08/31 - [Bringing Jenkins Remote Access API To The Masses](http://blog.cliffano.com/2017/09/01/jenkins-world-2017/) by [Cliffano Subagio](http://cliffano.com) from [Shine Solutions](https://shinesolutions.com/) @ [Jenkins World 2017](https://jenkinsworld20162017.sched.com/)
 - 2017/09/08 - [Swagger Codegen で自動生成したクライアントSDKを使う(iOS編)](http://blog.techium.jp/entry/2017/09/08/071650) by [kfurue](http://profile.hatena.ne.jp/kfurue/)
@@ -928,12 +928,12 @@ Swagger Codegen core team members are contributors who have been making signific
 | Languages     | Core Team (join date) |
 |:-------------|:-------------|
 | ActionScript | |
-| C++      |  |  
+| C++      |  |
 | C#      | @jimschubert (2016/05/01) |
 | Clojure | @xhh (2016/05/01) |
-| Dart      |  |  
-| Groovy     |  |  
-| Go     |  @guohuang (2016/05/01) @neilotoole (2016/05/01) |  
+| Dart      |  |
+| Groovy     |  |
+| Go     |  @guohuang (2016/05/01) @neilotoole (2016/05/01) |
 | Java      | @cbornet (2016/05/01) @xhh (2016/05/01) @epaul (2016/06/04) |
 | Java (Spring Cloud) | @cbornet (2016/07/19) |
 | Kotlin      | @jimschubert (2016/05/01) |
@@ -960,7 +960,7 @@ Swagger Codegen core team members are contributors who have been making signific
 | Java JAX-RS |  |
 | Java Play Framework |  |
 | NancyFX |  |
-| NodeJS | @kolyjjj (2016/05/01) |  
+| NodeJS | @kolyjjj (2016/05/01) |
 | PHP Lumen | @abcsun (2016/05/01) |
 | PHP Silex |  |
 | PHP Slim  |  |
@@ -1010,15 +1010,15 @@ Here is a list of template creators:
    * R: @ramnov
    * Rust: @farcaller
    * Rust (rust-server): @metaswitch
-   * Scala (scalaz & http4s): @tbrown1979 
+   * Scala (scalaz & http4s): @tbrown1979
    * Swift: @tkqubo
    * Swift 3: @hexelon
    * Swift 4: @ehyche
    * TypeScript (Node):  @mhardorf
    * TypeScript (Angular1):  @mhardorf
    * TypeScript (Fetch): @leonyu
    * TypeScript (Angular2): @roni-frantchi
-   * TypeScript (jQuery): @bherila 
+   * TypeScript (jQuery): @bherila
  * Server Stubs
    * C# ASP.NET5: @jimschubert
    * C# NancyFX: @mstefaniuk
@@ -1083,7 +1083,7 @@ If you want to join the committee, please kindly apply by sending an email to wi
 | Android | @jaz-ah (2017/09) |
 | Apex  |     |
 | Bash  | @frol (2017/07) @bkryza (2017/08) @kenjones-cisco (2017/09) |
-| C++      | @ravinikam (2017/07) @stkrwork (2017/07) @fvarose (2017/11) |  
+| C++      | @ravinikam (2017/07) @stkrwork (2017/07) @fvarose (2017/11) |
 | C#        | @mandrean (2017/08) @jimschubert (2017/09) |
 | Clojure   |  |
 | Dart      | @ircecho (2017/07) |
@@ -1103,7 +1103,7 @@ If you want to join the committee, please kindly apply by sending an email to wi
 | Python   | @taxpon (2017/07) @frol (2017/07) @mbohlool (2017/07) @cbornet (2017/09) @kenjones-cisco (2017/11)|
 | R        |  |
 | Ruby      | @cliffano (2017/07) @zlx (2017/09) |
-| Rust      | @frol (2017/07) @farcaller (2017/08) | 
+| Rust      | @frol (2017/07) @farcaller (2017/08) |
 | Scala     | @clasnake (2017/07) @jimschubert (2017/09) |
 | Swift     | @jgavris (2017/07) @ehyche (2017/08) @Edubits (2017/09) @jaz-ah (2017/09) |
 | TypeScript | @TiFu (2017/07) @taxpon (2017/07) @sebastianhaas (2017/07) @kenisteward (2017/07) @Vrolijkx (2017/09) |

modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/RustServerCodegen.java

@@ -34,6 +34,7 @@ public class RustServerCodegen extends DefaultCodegen implements CodegenConfig {
     private HashMap<String, String> modelXmlNames = new HashMap<String, String>();
 
     protected String apiVersion = "1.0.0";
+    protected String serverHost = "localhost";
     protected int serverPort = 8080;
     protected String projectName = "swagger-server";
     protected String apiPath = "rust-server";
@@ -148,7 +149,6 @@ public RustServerCodegen() {
          * are available in models, apis, and supporting files
          */
         additionalProperties.put("apiVersion", apiVersion);
-        additionalProperties.put("serverPort", serverPort);
         additionalProperties.put("apiPath", apiPath);
 
         /*
@@ -168,6 +168,7 @@ public RustServerCodegen() {
         supportingFiles.add(new SupportingFile("example-server.mustache", "examples", "server.rs"));
         supportingFiles.add(new SupportingFile("example-client.mustache", "examples", "client.rs"));
         supportingFiles.add(new SupportingFile("example-server_lib.mustache", "examples/server_lib", "mod.rs"));
+        supportingFiles.add(new SupportingFile("example-server_server.mustache", "examples/server_lib", "server.rs"));
         supportingFiles.add(new SupportingFile("example-ca.pem", "examples", "ca.pem"));
         supportingFiles.add(new SupportingFile("example-server-chain.pem", "examples", "server-chain.pem"));
         supportingFiles.add(new SupportingFile("example-server-key.pem", "examples", "server-key.pem"));
@@ -257,6 +258,23 @@ public void preprocessSwagger(Swagger swagger) {
             versionComponents.add("0");
         }
         info.setVersion(StringUtils.join(versionComponents, "."));
+
+        String host = swagger.getHost();
+        if (host != null) {
+            String[] parts = host.split(":");
+            if (parts.length > 1) {
+                serverHost = parts[0];
+                try {
+                    serverPort = Integer.valueOf(parts[1]);
+                } catch (NumberFormatException e) {
+                    LOGGER.warn("Port of Swagger host is not an integer : " + host, e);
+                }
+            } else {
+                serverHost = host;
+            }
+        }
+        additionalProperties.put("serverHost", serverHost);
+        additionalProperties.put("serverPort", serverPort);
     }
 
     @Override
@@ -512,6 +530,7 @@ public CodegenOperation fromOperation(String path, String httpMethod, Operation
             LOGGER.debug("No consumes defined in operation. Using global consumes (" + swagger.getConsumes() + ") for " + op.operationId);
         }
 
+        boolean consumesPlainText = false;
         boolean consumesXml = false;
         // if "consumes" is defined (per operation or using global definition)
         if (consumes != null && !consumes.isEmpty()) {
@@ -523,6 +542,8 @@ public CodegenOperation fromOperation(String path, String httpMethod, Operation
                 if (mimeType.startsWith("Application/Xml")) {
                     additionalProperties.put("usesXml", true);
                     consumesXml = true;
+                } else if (mimeType.startsWith("Text/Plain")) {
+                    consumesPlainText = true;
                 }
 
                 mediaType.put("mediaType", mimeType);
@@ -545,6 +566,7 @@ public CodegenOperation fromOperation(String path, String httpMethod, Operation
         }
 
         boolean producesXml = false;
+        boolean producesPlainText = false;
         if (produces != null && !produces.isEmpty()) {
             List<Map<String, String>> c = new ArrayList<Map<String, String>>();
             for (String key : produces) {
@@ -554,6 +576,8 @@ public CodegenOperation fromOperation(String path, String httpMethod, Operation
                 if (mimeType.startsWith("Application/Xml")) {
                     additionalProperties.put("usesXml", true);
                     producesXml = true;
+                } else if (mimeType.startsWith("Text/Plain")) {
+                    producesPlainText = true;
                 }
 
                 mediaType.put("mediaType", mimeType);
@@ -572,9 +596,14 @@ public CodegenOperation fromOperation(String path, String httpMethod, Operation
                 op.bodyParam.vendorExtensions.put("model_key", key);
             }
 
+            // Default to consuming json
             op.bodyParam.vendorExtensions.put("uppercase_operation_id", underscore(op.operationId).toUpperCase());
             if (consumesXml) {
                 op.bodyParam.vendorExtensions.put("consumesXml", true);
+            } else if (consumesPlainText) {
+                op.bodyParam.vendorExtensions.put("consumesPlainText", true);
+            } else {
+                op.bodyParam.vendorExtensions.put("consumesJson", true);
             }
 
         }
@@ -586,8 +615,13 @@ public CodegenOperation fromOperation(String path, String httpMethod, Operation
 
             param.vendorExtensions.put("uppercase_operation_id", underscore(op.operationId).toUpperCase());
 
+            // Default to producing json if nothing else is specified
             if (consumesXml) {
                 param.vendorExtensions.put("consumesXml", true);
+            } else if (consumesPlainText) {
+                param.vendorExtensions.put("consumesPlainText", true);
+            } else {
+                param.vendorExtensions.put("consumesJson", true);
             }
         }
         for (CodegenParameter param : op.headerParams) {
@@ -601,8 +635,13 @@ public CodegenOperation fromOperation(String path, String httpMethod, Operation
             if (rsp.dataType != null) {
                 rsp.vendorExtensions.put("uppercase_data_type", (rsp.dataType.replace("models::", "")).toUpperCase());
 
+                // Default to producing json if nothing else is specified
                 if (producesXml) {
                     rsp.vendorExtensions.put("producesXml", true);
+                } else if (producesPlainText) {
+                    rsp.vendorExtensions.put("producesPlainText", true);
+                } else {
+                    rsp.vendorExtensions.put("producesJson", true);
                 }
 
                 // Check whether we're returning an object with a defined XML namespace.

modules/swagger-codegen/src/main/resources/rust-server/Cargo.mustache

@@ -13,12 +13,19 @@ client = ["serde_json", {{#usesXml}}"serde-xml-rs", {{/usesXml}}"serde_ignored",
 server = ["serde_json", {{#usesXml}}"serde-xml-rs", {{/usesXml}}"serde_ignored", "hyper", "iron", "router", "bodyparser", "urlencoded", "uuid"{{#apiHasFile}}, "multipart"{{/apiHasFile}}]
 
 [dependencies]
-bodyparser = {version = "0.7", optional = true}
+# Required by example server.
+#
 chrono = { version = "0.4", features = ["serde"] }
 futures = "0.1"
 hyper = {version = "0.10", optional = true}
 hyper-openssl = {version = "0.2", optional = true }
 iron = {version = "0.5", optional = true}
+swagger = "0.7"
+
+# Not required by example server.
+#
+bodyparser = {version = "0.7", optional = true}
+url = "1.5"
 lazy_static = "0.2"
 log = "0.3.0"
 multipart = {version = "0.13", optional = true}
@@ -27,7 +34,6 @@ serde = "1.0"
 serde_derive = "1.0"
 serde_ignored = {version = "0.0.4", optional = true}
 serde_json = {version = "1.0", optional = true}
-swagger = "0.7"
 urlencoded = {version = "0.5", optional = true}
 uuid = {version = "0.5", optional = true, features = ["serde", "v4"]}
 # ToDo: this should be updated to point at the official crate once
@@ -36,3 +42,4 @@ uuid = {version = "0.5", optional = true, features = ["serde", "v4"]}
 
 [dev-dependencies]
 clap = "2.25"
+error-chain = "0.11"