[Rust-Axum] Allow use of array query params (#20861)

* [Rust-Axum] Allow use of array query params

* Add sample per PR request

Author: tanadeau

bin/configs/manual/rust-axum-array-params.yaml

@@ -0,0 +1,11 @@
+generatorName: rust-axum
+outputDir: samples/server/petstore/rust-axum/output/rust-axum-array-params-test
+inputSpec: modules/openapi-generator/src/test/resources/3_0/rust/rust-axum-array-params-test.yaml
+templateDir: modules/openapi-generator/src/main/resources/rust-axum
+generateAliasAsModel: true
+additionalProperties:
+  hideGenerationTimestamp: "true"
+  packageName: rust-axum-array-params-test
+globalProperties:
+  skipFormModel: false
+enablePostProcessFile: true

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

@@ -41,7 +41,7 @@ conversion = [
 [dependencies]
 async-trait = "0.1"
 axum = { version = "0.8", features = ["multipart"] }
-axum-extra = { version = "0.10", features = ["cookie"] }
+axum-extra = { version = "0.10", features = ["cookie", "query"] }
 base64 = "0.22"
 bytes = "1"
 chrono = { version = "0.4", features = ["serde"] }
@@ -54,8 +54,8 @@ http = "1"
 lazy_static = "1"
 regex = "1"
 serde = { version = "1", features = ["derive"] }
+serde_html_form = "0.2"
 serde_json = { version = "1", features = ["raw_value"] }
-serde_urlencoded = "0.7"
 tokio = { version = "1", default-features = false, features = [
     "signal",
     "rt-multi-thread",

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

@@ -207,7 +207,6 @@ use crate::{models, types::*};
     #[cfg_attr(feature = "conversion", derive(frunk::LabelledGeneric))] 
     pub struct {{{operationIdCamelCase}}}QueryParams {
         {{#queryParams}}
-          {{#vendorExtensions}}
             {{#description}}    
             /// {{{.}}}
             {{/description}}
@@ -266,6 +265,16 @@ use crate::{models, types::*};
                     {{/maxItems}}
                     )]
             {{/hasValidation}}
+            {{#isArray}}
+            {{#isNullable}}
+                // Nullable array query parameters are not fully supported.
+            {{/isNullable}}
+            {{^required}}
+                #[serde(default)]
+            {{/required}}
+                pub {{{paramName}}}: {{{dataType}}},
+            {{/isArray}}
+            {{^isArray}}
             {{#required}}
                 pub {{{paramName}}}: {{#isNullable}}Nullable<{{/isNullable}}{{{dataType}}}{{#isNullable}}>{{/isNullable}},
             {{/required}}
@@ -277,7 +286,7 @@ use crate::{models, types::*};
                 #[serde(skip_serializing_if="Option::is_none")]
                 pub {{{paramName}}}: Option<{{#isNullable}}Nullable<{{/isNullable}}{{{dataType}}}{{#isNullable}}>{{/isNullable}}>,
             {{/required}}
-          {{/vendorExtensions}}
+            {{/isArray}}
         {{/queryParams}}
     }
 

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

@@ -1,7 +1,7 @@
 use std::collections::HashMap;
 
 use axum::{body::Body, extract::*, response::Response, routing::*};
-use axum_extra::extract::{CookieJar, Host};
+use axum_extra::extract::{CookieJar, Host, Query as QueryExtra};
 use bytes::Bytes;
 use http::{header::CONTENT_TYPE, HeaderMap, HeaderName, HeaderValue, Method, StatusCode};
 use tracing::error;

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

@@ -23,7 +23,7 @@ async fn {{#vendorExtensions}}{{{x-operation-id}}}{{/vendorExtensions}}<I, A, E{
   Path(path_params): Path<models::{{{operationIdCamelCase}}}PathParams>,
 {{/pathParams.size}}
 {{#queryParams.size}}
-  Query(query_params): Query<models::{{{operationIdCamelCase}}}QueryParams>,
+  QueryExtra(query_params): QueryExtra<models::{{{operationIdCamelCase}}}QueryParams>,
 {{/queryParams.size}}
  State(api_impl): State<I>,
 {{#vendorExtensions}}
@@ -334,7 +334,7 @@ where
   {{#allowBlockingResponseSerialize}}
                                                   let body_content =
   {{/allowBlockingResponseSerialize}}
-                                                      serde_urlencoded::to_string(body).map_err(|e| {
+                                                      serde_html_form::to_string(body).map_err(|e| {
                                                         error!(error = ?e);
                                                         StatusCode::INTERNAL_SERVER_ERROR
                                                       }){{^allowBlockingResponseSerialize}}).await.unwrap(){{/allowBlockingResponseSerialize}}?;

modules/openapi-generator/src/test/resources/3_0/rust/rust-axum-array-params-test.yaml

@@ -0,0 +1,24 @@
+openapi: 3.0.1
+info:
+  title: Test to check that array query params are rendered correctly.
+  version: 0.0.1
+paths:
+  /endpoint:
+    get:
+      description: Some endpoint.
+      parameters:
+        - name: numbers
+          in: query
+          description: Some numbers.
+          schema:
+            type: array
+            items:
+              type: number
+        - name: multiplier
+          in: query
+          description: Multipler for sum.
+          schema:
+            type: number  
+      responses:
+        '200':
+          description: OK.

samples/server/petstore/rust-axum/output/apikey-auths/.openapi-generator/VERSION

@@ -1 +1 @@
-7.12.0-SNAPSHOT
+7.13.0-SNAPSHOT

samples/server/petstore/rust-axum/output/apikey-auths/Cargo.toml

@@ -19,7 +19,7 @@ conversion = [
 [dependencies]
 async-trait = "0.1"
 axum = { version = "0.8", features = ["multipart"] }
-axum-extra = { version = "0.10", features = ["cookie"] }
+axum-extra = { version = "0.10", features = ["cookie", "query"] }
 base64 = "0.22"
 bytes = "1"
 chrono = { version = "0.4", features = ["serde"] }
@@ -32,8 +32,8 @@ http = "1"
 lazy_static = "1"
 regex = "1"
 serde = { version = "1", features = ["derive"] }
+serde_html_form = "0.2"
 serde_json = { version = "1", features = ["raw_value"] }
-serde_urlencoded = "0.7"
 tokio = { version = "1", default-features = false, features = [
     "signal",
     "rt-multi-thread",

samples/server/petstore/rust-axum/output/apikey-auths/README.md

@@ -12,7 +12,7 @@ server, you can easily generate a server stub.
 To see how to make this your own, look here: [README]((https://openapi-generator.tech))
 
 - API version: 1.0.0
-- Generator version: 7.12.0-SNAPSHOT
+- Generator version: 7.13.0-SNAPSHOT
 
 
 

samples/server/petstore/rust-axum/output/apikey-auths/src/server/mod.rs

@@ -1,7 +1,7 @@
 use std::collections::HashMap;
 
 use axum::{body::Body, extract::*, response::Response, routing::*};
-use axum_extra::extract::{CookieJar, Host};
+use axum_extra::extract::{CookieJar, Host, Query as QueryExtra};
 use bytes::Bytes;
 use http::{header::CONTENT_TYPE, HeaderMap, HeaderName, HeaderValue, Method, StatusCode};
 use tracing::error;