Skip to content

Commit 51e6709

Browse files
committed
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.
1 parent 4f8d8ca commit 51e6709

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

src/SimpleAuthentication.Swashbuckle/SwaggerExtensions.cs

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -118,14 +118,18 @@ static void CheckAddApiKey(SwaggerGenOptions options, IConfigurationSection sect
118118

119119
if (!string.IsNullOrWhiteSpace(settings.HeaderName))
120120
{
121-
AddSecurityDefinition(options, $"{settings.SchemeName} in Header", SecuritySchemeType.ApiKey, null, ParameterLocation.Header, settings.HeaderName, "Insert the API Key");
122-
AddSecurityRequirement(options, $"{settings.SchemeName} in Header");
121+
var schemeName = $"{settings.SchemeName}-Header";
122+
123+
AddSecurityDefinition(options, schemeName, SecuritySchemeType.ApiKey, null, ParameterLocation.Header, settings.HeaderName, "Insert the API Key");
124+
AddSecurityRequirement(options, schemeName);
123125
}
124126

125127
if (!string.IsNullOrWhiteSpace(settings.QueryStringKey))
126128
{
127-
AddSecurityDefinition(options, $"{settings.SchemeName} in Query String", SecuritySchemeType.ApiKey, null, ParameterLocation.Query, settings.QueryStringKey, "Insert the API Key");
128-
AddSecurityRequirement(options, $"{settings.SchemeName} in Query String");
129+
var schemeName = $"{settings.SchemeName}-QueryString";
130+
131+
AddSecurityDefinition(options, schemeName, SecuritySchemeType.ApiKey, null, ParameterLocation.Query, settings.QueryStringKey, "Insert the API Key");
132+
AddSecurityRequirement(options, schemeName);
129133
}
130134
}
131135

0 commit comments

Comments
 (0)