HLCores.Configurations.SwaggerGenConfig
1.0.0
dotnet add package HLCores.Configurations.SwaggerGenConfig --version 1.0.0
NuGet\Install-Package HLCores.Configurations.SwaggerGenConfig -Version 1.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="HLCores.Configurations.SwaggerGenConfig" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add HLCores.Configurations.SwaggerGenConfig --version 1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: HLCores.Configurations.SwaggerGenConfig, 1.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install HLCores.Configurations.SwaggerGenConfig as a Cake Addin #addin nuget:?package=HLCores.Configurations.SwaggerGenConfig&version=1.0.0 // Install HLCores.Configurations.SwaggerGenConfig as a Cake Tool #tool nuget:?package=HLCores.Configurations.SwaggerGenConfig&version=1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
HLCores.Configurations.SwaggerGenConfig
Features
- Custom service configufation registers Swagger.
Usage
SwaggerGenConfig
Define one or more documents to be created by the Swagger generator. Adding one or more "securityDefinitions" and describing how your API is protected to the generated Swagger. Adds a global security requirement.
public static void AddSwaggerGenConfiguration(this IServiceCollection services)
{
if (services == null) throw new ArgumentNullException(nameof(services));
services.AddSwaggerGen(c =>
{
c.SwaggerDoc("v1", new OpenApiInfo { Title = "API", Version = "v1" });
c.AddSecurityDefinition("Bearer", new OpenApiSecurityScheme
{
In = ParameterLocation.Header,
Description = "Please insert JWT with Bearer into field",
Name = "Authorization",
Type = SecuritySchemeType.ApiKey
});
c.AddSecurityRequirement(new OpenApiSecurityRequirement
{
{
new OpenApiSecurityScheme
{
Reference = new OpenApiReference
{
Type = ReferenceType.SecurityScheme,
Id = "Bearer"
}
},
new string[] { }
}
});
});
}
Using package Document : Swashbuckle.AspNetCore.SwaggerGen
.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net7.0 is compatible. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net7.0
- Swashbuckle.AspNetCore (>= 6.7.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
1.0.0 | 120 | 8/16/2024 |