OLT.Extensions.SwaggerGen.Versioning
8.0.0
Prefix Reserved
dotnet add package OLT.Extensions.SwaggerGen.Versioning --version 8.0.0
NuGet\Install-Package OLT.Extensions.SwaggerGen.Versioning -Version 8.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="OLT.Extensions.SwaggerGen.Versioning" Version="8.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add OLT.Extensions.SwaggerGen.Versioning --version 8.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: OLT.Extensions.SwaggerGen.Versioning, 8.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 OLT.Extensions.SwaggerGen.Versioning as a Cake Addin #addin nuget:?package=OLT.Extensions.SwaggerGen.Versioning&version=8.0.0 // Install OLT.Extensions.SwaggerGen.Versioning as a Cake Tool #tool nuget:?package=OLT.Extensions.SwaggerGen.Versioning&version=8.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Builder for Swagger with Api Versioning
Good medium article https://medium.com/c-sharp-progarmming/xml-comments-swagger-net-core-a390942d3329
NOTE!!!
This package was renamed from OLT.Extensions.SwaggerGen to OLT.Extensions.SwaggerGen.Versioning due to combining it with OLT.AspNetCore.Versioning
The namespace shifted from OLT.Extensions.SwaggerGen to OLT.Extensions.SwaggerGen.Versioning
Example Code
public class Startup
{
public Startup(IConfiguration configuration, IWebHostEnvironment hostEnvironment)
{
Configuration = configuration;
HostEnvironment = hostEnvironment;
}
public IConfiguration Configuration { get; }
public IWebHostEnvironment HostEnvironment { get; }
public void ConfigureServices(IServiceCollection services)
{
var xmlPath = Path.Combine(AppContext.BaseDirectory, $"{Assembly.GetExecutingAssembly().GetName().Name}.xml");
var enableSwagger = System.Diagnostics.Debugger.IsAttached || HostEnvironment.IsDevelopment();
...
services.AddSwaggerWithVersioning(
new OltSwaggerArgs(new OltOptionsApiVersion())
.WithTitle(Title)
.WithDescription(Description)
.WithSecurityScheme(new OltSwaggerJwtBearerToken()) // Allow JWT Token to be passed via the Swagger UI
.WithSecurityScheme(new OltSwaggerApiKey()) // Allow X-API-KEY to be passed via the Swagger UI
.WithOperationFilter(new OltDefaultValueFilter())
.WithApiContact(new Microsoft.OpenApi.Models.OpenApiContact { Name = "John Doe", Url = new System.Uri("https://www.nuget.org/"), Email = "john.doe@fake-email.com" })
.WithApiLicense(new Microsoft.OpenApi.Models.OpenApiLicense { Name = "License Here", Url = new System.Uri("https://www.google.com/") })
.WithXmlComments(xmlPath) //Enabling XML comments is required for this to function
.Enable(enableSwagger);
...
}
public void Configure(IApplicationBuilder app)
{
...
app.UseSwaggerWithVersioning();
...
}
}
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. 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 is compatible. 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.
-
net6.0
- Asp.Versioning.Mvc.ApiExplorer (>= 6.4.0)
- Microsoft.Extensions.ApiDescription.Server (>= 6.0.25)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 6.0.0)
- Swashbuckle.AspNetCore (>= 6.5.0)
-
net7.0
- Asp.Versioning.Mvc.ApiExplorer (>= 7.1.0)
- Microsoft.Extensions.ApiDescription.Server (>= 7.0.14)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 7.0.0)
- Swashbuckle.AspNetCore (>= 6.5.0)
-
net8.0
- Asp.Versioning.Mvc.ApiExplorer (>= 8.0.0)
- Microsoft.Extensions.ApiDescription.Server (>= 8.0.0)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.0)
- Swashbuckle.AspNetCore (>= 6.5.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 |
---|---|---|
8.0.0 | 303 | 12/20/2023 |
8.0.0-beta-0005 | 139 | 12/10/2023 |