Skip to main content

Web Api Versioning using Url Path

Why we need versioning in Api?
Once a Web API service is made public, different client applications start using your Web API services.As the business grows and requirements change, we may have to change the services as well, but the changes to the services should be done in way that does not break any existing client applications. This is when Web API versioning helps.
 There are many approaches about how should one implement the api versioning. My favorite is putting the versioning in the Url path. It has following major benefits over other approaches is that "you can change the entire relationship of entities in future versions and still continue to support the old clients".

Step 1:- Create the visual studio project (Select WebApi Project Template)

Step 2:- To Implement Api Versioning you need to add following nuget
Install-Package Microsoft.AspNet.WebApi.Versioning

Step 3:- Enable Api versioning in Configuration class
1)      Remove config.MapHttpAttributeRoutes(); from code because we implements in versioning.
2)  Add Following line of code before route table:-
      #region Enable Api versioning
            config.AddApiVersioning();
            var constraintResolver = new DefaultInlineConstraintResolver()
            {
                ConstraintMap = { ["apiVersion"] = typeof(ApiVersionRouteConstraint) }
            };
            config.MapHttpAttributeRoutes(constraintResolver);
            #endregion
Notes:-[Make sure that this line of code above route table created code otherwise versioning not work]

Step 4:- Create Controller
    [ApiVersion("1.0")]
    [Route("api/v{version:apiVersion}/helloworld")]
    public class HelloWorldController : ApiController
    {
        public string Get()
        {
            return "Hello World V1";
        }
    }

Step 5:- Run Program and type http://localhost:{PortNumber}/api/v1.0/helloworld
    Output:- "Hello World V1"

Step 6:- Copy above code in same file and rename it
    [ApiVersion("2.0")]
    [Route("api/v{version:apiVersion}/helloworld")]
    public class HelloWorld2Controller : ApiController
    {
        public string Get()
        {
            return "Hello World V2";
        }

Step 7:- Run Program and type http://localhost:{PortNumber}/api/v2.0/helloworld
    Output:- "Hello World V2"

The full code is published in git hub repository. You can git pull and use it.

Hope you like it. Stay tuned for more..
Labels:

Comments

Post a Comment

Popular posts from this blog

Understanding ASP.NET MVC Folder Structure

Following Structure of Solution Explorer  Visual Stdio 2015 display in image: Explain in Short: App_Data folder - Holds the SQL Server Compact database file. Content - Holds CSS files. Controllers - Holds controller classes. DAL folder - The data access layer.  Holds the context, initializer, repository, and unit of work classes. Logging folder - Holds code that does logging. Migrations folder - Holds EF Code First migrations code, including the Seed method. Models folder - Holds model classes. Properties or MyProject folder - Project properties. Scripts folder - Script files. ViewModels folder - Holds view model classes. Views folder - Holds view classes. Visual Studio project file (.csproj or .vbproj). Packages.config - Specifies NuGet packages included in the project. Global.asax file - Includes database initializer code. Web.config file - Includes the connection string to the database. Hope you like it. Stay...
Post a Comment
Read more

What is typescript & Its features ?

Define Typescript:- TypeScript (TS) is an open source programming language developed by Microsoft. Typescript is a superset of JavaScript which primarily provides optional static typing, classes and interfaces. What is the different static and dynamic typing? Static typing:- It's all about the variables. In statically typed program languages, if I create an integer, I have to tell the compiler that it is an integer and will always be an integer. Dynamic typing:- In dynamic languages, you don't specify the type and you can dynamically change the type. For example, to declare a variable in Javascript, you would type var bar; . If I then set it to an integer, it will work fine. bar = 5; . I can then even later set the same variable to a string, bar = "Hello World!"; and it will work fine! Hence the term dynamic. Before we start typescript lets show some ECMAScript 6 Features that help in typescript. 1.          ...
Post a Comment
Read more