Přeskočit na hlavní obsah

Versioning

Overview​

Support for common API versioning patterns.

Install​

  • ASOL.Core.Versioning - Contains RESTful API versioning conventions like ApiVersioningOptions, VersionedApiExplorerOptions, (see Semantic Versioning ). Use this package when implementing RESTful APIs.

Usage third party libraries (NuGets)​

Changelog​

  • 0.0.1.24121-dev
    • .NET 8 support
  • 0.0.1.23639-dev
  • 0.0.1.20104-dev

Dependency injection​

Mandatory dependency injection for API versioning.

/// <summary>
/// Add API version support.
/// </summary>
public static IServiceCollection AddApiVersioningWithExplorer(this IServiceCollection services, IConfiguration configuration)
{
    services.Configure<ApiVersioningOptions>(configuration.GetSection(nameof(ApiVersioningOptions)));
    services.AddApiVersioning(options =>
    {
        options.ReportApiVersions = true;
    });

    services.AddVersionedApiExplorer(options =>
    {
        options.GroupNameFormat = "'v'VVV";
        options.SubstituteApiVersionInUrl = true;
    });
    return services;
}