[Rust Server] Support complex query parameters (#5831)

* [Rust Server] Support complex query parameters

* [Rust Server] Remove unused extern crate

* [Rust Server] tokio should be a dev-dependency

* [Rust Server] Add test for complex query params

* Update samples

Co-authored-by: Matt Williams

Author: richardwhiuk

modules/openapi-generator/src/main/resources/rust-server/Cargo.mustache

@@ -87,7 +87,6 @@ mime_multipart = {version = "0.5", optional = true}
 hyper_0_10 = {package = "hyper", version = "0.10", default-features = false, optional=true}
 {{/apiUsesMultipartRelated}}
 serde_ignored = {version = "0.0.4", optional = true}
-tokio = {version = "0.1.17", optional = true}
 url = {version = "1.5", optional = true}
 
 # Client-specific
@@ -111,6 +110,7 @@ frunk-enum-core = { version = "0.2.0", optional = true }
 clap = "2.25"
 error-chain = "0.12"
 env_logger = "0.6"
+tokio = "0.1.17"
 {{^apiUsesUuid}}
 uuid = {version = "0.7", features = ["serde", "v4"]}
 {{/apiUsesUuid}}

modules/openapi-generator/src/main/resources/rust-server/client-operation.mustache

@@ -34,7 +34,7 @@
   {{^required}}
         if let Some(param_{{{paramName}}}) = param_{{{paramName}}} {
   {{/required}}
-            query_string.append_pair("{{{baseName}}}", &param_{{{paramName}}}{{#isListContainer}}.join(","){{/isListContainer}}{{^isListContainer}}.to_string(){{/isListContainer}});
+            query_string.append_pair("{{{baseName}}}", &param_{{{paramName}}}{{#isListContainer}}.iter().map(ToString::to_string).collect::<Vec<String>>().join(","){{/isListContainer}}{{^isListContainer}}.to_string(){{/isListContainer}});
   {{^required}}
         }
   {{/required}}

modules/openapi-generator/src/main/resources/rust-server/lib.mustache

@@ -67,8 +67,6 @@ extern crate mime_multipart;
 extern crate percent_encoding;
 #[cfg(any(feature = "client", feature = "server"))]
 extern crate serde_ignored;
-#[cfg(any(feature = "client", feature = "server"))]
-extern crate tokio;
 
 #[cfg(any(feature = "client", feature = "server"))]
 {{#apiUsesUuid}}extern crate uuid;{{/apiUsesUuid}}

modules/openapi-generator/src/main/resources/rust-server/models.mustache

@@ -64,6 +64,12 @@ impl std::convert::From<{{{dataType}}}> for {{{classname}}} {
 }
 
 {{#vendorExtensions.isString}}
+impl std::string::ToString for {{{classname}}} {
+    fn to_string(&self) -> String {
+       self.0.to_string()
+    }
+}
+
 impl std::str::FromStr for {{{classname}}} {
     type Err = std::string::ParseError;
     fn from_str(x: &str) -> std::result::Result<Self, Self::Err> {

modules/openapi-generator/src/main/resources/rust-server/server-operation.mustache

@@ -112,7 +112,7 @@
 {{/-first}}
                 let param_{{{paramName}}} = query_params.iter().filter(|e| e.0 == "{{{baseName}}}").map(|e| e.1.to_owned())
 {{#isListContainer}}
-                    .filter_map(|param_{{{paramName}}}| param_{{{paramName}}}.parse::<{{{baseType}}}>().ok())
+                    .filter_map(|param_{{{paramName}}}| param_{{{paramName}}}.parse().ok())
                     .collect::<Vec<_>>();
 {{^required}}
                 let param_{{{paramName}}} = if !param_{{{paramName}}}.is_empty() {

modules/openapi-generator/src/test/resources/3_0/rust-server/openapi-v3.yaml

@@ -337,6 +337,27 @@ paths:
       responses:
         "204":
           description: Success.
+  /merge-patch-json:
+    get:
+      responses:
+        200:
+          description: merge-patch+json-encoded response
+          content:
+            application/merge-patch+json:
+              schema:
+                $ref: "#/components/schemas/anotherXmlObject"
+  /complex-query-param:
+    get:
+      parameters:
+        - name: list-of-strings
+          in: query
+          schema:
+            type: array
+            items:
+              $ref: '#/components/schemas/StringObject'
+      responses:
+        '200':
+          description: Success
 
 components:
   securitySchemes:

samples/server/petstore/rust-server/output/multipart-v3/Cargo.toml

@@ -49,7 +49,6 @@ hyper = {version = "0.12", optional = true}
 mime_multipart = {version = "0.5", optional = true}
 hyper_0_10 = {package = "hyper", version = "0.10", default-features = false, optional=true}
 serde_ignored = {version = "0.0.4", optional = true}
-tokio = {version = "0.1.17", optional = true}
 url = {version = "1.5", optional = true}
 
 # Client-specific
@@ -70,6 +69,7 @@ frunk-enum-core = { version = "0.2.0", optional = true }
 clap = "2.25"
 error-chain = "0.12"
 env_logger = "0.6"
+tokio = "0.1.17"
 uuid = {version = "0.7", features = ["serde", "v4"]}
 
 [target.'cfg(not(any(target_os = "macos", target_os = "windows", target_os = "ios")))'.dev-dependencies]

samples/server/petstore/rust-server/output/multipart-v3/src/lib.rs

@@ -46,8 +46,6 @@ extern crate mime_multipart;
 extern crate percent_encoding;
 #[cfg(any(feature = "client", feature = "server"))]
 extern crate serde_ignored;
-#[cfg(any(feature = "client", feature = "server"))]
-extern crate tokio;
 
 #[cfg(any(feature = "client", feature = "server"))]
 

samples/server/petstore/rust-server/output/no-example-v3/Cargo.toml

@@ -39,7 +39,6 @@ serde_json = "1.0"
 # Common between server and client features
 hyper = {version = "0.12", optional = true}
 serde_ignored = {version = "0.0.4", optional = true}
-tokio = {version = "0.1.17", optional = true}
 url = {version = "1.5", optional = true}
 
 # Client-specific
@@ -60,6 +59,7 @@ frunk-enum-core = { version = "0.2.0", optional = true }
 clap = "2.25"
 error-chain = "0.12"
 env_logger = "0.6"
+tokio = "0.1.17"
 uuid = {version = "0.7", features = ["serde", "v4"]}
 
 [target.'cfg(not(any(target_os = "macos", target_os = "windows", target_os = "ios")))'.dev-dependencies]

samples/server/petstore/rust-server/output/no-example-v3/src/lib.rs

@@ -39,8 +39,6 @@ extern crate hyper_openssl;
 extern crate percent_encoding;
 #[cfg(any(feature = "client", feature = "server"))]
 extern crate serde_ignored;
-#[cfg(any(feature = "client", feature = "server"))]
-extern crate tokio;
 
 #[cfg(any(feature = "client", feature = "server"))]
 

samples/server/petstore/rust-server/output/openapi-v3/Cargo.toml

@@ -45,7 +45,6 @@ uuid = {version = "0.7", features = ["serde", "v4"]}
 # Common between server and client features
 hyper = {version = "0.12", optional = true}
 serde_ignored = {version = "0.0.4", optional = true}
-tokio = {version = "0.1.17", optional = true}
 url = {version = "1.5", optional = true}
 
 # Client-specific
@@ -66,6 +65,7 @@ frunk-enum-core = { version = "0.2.0", optional = true }
 clap = "2.25"
 error-chain = "0.12"
 env_logger = "0.6"
+tokio = "0.1.17"
 
 [target.'cfg(not(any(target_os = "macos", target_os = "windows", target_os = "ios")))'.dev-dependencies]
 tokio-openssl = "0.3"

samples/server/petstore/rust-server/output/openapi-v3/README.md

@@ -62,6 +62,7 @@ To run a client, follow one of the following simple steps:
 
 ```
 cargo run --example client CallbackWithHeaderPost
+cargo run --example client ComplexQueryParamGet
 cargo run --example client MandatoryRequestHeaderGet
 cargo run --example client MergePatchJsonGet
 cargo run --example client MultigetGet
@@ -114,6 +115,7 @@ All URIs are relative to *http://localhost*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [****](docs/default_api.md#) | **POST** /callback-with-header | 
+[****](docs/default_api.md#) | **GET** /complex-query-param | 
 [****](docs/default_api.md#) | **GET** /enum_in_path/{path_param} | 
 [****](docs/default_api.md#) | **GET** /mandatory-request-header | 
 [****](docs/default_api.md#) | **GET** /merge-patch-json | 

samples/server/petstore/rust-server/output/openapi-v3/api/openapi.yaml

@@ -345,6 +345,21 @@ paths:
           description: Success.
       servers:
       - url: /override
+  /complex-query-param:
+    get:
+      parameters:
+      - explode: true
+        in: query
+        name: list-of-strings
+        required: false
+        schema:
+          items:
+            $ref: '#/components/schemas/StringObject'
+          type: array
+        style: form
+      responses:
+        "200":
+          description: Success
 components:
   schemas:
     EnumWithStarObject:

samples/server/petstore/rust-server/output/openapi-v3/docs/default_api.md

@@ -5,6 +5,7 @@ All URIs are relative to *http://localhost*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 ****](default_api.md#) | **POST** /callback-with-header | 
+****](default_api.md#) | **GET** /complex-query-param | 
 ****](default_api.md#) | **GET** /enum_in_path/{path_param} | 
 ****](default_api.md#) | **GET** /mandatory-request-header | 
 ****](default_api.md#) | **GET** /merge-patch-json | 
@@ -51,6 +52,38 @@ No authorization required
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+# ****
+> (optional)
+
+
+### Required Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **optional** | **map[string]interface{}** | optional parameters | nil if no parameters
+
+### Optional Parameters
+Optional parameters are passed through a map[string]interface{}.
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **list_of_strings** | [**String**](String.md)|  | 
+
+### Return type
+
+ (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
 # ****
 > (path_param)
 

samples/server/petstore/rust-server/output/openapi-v3/examples/client/main.rs

@@ -30,6 +30,7 @@ use futures::{Future, future, Stream, stream};
 use openapi_v3::{Api, ApiNoContext, Client, ContextWrapperExt,
                       ApiError,
                       CallbackWithHeaderPostResponse,
+                      ComplexQueryParamGetResponse,
                       EnumInPathPathParamGetResponse,
                       MandatoryRequestHeaderGetResponse,
                       MergePatchJsonGetResponse,
@@ -66,6 +67,7 @@ fn main() {
             .help("Sets the operation to run")
             .possible_values(&[
                 "CallbackWithHeaderPost",
+                "ComplexQueryParamGet",
                 "MandatoryRequestHeaderGet",
                 "MergePatchJsonGet",
                 "MultigetGet",
@@ -136,6 +138,12 @@ fn main() {
             ));
             info!("{:?} (X-Span-ID: {:?})", result, (client.context() as &Has<XSpanIdString>).get().clone());
         },
+        Some("ComplexQueryParamGet") => {
+            let result = rt.block_on(client.complex_query_param_get(
+                  Some(&Vec::new())
+            ));
+            info!("{:?} (X-Span-ID: {:?})", result, (client.context() as &Has<XSpanIdString>).get().clone());
+        },
         /* Disabled because there's no example.
         Some("EnumInPathPathParamGet") => {
             let result = rt.block_on(client.enum_in_path_path_param_get(

samples/server/petstore/rust-server/output/openapi-v3/examples/server/server.rs

@@ -106,6 +106,7 @@ use openapi_v3::{
     Api,
     ApiError,
     CallbackWithHeaderPostResponse,
+    ComplexQueryParamGetResponse,
     EnumInPathPathParamGetResponse,
     MandatoryRequestHeaderGetResponse,
     MergePatchJsonGetResponse,
@@ -139,6 +140,16 @@ impl<C> Api<C> for Server<C> where C: Has<XSpanIdString>{
         Box::new(future::err("Generic failure".into()))
     }
 
+    fn complex_query_param_get(
+        &self,
+        list_of_strings: Option<&Vec<models::StringObject>>,
+        context: &C) -> Box<Future<Item=ComplexQueryParamGetResponse, Error=ApiError> + Send>
+    {
+        let context = context.clone();
+        info!("complex_query_param_get({:?}) - X-Span-ID: {:?}", list_of_strings, context.get().0.clone());
+        Box::new(future::err("Generic failure".into()))
+    }
+
     fn enum_in_path_path_param_get(
         &self,
         path_param: models::StringEnum,

samples/server/petstore/rust-server/output/openapi-v3/src/client/mod.rs

@@ -36,6 +36,7 @@ define_encode_set! {
 
 use {Api,
      CallbackWithHeaderPostResponse,
+     ComplexQueryParamGetResponse,
      EnumInPathPathParamGetResponse,
      MandatoryRequestHeaderGetResponse,
      MergePatchJsonGetResponse,
@@ -346,6 +347,81 @@ impl<C, F> Api<C> for Client<F> where
         }))
     }
 
+    fn complex_query_param_get(
+        &self,
+        param_list_of_strings: Option<&Vec<models::StringObject>>,
+        context: &C) -> Box<dyn Future<Item=ComplexQueryParamGetResponse, Error=ApiError> + Send>
+    {
+        let mut uri = format!(
+            "{}/complex-query-param",
+            self.base_path
+        );
+
+        // Query parameters
+        let mut query_string = url::form_urlencoded::Serializer::new("".to_owned());
+        if let Some(param_list_of_strings) = param_list_of_strings {
+            query_string.append_pair("list-of-strings", &param_list_of_strings.iter().map(ToString::to_string).collect::<Vec<String>>().join(","));
+        }
+        let query_string_str = query_string.finish();
+        if !query_string_str.is_empty() {
+            uri += "?";
+            uri += &query_string_str;
+        }
+
+        let uri = match Uri::from_str(&uri) {
+            Ok(uri) => uri,
+            Err(err) => return Box::new(future::err(ApiError(format!("Unable to build URI: {}", err)))),
+        };
+
+        let mut request = match hyper::Request::builder()
+            .method("GET")
+            .uri(uri)
+            .body(Body::empty()) {
+                Ok(req) => req,
+                Err(e) => return Box::new(future::err(ApiError(format!("Unable to create request: {}", e))))
+        };
+
+        let header = HeaderValue::from_str((context as &dyn Has<XSpanIdString>).get().0.clone().to_string().as_str());
+        request.headers_mut().insert(HeaderName::from_static("x-span-id"), match header {
+            Ok(h) => h,
+            Err(e) => return Box::new(future::err(ApiError(format!("Unable to create X-Span ID header value: {}", e))))
+        });
+
+        Box::new(self.client_service.request(request)
+                             .map_err(|e| ApiError(format!("No response received: {}", e)))
+                             .and_then(|mut response| {
+            match response.status().as_u16() {
+                200 => {
+                    let body = response.into_body();
+                    Box::new(
+                        future::ok(
+                            ComplexQueryParamGetResponse::Success
+                        )
+                    ) as Box<dyn Future<Item=_, Error=_> + Send>
+                },
+                code => {
+                    let headers = response.headers().clone();
+                    Box::new(response.into_body()
+                            .take(100)
+                            .concat2()
+                            .then(move |body|
+                                future::err(ApiError(format!("Unexpected response code {}:\n{:?}\n\n{}",
+                                    code,
+                                    headers,
+                                    match body {
+                                        Ok(ref body) => match str::from_utf8(body) {
+                                            Ok(body) => Cow::from(body),
+                                            Err(e) => Cow::from(format!("<Body was not UTF8: {:?}>", e)),
+                                        },
+                                        Err(e) => Cow::from(format!("<Failed to read body: {}>", e)),
+                                    })))
+                            )
+                    ) as Box<dyn Future<Item=_, Error=_> + Send>
+                }
+            }
+        }))
+    }
+
     fn enum_in_path_path_param_get(
         &self,
         param_path_param: models::StringEnum,