Skip to main content

ASP.NET Core Web API Versioning


Introduction:

An iteration and evolutionary changes of an ASP.NET Core Web API is handled by Versioning. Versioning of an API gives confidence to the clients which consumes API for a long time. Any changes or development of an API will be accessible using the new version and it won't cause issues to the clients consuming the old version of API.

When To Use Versioning:

  • Any API response changes.
  • Developing an API by implementing testing levels like 'Alpha', 'Beta', and 'RC' versions before releasing Production.
  • Deprecating an API which means API going to be removed or upgraded by a version within a short period.

Versioning Types:

  • Query String Versioning
  • Url Path Versioning
  • Media Type Versioning

API Version Nuget:

To Configure versioning to AspNet Core Web API Microsoft provided a library(Microsoft.AspNetCore.Mvc.Versioning). So to use the versioning library please install NuGet below.

            Install-Package Microsoft.AspNetCore.Mvc.Versioning -version 4.0.0

Register API Versioning:

Let's get started hands-on API Versioning, create the ASP.NET Core Web API project and install versioning NuGet package mentioned above. The primary step to get started with the version need to register the versioning service in the startup of our application. To do that go to  'Startup.cs' and configure versioning service as below.

public void ConfigureServices(IServiceCollection services)
{
 services.AddControllers();
 services.AddApiVersioning();
}

Register ApiVersion Attribute On A Controller:

'ApiVersion' is an attribute that takes a version number as an input parameter. Register this attribute on top of the controller to label the version to that endpoint. We can Register multiple versions on top of the controller and need to map the version to a specific action method in it.

[ApiVersion("1.0")]
[Route("api/[controller]")]
[ApiController]
public class PersonController : ControllerBase
{
 [HttpGet]
 public IActionResult Get()
 {
  var person = new { Id = 1, Name = "Naveen" };
  return Ok(person);
 }
}
We created a sample person web API endpoint and decorated the controller with '[ApiVersion("1.0")]'. Let's test this endpoint using the query parameter 'api-version'. Now Navigate to the URL 'https://localhost:44306/api/person?api-version=1.0'.

Resolve ApiVersionUnspecified Issue:

All AspNet Core APIs might not build with versioning from the beginning. If Core API with no versioning used by other clients, later the core API implements  versioning now all the existing clients try to consume API without a version number in the URL, then API fails and returns an error message like 'An API version is required but was not specified.' 
We can understand that calling AspNet Core Web API endpoints without versioning query parameter fails. This will be a problem for existing clients to work with API and it is not a great idea or solution to ask every client to ask to update their API with versioning parameter to their URL.

To Resolve 'ApiVersionUnspecified' issue our ASP.NET Core Web API versioning library provided options like 'AssumeDefaultVersionWhenUnspecified' is boolean whose value by default to false, now set that property to true to work API without version parameter. Update the 'Startup.cs' file as below.

public void ConfigureServices(IServiceCollection services)
{
 services.AddControllers();
 services.AddApiVersioning(options => {
  options.AssumeDefaultVersionWhenUnspecified = true;
 });
}
Now test the API endpoint with and without version parameter

Versioning Between Two Controllers Of Different Names:

One way of versioning Asp.Net Core Web API is to maintain an individual controller for each version. For these endpoints, let's configure attribute routing with their respective version numbers.

MonkeysController.cs:
[ApiVersion("1.0")]
[Route("monkeys")]
[ApiController]
public class MonkeysController : ControllerBase
{
 [HttpGet]
 [Route("")]
 public IActionResult Get()
 {
  var monkey = new { Id = 1, Name = "Forest Monkey" , version = "1.0" };
  return Ok(monkey);
 }
}

MonkeysV2Controller.cs:
[ApiVersion("2.0")]
[Route("monkeys")]
[ApiController]
public class MonkeysV2Controller : ControllerBase
{
 [HttpGet]
 [Route("")]
 public IActionResult Get2()
 {
  var monkey = new { Id = 1, Name = "Zoo Park Monkey", version = "2.0" };
  return Ok(monkey);
 }
}
  • 'MonkeysController' and 'MonkeysV2Controller' API created to represents versions. Both controllers were accessed by attribute routing. 
  • 'ApiVersion' attribute to represent the respective versions of the controller. 
  • 'ApiController' filter is to differentiate between MVC and Web API controllers int Asp.Net Core.
Now test the endpoint as below

If we try the above sample with convention routing, it won't work. Because in conventional based routing we need to point to the controller name while creating a route. If we try to create 2 routes with the same URL and pointing to different controllers, since conventional based routing works on order as a priority it is always going to execute the first registered controller endpoint.

So to make it works in conventional based routing we are going to use '[ControllerName("your_firstversion_controllerName")]' attribute on top of the controller. In Runtime since both controller names are the same virtually, endpoint going to work base on version number provided. Let's update the code to use conventional routing as below
MonkeysV2Controller:

[ApiVersion("2.0")]
[ControllerName("Monkeys")]
[ApiController]
public class MonkeysV2Controller : ControllerBase
{
 [HttpGet]
 public IActionResult Get()
 {
  var monkey = new { Id = 1, Name = "Zoo Park Monkey", version = "2.0" };
  return Ok(monkey);
 }
}
Update the routing in 'Startup.cs' file as below
app.UseEndpoints(endpoints =>
{
 endpoints.MapControllerRoute(
   name: "monkey_route",
   pattern: "monkeys",
   defaults: new { controller = "Monkeys", action = "Get" });
 endpoints.MapControllers();
});


Now run the application, we get a new error "controller annotated with ApiControllerAttribute must be an attributed routed"
This error clearly says that we can't use the 'ApiController' attribute because it enforces us to use the only attribute routing. So let's remove the '[ApiController]' attribute on both controllers file. Test the application again.
Again one more error showing ambiguous Match exception(matching multiple endpoints), because of dotnet core implemented in such a way can work both MVC and Web API controller in a single project. But versioning was mainly to focus on WebAPI, so to resolve this we need to expose our controller as a web API controller by registering '[ApiController]'. But using '[ApiController]' we can't use conventional routing, so this taking us loop of exceptions.

So to resolve this issue we need to change the default behavior of our versioning library, by setting a property 'UseApiBehavior' to false(This will indirectly enable versioning for MVC controllers as well).
Startup.cs:
public void ConfigureServices(IServiceCollection services)
{
 services.AddControllers();
 services.AddApiVersioning(options =>
 {
  options.UseApiBehavior = false;
  options.AssumeDefaultVersionWhenUnspecified = true;
 });
}
Now test the app again, it works perfectly with conventional based routing.

Versioning Between Two Controllers With The Same Name But Different NameSpace:

Controllers versioning differentiate by NameSpace as below.
'v1/BusController.cs':
namespace Web.API.VersioningTest1.Controllers.Buses.v1
{
    [ApiVersion("1.0")]
    [Route("api/[controller]")]
    [ApiController]
    public class BusController : ControllerBase
    {
        [HttpGet]
        [Route("")]
        public IActionResult Get()
        {
            var bus = new { Id = 1, BusType = "Sleeper Bus", Version = "1.0" };
            return Ok(bus);
        }
    }
}
'v2/BusController.cs':
namespace Web.API.VersioningTest1.Controllers.Buses.v2
{
    [ApiVersion("2.0")]
    [Route("api/[controller]")]
    [ApiController]
    public class BusController : ControllerBase
    {
        [HttpGet]
        [Route("")]
        public IActionResult Get()
        {
            var bus = new { Id = 1, BusType = "A/c Bus", Version = "2.0" };
            return Ok(bus);
        }
    }
}
Startup.cs:
public void ConfigureServices(IServiceCollection services)
{
 services.AddControllers();
 services.AddApiVersioning(options =>
 {
  options.AssumeDefaultVersionWhenUnspecified = true;
 });
}
Now run the application and test the URL with both versions

Versioning At Action Methods:

A controller can be decorated with multiple versions and Action methods in it can be decorated with the respective version number using [MapToVersion('your_version_number')]. Let's test it by creating a new example controller as below.
ChocolateController.cs:

[ApiVersion("1.0")]
[ApiVersion("2.0")]
[Route("api/[controller]")]
[ApiController]
public class ChocolateController : ControllerBase
{
 [HttpGet]
 [Route("")]
 public IActionResult Get()
 {
  var chocolate = new { Id = 1, Name = "Kit Kat", Version = "1.0" };
  return Ok(chocolate);
 }

 [HttpGet]
 [Route("")]
 [MapToApiVersion("2.0")]
 public IActionResult GetV2()
 {
  var chocolate = new { Id = 1, Name = "5 star", Version = "2.0" };
  return Ok(chocolate);
 }
}
Here controller was decorated with 2 versions and "GetV2()" action method was mapped to version "2.0" and "Get()" action method by default takes version "1.0". If you don't specify '[MapToApiVersioion("")]' to an action method when the same route is mapped to multiple action methods web API throws an error stating that 'multiple actions are matching'.
Now to work this versioning with conventional based routing update the code as below.
ChocolateController.cs:
namespace Web.API.VersioningTest1.Controllers
{
    [ApiVersion("1.0")]
    [ApiVersion("2.0")]
    public class ChocolateController : ControllerBase
    {
        [HttpGet]
        public IActionResult Get()
        {
            var chocolate = new { Id = 1, Name = "Kit Kat", Version = "1.0" };
            return Ok(chocolate);
        }

        [HttpGet]
        [ActionName("Get")]
        [MapToApiVersion("2.0")]
        public IActionResult GetV2()
        {
            var chocolate = new { Id = 1, Name = "5 star", Version = "2.0" };
            return Ok(chocolate);
        }
    }
}
[ActionName('Get')] attribute helps route to pick the action method based on the version.
Startup.cs:
app.UseEndpoints(endpoints =>
{
endpoints.MapControllerRoute(
 name: "chocolate_route",
 pattern: "chocolate",
 defaults: new { controller = "Chocolate", action = "Get" }
 );

endpoints.MapControllers();
});

public void ConfigureServices(IServiceCollection services)
{
 services.AddControllers();
 services.AddApiVersioning(options =>
 {
  options.UseApiBehavior = false;
  options.AssumeDefaultVersionWhenUnspecified = true;
 });
}

Query String Versioning:

Default versioning enabled was Query String Versioning, till now all samples are done using Query String Versioning. 'api-version' is the query parameter to pass the version number to API.

URL Path Versioning:

In this approach, the version will be part of the URL. This approach does not allow any implicit versioning like in Query String Versioning, So all endpoints need to be registered with the API version attribute explicitly.
Url Path Versioning Ex: "https://someexample.com/v1/test", "https://someexample.com/v2/test".
'v1/BusController.cs':
namespace Web.API.VersioningTest1.Controllers.Buses.v1
{
    [ApiVersion("1.0")]
    [Route("api/v{version:apiVersion}/[controller]")]
    [ApiController]
    public class BusController : ControllerBase
    {
        [HttpGet]
        [Route("")]
        public IActionResult Get()
        {
            var bus = new { Id = 1, BusType = "Sleeper Bus", Version = "1.0" };
            return Ok(bus);
        }
    }
}
'v2/BusController.cs':
namespace Web.API.VersioningTest1.Controllers.Buses.v2
{
    [ApiVersion("2.0")]
    [Route("api/v{version:apiVersion}/[controller]")]
    [ApiController]
    public class BusController : ControllerBase
    {
        [HttpGet]
        [Route("")]
        public IActionResult Get()
        {
            var bus = new { Id = 1, BusType = "A/c Bus", Version = "2.0" };
            return Ok(bus);
        }
    }
}
In the Attribute route given a placeholder like an object literal '{version: apiVersion}', this the place where our version number gets injected. Now test the application by navigating to URLs like 'https://localhost:44306/api/v1/bus' and 'https://localhost:44306/api/v2/bus'.

In the URL placeholder key-value pair, we can give any name to the key but the value must be 'apiVersion'Once try to change the object literal value an error will be shown as below

MediaType Versioning:

MediaType versioning is passing the version number along with the content-type of a web API. To use this versioning we need to need to assign 'MediaTypeApiVersionReader' to 'ApiVersionReader' in service configurations. If no version is sent API returns the latest version data. Update the code as below.
'v1/BusController.cs':

namespace Web.API.VersioningTest1.Controllers.Buses.v1
{
    [ApiVersion("1.0")]
    [Route("api/[controller]")]
    [ApiController]
    public class BusController : ControllerBase
    {
        [HttpGet]
        [Route("")]
        public IActionResult Get()
        {
            var bus = new { Id = 1, BusType = "Sleeper Bus", Version = "1.0" };
            return Ok(bus);
        }
    }
}
'v2/BusController.cs':
namespace Web.API.VersioningTest1.Controllers.Buses.v2
{
    [ApiVersion("2.0")]
    [Route("api/[controller]")]
    [ApiController]
    public class BusController : ControllerBase
    {
        [HttpGet]
        [Route("")]
        public IActionResult Get()
        {
            var bus = new { Id = 1, BusType = "A/c Bus", Version = "2.0" };
            return Ok(bus);
        }
    }
}

Startup.cs:
public void ConfigureServices(IServiceCollection services)
{
 services.AddControllers();
 services.AddApiVersioning(options =>
 {
  options.ApiVersionReader = new MediaTypeApiVersionReader();
  options.AssumeDefaultVersionWhenUnspecified = true;
  options.ApiVersionSelector = new CurrentImplementationApiVersionSelector(options);
 });
}
  • 'MediaTypeApiVersionReader' force to read the versioning from the media type. 
  • 'CurrentImplementationApiVersionSelector' Represents API version selector which selects the API version of the most current implementation of the requested service.
Now test endpoint without passing version with a media type, we can observe the latest version of API data will return
Now test endpoint with a version number along with a media type

Notify Supported And Deprecated API Versions:

It is always a better idea to show supported and deprecated API versions to the clients that are consuming the API. To make API  deprecated need pass boolean value true for version attribute and
to display the information about the versions of an API configure 'ReportApiVersion' to true at the service registration. This API Deprecation means that a particular version going to be deleted very soon.
'v1/BusController.cs':

namespace Web.API.VersioningTest1.Controllers.Buses.v1
{
    [ApiVersion("1.0",Deprecated =true)]
    [Route("api/[controller]")]
    [ApiController]
    public class BusController : ControllerBase
    {
        [HttpGet]
        [Route("")]
        public IActionResult Get()
        {
            var bus = new { Id = 1, BusType = "Sleeper Bus", Version = "1.0" };
            return Ok(bus);
        }
    }
}
Startup.cs:
public void ConfigureServices(IServiceCollection services)
{
 services.AddControllers();
 services.AddApiVersioning(options =>
 {
  options.AssumeDefaultVersionWhenUnspecified = true;
  options.ReportApiVersions = true;
 });
}
Now test endpoint

Summary:

We have implemented samples of ASP.NET Core Web API versioning. We discussed the different styles of coding versioning and different types of versioning. Discussed how to resolve the most common errors that are faced while implementing versioning. Discussed how to notify about the information about clients consuming API.

Comments

  1. Nice post. Thank you. Can you write posts on RazorPages and Xamarin

    ReplyDelete

Post a Comment

Popular posts from this blog

.NET6 Web API CRUD Operation With Entity Framework Core

In this article, we are going to do a small demo on AspNetCore 6 Web API CRUD operations. What Is Web API: Web API is a framework for building HTTP services that can be accessed from any client like browser, mobile devices, desktop apps. In simple terminology API(Application Programming Interface) means an interface module that contains a programming function that can be requested via HTTP calls to save or fetch the data for their respective clients. Some of the key characteristics of API: Supports HTTP verbs like 'GET', 'POST', 'PUT', 'DELETE', etc. Supports default responses like 'XML' and 'JSON'. Also can define custom responses. Supports self-hosting or individual hosting, so that all different kinds of apps can consume it. Authentication and Authorization are easy to implement. The ideal platform to build REST full services. Create A .NET6 Web API Application: Let's create a .Net6 Web API sample application to accomplish our

Blazor WebAssembly Custom Authentication From Scratch

In this article, we are going to explore and implement custom authentication from the scratch. In this sample, we will use JWT authentication for user authentication. Main Building Blocks Of Blazor WebAssembly Authentication: The core concepts of blazor webassembly authentication are: AuthenticationStateProvider Service AuthorizeView Component Task<AuthenticationState> Cascading Property CascadingAuthenticationState Component AuthorizeRouteView Component AuthenticationStateProvider Service - this provider holds the authentication information about the login user. The 'GetAuthenticationStateAsync()' method in the Authentication state provider returns user AuthenticationState. The 'NotifyAuthenticationStateChaged()' to notify the latest user information within the components which using this AuthenticationStateProvider. AuthorizeView Component - displays different content depending on the user authorization state. This component uses the AuthenticationStateProvider

How Response Caching Works In Asp.Net Core

What Is Response Caching?: Response Caching means storing of response output and using stored response until it's under it's the expiration time. Response Caching approach cuts down some requests to the server and also reduces some workload on the server. Response Caching Headers: Response Caching carried out by the few Http based headers information between client and server. Main Response Caching Headers are like below Cache-Control Pragma Vary Cache-Control Header: Cache-Control header is the main header type for the response caching. Cache-Control will be decorated with the following directives. public - this directive indicates any cache may store the response. private - this directive allows to store response with respect to a single user and can't be stored with shared cache stores. max-age - this directive represents a time to hold a response in the cache. no-cache - this directive represents no storing of response and always fetch the fr

A Small Guide On NestJS Queues

NestJS Application Queues helps to deal with application scaling and performance challenges. When To Use Queues?: API request that mostly involves in time taking operations like CPU bound operation, doing them synchronously which will result in thread blocking. So to avoid these issues, it is an appropriate way to make the CPU-bound operation separate background job.  In nestjs one of the best solutions for these kinds of tasks is to implement the Queues. For queueing mechanism in the nestjs application most recommended library is '@nestjs/bull'(Bull is nodejs queue library). The 'Bull' depends on Redis cache for data storage like a job. So in this queueing technique, we will create services like 'Producer' and 'Consumer'. The 'Producer' is used to push our jobs into the Redis stores. The consumer will read those jobs(eg: CPU Bound Operations) and process them. So by using this queues technique user requests processed very fastly because actually

Usage Of CancellationToken In Asp.Net Core Applications

When To Use CancellationToken?: In a web application request abortion or orphan, requests are quite common. On users disconnected by network interruption or navigating between multiple pages before proper response or closing of the browser, tabs make the request aborted or orphan. An orphan request can't deliver a response to the client, but it will execute all steps(like database calls, HTTP calls, etc) at the server. Complete execution of an orphan request at the server might not be a problem generally if at all requests need to work on time taking a job at the server in those cases might be nice to terminate the execution immediately. So CancellationToken can be used to terminate a request execution at the server immediately once the request is aborted or orphan. Here we are going to see some sample code snippets about implementing a CancellationToken for Entity FrameworkCore, Dapper ORM, and HttpClient calls in Asp.NetCore MVC application. Note: The sample codes I will show in

Part-1 Angular JWT Authentication Using HTTP Only Cookie[Angular V13]

In this article, we are going to implement a sample angular application authentication using HTTP only cookie that contains a JWT token. HTTP Only JWT Cookie: In a SPA(Single Page Application) Authentication JWT token either can be stored in browser 'LocalStorage' or in 'Cookie'. Storing JWT token inside of the cookie then the cookie should be HTTP Only. The HTTP-Only cookie nature is that it will be only accessible by the server application. Client apps like javascript-based apps can't access the HTTP-Only cookie. So if we use authentication with HTTP only JWT cookie then we no need to implement custom logic like adding authorization header or storing token data, etc at our client application. Because once the user authenticated cookie will be automatically sent to the server by the browser on every API call. Authentication API: To implement JWT cookie authentication we need to set up an API. For that, I had created a mock authentication API(Using the NestJS Se

Unit Testing Asp.NetCore Web API Using xUnit[.NET6]

In this article, we are going to write test cases to an Asp.NetCore Web API(.NET6) application using the xUnit. xUnit For .NET: The xUnit for .Net is a free, open-source, community-focused unit testing tool for .NET applications. By default .Net also provides a xUnit project template to implement test cases. Unit test cases build upon the 'AAA' formula that means 'Arrange', 'Act' and 'Assert' Arrange - Declaring variables, objects, instantiating mocks, etc. Act - Calling or invoking the method that needs to be tested. Assert - The assert ensures that code behaves as expected means yielding expected output. Create An API And Unit Test Projects: Let's create a .Net6 Web API and xUnit sample applications to accomplish our demo. We can use either Visual Studio 2022 or Visual Studio Code(using .NET CLI commands) to create any.Net6 application. For this demo, I'm using the 'Visual Studio Code'(using the .NET CLI command) editor. Create a fo

.Net5 Web API Managing Files Using Azure Blob Storage

In this article, we are going to understand the different file operations like uploading, reading, downloading, and deleting in .Net5 Web API application using Azure Blob Storage. Azure Blob Storage: Azure blob storage is Microsoft cloud storage. Blob storage can store a massive amount of file data as unstructured data. The unstructured data means not belong to any specific type, which means text or binary data. So something like images or pdf or videos to store in the cloud, then the most recommended is to use the blob store. The key component to creating azure blob storage resource: Storage Account:- A Storage account gives a unique namespace in Azure for all the data we will save. Every object that we store in Azure Storage has an address. The address is nothing but the unique name of our Storage Account name. The combination of the account name and the Azure Storage blob endpoint forms the base address for each object in our Storage account. For example, if our Storage Account is n

Different HttpClient Techniques To Consume API Calls In Minimal API[.NET6]

In this article, we are going to implement different HttpClient techniques to consume API calls in minimal API. The different HttpClient techniques that we are going to explore are like: Register HttpClient Object Explicitly In DI(Dependency Injection Service) Named Client Type Client HttpRequestMessage Object Create A .NET6 Minimal API Project: Let's create a .Net6 Minimal API sample project to accomplish our demo. We can use either Visual Studio 2022 or Visual Studio Code(using .NET CLI commands) to create any.Net6 application. For this demo, I'm using the 'Visual Studio Code'(using the .NET CLI command) editor. CLI command For Minimal API Project dotnet new webapi -minimal -o Your_Project_Name Create A Third Party API Response Model: Here I'm going to use a free third-party rest API that is "https://jsonplaceholder.typicode.com/posts". So to receive the response let's create a response model like 'Post.cs'. Program.cs:(Add Post.cs c

.Net5 Web API Redis Cache Using StackExchange.Redis.Extensions.AspNetCore Library

In this article, we are going to explore the integration of Redis cache in .Net5 Web API application using the 'StackExchange.Redis.Exntensions' library. Note:- Microsoft has introduced an 'IDistributedCache' interface in dotnet core which supports different cache stores like In-Memory, Redis, NCache, etc. It is simple and easy to work with  'IDistributedCache', for the Redis store with limited features but if we want more features of the Redis store we can choose to use 'StackExchange.Redis.Extensions'.  Click here for Redis Cache Integration Using IDistributedCache Interface . Overview On StackExchange.Redis.Extnesions Library: The 'StackExchange.Redis.Extension' library extended from the main library 'StackExchange.Redis'. Some of the key features of this library like: Default serialization and deserialization. Easy to save and fetch complex objects. Search key. Multiple Database Access Setup Redis Docker Instance: For this sampl