Skip to content

Added API versioning extensions for .NET 5 applications #212

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jamesmcroft merged 1 commit into from
Jan 30, 2022
Merged

Added API versioning extensions for .NET 5 applications #212

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 61 additions & 0 deletions src/MADE.Web/Extensions/ApiVersioningExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
// MADE Apps licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.

#if NET5_0
namespace MADE.Web.Extensions
{
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.Versioning;
using Microsoft.Extensions.DependencyInjection;

/// <summary>
/// Defines a collection of extensions for API versioning.
/// </summary>
public static class ApiVersioningExtensions
{
/// <summary>
/// Adds request API versioning for controllers and APIs to the specified services collection.
/// </summary>
/// <param name="services">The <see cref="IServiceCollection">services</see> available in the application.</param>
/// <param name="defaultMajor">The default major version of the API. Default, 1.</param>
/// <param name="defaultMinor">The default minor version of the API. Default, 0.</param>
/// <returns>The configured <paramref name="services"/> object.</returns>
public static IServiceCollection AddApiVersionSupport(this IServiceCollection services, int defaultMajor = 1, int defaultMinor = 0)
{
services.AddVersionedApiExplorer(options => options.GroupNameFormat = "'v'VVV");

services.AddApiVersioning(options =>
{
options.DefaultApiVersion = new ApiVersion(defaultMajor, defaultMinor);
options.AssumeDefaultVersionWhenUnspecified = true;
options.ReportApiVersions = true;
});

return services;
}

/// <summary>
/// Adds request header API versioning for controllers and APIs to the specified services collection.
/// </summary>
/// <param name="services">The <see cref="IServiceCollection">services</see> available in the application.</param>
/// <param name="apiHeaderName">The name of the header that is required when making requests to API endpoints. Default, x-api-version.</param>
/// <param name="defaultMajor">The default major version of the API. Default, 1.</param>
/// <param name="defaultMinor">The default minor version of the API. Default, 0.</param>
/// <returns>The configured <paramref name="services"/> object.</returns>
public static IServiceCollection AddApiVersionHeaderSupport(this IServiceCollection services, string apiHeaderName = "x-api-version", int defaultMajor = 1, int defaultMinor = 0)
{
services.AddVersionedApiExplorer(options => options.GroupNameFormat = "'v'VVV");

services.AddApiVersioning(options =>
{
options.DefaultApiVersion = new ApiVersion(defaultMajor, defaultMinor);
options.AssumeDefaultVersionWhenUnspecified = true;
options.ReportApiVersions = true;
options.ApiVersionReader = new HeaderApiVersionReader(apiHeaderName);
});

return services;
}
}
}
#endif
4 changes: 4 additions & 0 deletions src/MADE.Web/MADE.Web.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,8 @@
<PackageReference Include="Newtonsoft.Json" Version="13.0.1" />
</ItemGroup>

<ItemGroup Condition="'$(TargetFramework)'=='net5.0'">
<PackageReference Include="Microsoft.AspNetCore.Mvc.Versioning" Version="5.0.0" />
<PackageReference Include="Microsoft.AspNetCore.Mvc.Versioning.ApiExplorer" Version="5.0.0" />
</ItemGroup>
</Project>