Add support for ApiKey auth to rust-server (#22950)

dsteeley · web-flow · commit a53ebb3ad2dd · 2026-02-12T19:51:49.000+08:00
diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/RustServerCodegen.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/RustServerCodegen.java
@@ -977,7 +977,6 @@ private void postProcessOperationWithModels(CodegenOperation op, List<ModelMap>
 
             for (CodegenSecurity s : op.authMethods) {
                 if (s.isApiKey && s.isKeyInHeader) {
-                    s.vendorExtensions.put("x-api-key-name", toModelName(s.keyParamName));
                     headerAuthMethods = true;
                 }
 
diff --git a/modules/openapi-generator/src/main/resources/rust-server/bin-cli.mustache b/modules/openapi-generator/src/main/resources/rust-server/bin-cli.mustache
@@ -86,6 +86,12 @@ struct Cli {
     bearer_token: Option<String>,
 {{/hasOAuthMethods}}
 {{/hasHttpBearerMethods}}
+{{#hasApiKeyMethods}}
+
+    /// API key for authentication
+    #[arg(long, env = "{{#lambda.uppercase}}{{externCrateName}}{{/lambda.uppercase}}_API_KEY", hide_env = true)]
+    api_key: Option<String>,
+{{/hasApiKeyMethods}}
 }
 
 #[derive(Parser, Debug)]
@@ -187,6 +193,12 @@ async fn main() -> Result<()> {
         debug!("Using bearer token");
         auth_data = AuthData::bearer(bearer_token);
     }
+{{#hasApiKeyMethods}}
+    if let Some(ref api_key) = args.api_key {
+        debug!("Using API key");
+        auth_data = Some(AuthData::apikey(api_key));
+    }
+{{/hasApiKeyMethods}}
 {{/hasHttpBearerMethods}}
 {{^hasHttpBearerMethods}}
   {{#hasOAuthMethods}}
@@ -196,11 +208,27 @@ async fn main() -> Result<()> {
         debug!("Using bearer token");
         auth_data = AuthData::bearer(bearer_token);
     }
+{{#hasApiKeyMethods}}
+    if let Some(ref api_key) = args.api_key {
+        debug!("Using API key");
+        auth_data = Some(AuthData::apikey(api_key));
+    }
+{{/hasApiKeyMethods}}
   {{/hasOAuthMethods}}
 {{/hasHttpBearerMethods}}
 {{^hasHttpBearerMethods}}
   {{^hasOAuthMethods}}
+{{#hasApiKeyMethods}}
+    let mut auth_data: Option<AuthData> = None;
+
+    if let Some(ref api_key) = args.api_key {
+        debug!("Using API key");
+        auth_data = Some(AuthData::apikey(api_key));
+    }
+{{/hasApiKeyMethods}}
+{{^hasApiKeyMethods}}
     let auth_data: Option<AuthData> = None;
+{{/hasApiKeyMethods}}
   {{/hasOAuthMethods}}
 {{/hasHttpBearerMethods}}
 
diff --git a/modules/openapi-generator/src/main/resources/rust-server/client-operation.mustache b/modules/openapi-generator/src/main/resources/rust-server/client-operation.mustache
@@ -99,7 +99,6 @@
         #[allow(clippy::collapsible_match)]
         if let Some(auth_data) = Has::<Option<AuthData>>::get(context).as_ref() {
             use headers::authorization::Credentials;
-            {{! Currently only authentication with Basic and Bearer are supported }}
             #[allow(clippy::single_match, clippy::match_single_binding)]
             match auth_data {
             {{#authMethods}}
@@ -135,6 +134,19 @@
                 },
                 {{/isBasicBearer}}
                 {{/isOAuth}}
+                {{#isApiKey}}
+                {{#isKeyInHeader}}
+                AuthData::ApiKey(ref api_key) => {
+                    let header = match HeaderValue::from_str(api_key.as_str()) {
+                        Ok(h) => h,
+                        Err(e) => return Err(ApiError(format!("Unable to create header: {e}")))
+                    };
+                    request.headers_mut().insert(
+                        HeaderName::from_static("{{#lambda.lowercase}}{{{keyParamName}}}{{/lambda.lowercase}}"),
+                        header);
+                },
+                {{/isKeyInHeader}}
+                {{/isApiKey}}
             {{/authMethods}}
                 _ => {}
             }
diff --git a/modules/openapi-generator/src/main/resources/rust-server/context.mustache b/modules/openapi-generator/src/main/resources/rust-server/context.mustache
@@ -142,7 +142,7 @@ impl<T, A, B, C, ReqBody> Service<Request<ReqBody>> for AddContext<T, A>
         {
             use swagger::auth::api_key_from_header;
 
-            if let Some(header) = api_key_from_header(headers, "{{exts.x-key-param-name-lower}}") {
+            if let Some(header) = api_key_from_header(headers, "{{#lambda.lowercase}}{{{keyParamName}}}{{/lambda.lowercase}}") {
                 let auth_data = AuthData::ApiKey(header);
                 let context = context.push(Some(auth_data));
 
diff --git a/samples/server/petstore/rust-server/output/petstore-with-fake-endpoints-models-for-testing/bin/cli.rs b/samples/server/petstore/rust-server/output/petstore-with-fake-endpoints-models-for-testing/bin/cli.rs
@@ -97,6 +97,10 @@ struct Cli {
     /// Bearer token if used for authentication
     #[arg(env = "PETSTORE_WITH_FAKE_ENDPOINTS_MODELS_FOR_TESTING_BEARER_TOKEN", hide_env = true)]
     bearer_token: Option<String>,
+
+    /// API key for authentication
+    #[arg(long, env = "PETSTORE_WITH_FAKE_ENDPOINTS_MODELS_FOR_TESTING_API_KEY", hide_env = true)]
+    api_key: Option<String>,
 }
 
 #[derive(Parser, Debug)]
@@ -398,6 +402,10 @@ async fn main() -> Result<()> {
         debug!("Using bearer token");
         auth_data = AuthData::bearer(bearer_token);
     }
+    if let Some(ref api_key) = args.api_key {
+        debug!("Using API key");
+        auth_data = Some(AuthData::apikey(api_key));
+    }
 
     #[allow(trivial_casts)]
     let context = swagger::make_context!(
diff --git a/samples/server/petstore/rust-server/output/petstore-with-fake-endpoints-models-for-testing/src/client/mod.rs b/samples/server/petstore/rust-server/output/petstore-with-fake-endpoints-models-for-testing/src/client/mod.rs
@@ -2476,6 +2476,15 @@ impl<S, C, B> Api<C> for Client<S, C> where
             use headers::authorization::Credentials;
             #[allow(clippy::single_match, clippy::match_single_binding)]
             match auth_data {
+                AuthData::ApiKey(ref api_key) => {
+                    let header = match HeaderValue::from_str(api_key.as_str()) {
+                        Ok(h) => h,
+                        Err(e) => return Err(ApiError(format!("Unable to create header: {e}")))
+                    };
+                    request.headers_mut().insert(
+                        HeaderName::from_static("api_key"),
+                        header);
+                },
                 _ => {}
             }
         }
@@ -2848,6 +2857,15 @@ impl<S, C, B> Api<C> for Client<S, C> where
             use headers::authorization::Credentials;
             #[allow(clippy::single_match, clippy::match_single_binding)]
             match auth_data {
+                AuthData::ApiKey(ref api_key) => {
+                    let header = match HeaderValue::from_str(api_key.as_str()) {
+                        Ok(h) => h,
+                        Err(e) => return Err(ApiError(format!("Unable to create header: {e}")))
+                    };
+                    request.headers_mut().insert(
+                        HeaderName::from_static("api_key"),
+                        header);
+                },
                 _ => {}
             }
         }
diff --git a/samples/server/petstore/rust-server/output/petstore-with-fake-endpoints-models-for-testing/src/context.rs b/samples/server/petstore/rust-server/output/petstore-with-fake-endpoints-models-for-testing/src/context.rs
@@ -114,7 +114,7 @@ impl<T, A, B, C, ReqBody> Service<Request<ReqBody>> for AddContext<T, A>
         {
             use swagger::auth::api_key_from_header;
 
-            if let Some(header) = api_key_from_header(headers, "") {
+            if let Some(header) = api_key_from_header(headers, "api_key") {
                 let auth_data = AuthData::ApiKey(header);
                 let context = context.push(Some(auth_data));
 

Original file line number	Diff line number	Diff line change
`@@ -977,7 +977,6 @@ private void postProcessOperationWithModels(CodegenOperation op, List<ModelMap>`
`977`	`977`
`978`	`978`	`for (CodegenSecurity s : op.authMethods) {`
`979`	`979`	`if (s.isApiKey && s.isKeyInHeader) {`
`980`		`- s.vendorExtensions.put("x-api-key-name", toModelName(s.keyParamName));`
`981`	`980`	`headerAuthMethods = true;`
`982`	`981`	`}`
`983`	`982`
Original file line number	Diff line number	Diff line change
`@@ -142,7 +142,7 @@ impl<T, A, B, C, ReqBody> Service<Request<ReqBody>> for AddContext<T, A>`
`142`	`142`	`{`
`143`	`143`	`use swagger::auth::api_key_from_header;`
`144`	`144`
`145`		`- if let Some(header) = api_key_from_header(headers, "{{exts.x-key-param-name-lower}}") {`
	`145`	`+ if let Some(header) = api_key_from_header(headers, "{{#lambda.lowercase}}{{{keyParamName}}}{{/lambda.lowercase}}") {`
`146`	`146`	`let auth_data = AuthData::ApiKey(header);`
`147`	`147`	`let context = context.push(Some(auth_data));`
`148`	`148`
Original file line number	Diff line number	Diff line change
`@@ -114,7 +114,7 @@ impl<T, A, B, C, ReqBody> Service<Request<ReqBody>> for AddContext<T, A>`
`114`	`114`	`{`
`115`	`115`	`use swagger::auth::api_key_from_header;`
`116`	`116`
`117`		`- if let Some(header) = api_key_from_header(headers, "") {`
	`117`	`+ if let Some(header) = api_key_from_header(headers, "api_key") {`
`118`	`118`	`let auth_data = AuthData::ApiKey(header);`
`119`	`119`	`let context = context.push(Some(auth_data));`
`120`	`120`