Pargoon.Core.ApiVersioning
9.0.0
dotnet add package Pargoon.Core.ApiVersioning --version 9.0.0
NuGet\Install-Package Pargoon.Core.ApiVersioning -Version 9.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="Pargoon.Core.ApiVersioning" Version="9.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Pargoon.Core.ApiVersioning --version 9.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Pargoon.Core.ApiVersioning, 9.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 Pargoon.Core.ApiVersioning as a Cake Addin #addin nuget:?package=Pargoon.Core.ApiVersioning&version=9.0.0 // Install Pargoon.Core.ApiVersioning as a Cake Tool #tool nuget:?package=Pargoon.Core.ApiVersioning&version=9.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
API Versioning
Enable Swagger to Explorer Versioned API for dotnet 8.0 or above
using Noyanet.Core.ApiVersioning;
.
.
.
builder.Services.AddSwaggerService(builder.Configuration);
.
.
.
var app = builder.Build();
// added showSwaggerInAllEnv parameter to allow enable swagger in all environments, it is false by default
// you can add this optional param to enable swagger in staging or production environment
app.UseSwaggerVersioned(showSwaggerInAllEnv:true);
from the version 8.0.0 we added ApiInfo class to the package which will read some data from appsettings.json if exists.
public class ApiInfo
{
public const string SectionName = "ApiInfo";
public string ApiVersion { get; set; } = string.Empty;
public string BuildNumber { get; set; } = string.Empty;
public string ApiName { get; set; } = string.Empty;
public string ApiBadge { get; set; } = string.Empty;
}
this class properties will fill from appsettings.json like below:
...
"ApiInfo": {
"ApiVersion": "1.1.0",
"BuildNumber": "1125",
"ApiName": "my sample Api",
"ApiBadge": "Api Badge"
},
...
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net9.0 is compatible. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net9.0
- Asp.Versioning.Mvc.ApiExplorer (>= 8.1.0)
- Microsoft.Extensions.Options (>= 9.0.0)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 9.0.0)
- Swashbuckle.AspNetCore (>= 7.0.0)
- Swashbuckle.AspNetCore.SwaggerGen (>= 7.0.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.