From 51e6709b3ed4f10fda3602b707c31334aef4a27e Mon Sep 17 00:00:00 2001 From: Marco Minerva Date: Thu, 19 Jun 2025 12:15:56 +0200 Subject: [PATCH] Refactor Swagger API key security definitions Updated the naming convention for security definitions and requirements in Swagger configuration. The scheme names now append "-Header" or "-QueryString" for improved clarity and consistency. --- .../SwaggerExtensions.cs | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/src/SimpleAuthentication.Swashbuckle/SwaggerExtensions.cs b/src/SimpleAuthentication.Swashbuckle/SwaggerExtensions.cs index 081e9a3..2294f81 100644 --- a/src/SimpleAuthentication.Swashbuckle/SwaggerExtensions.cs +++ b/src/SimpleAuthentication.Swashbuckle/SwaggerExtensions.cs @@ -118,14 +118,18 @@ static void CheckAddApiKey(SwaggerGenOptions options, IConfigurationSection sect if (!string.IsNullOrWhiteSpace(settings.HeaderName)) { - AddSecurityDefinition(options, $"{settings.SchemeName} in Header", SecuritySchemeType.ApiKey, null, ParameterLocation.Header, settings.HeaderName, "Insert the API Key"); - AddSecurityRequirement(options, $"{settings.SchemeName} in Header"); + var schemeName = $"{settings.SchemeName}-Header"; + + AddSecurityDefinition(options, schemeName, SecuritySchemeType.ApiKey, null, ParameterLocation.Header, settings.HeaderName, "Insert the API Key"); + AddSecurityRequirement(options, schemeName); } if (!string.IsNullOrWhiteSpace(settings.QueryStringKey)) { - AddSecurityDefinition(options, $"{settings.SchemeName} in Query String", SecuritySchemeType.ApiKey, null, ParameterLocation.Query, settings.QueryStringKey, "Insert the API Key"); - AddSecurityRequirement(options, $"{settings.SchemeName} in Query String"); + var schemeName = $"{settings.SchemeName}-QueryString"; + + AddSecurityDefinition(options, schemeName, SecuritySchemeType.ApiKey, null, ParameterLocation.Query, settings.QueryStringKey, "Insert the API Key"); + AddSecurityRequirement(options, schemeName); } }