Web-Api versioning with URL c#

Question

I'm struggling for days now, i'm trying to achieve my API to version with the url suffix. f.e. http://localhost/api/v1/sites & http://localhost/api/v2/sites.

I was pretty close I guess but suddenly I messed it all up..

Many thanks for helping me out.

Now i'm receiving: "System.invalidOperationException:' The constraint type 'ApiVersionRouteConstraint' which is mapped to constraint key 'apiVersion' must implement the IhttpRouteConstraint interface.' on Global.asax.cs

Global.asax.cs

using System.Web.Http;
using System.Web.Mvc;
using System.Web.Optimization;
using System.Web.Routing;

namespace HIDDEN
{
    public class WebApiApplication : System.Web.HttpApplication
    {
        protected void Application_Start()
        {
            AreaRegistration.RegisterAllAreas();
            GlobalConfiguration.Configure(WebApiConfig.Register);
            FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
            RouteConfig.RegisterRoutes(RouteTable.Routes);
            BundleConfig.RegisterBundles(BundleTable.Bundles);
        }
    }
}

WebApiConfig.cs

using Microsoft.AspNetCore.Mvc.Routing;
using Microsoft.Owin.Security.OAuth;
using System.Web.Http;
using System.Web.Http.Routing;

namespace HIDDEN
{
    public static class WebApiConfig
        {
        public static void Register(HttpConfiguration config)
        {
            // Web API configuration and services  
            // Configure Web API to use only bearer token authentication.  
            config.SuppressDefaultHostAuthentication();
            config.Filters.Add(new HostAuthenticationFilter(OAuthDefaults.AuthenticationType));

            var contraintResolver = new DefaultInlineConstraintResolver()
            {
                ConstraintMap =
                {
                    ["apiVersion"] = typeof(ApiVersionRouteConstraint)
                }
            };

            // Web API routes  
            config.MapHttpAttributeRoutes(contraintResolver);
            config.AddApiVersioning(o =>
            {
                o.AssumeDefaultVersionWhenUnspecified = true;
                //o.DefaultApiVersion = new ApiVersion(1, 0);
            });

            config.Routes.MapHttpRoute(
                name: "DefaultApi",
                //routeTemplate: "api/v{version:apiVersion}/{controller}/{id}",
                routeTemplate: "api/v{version:apiVersion}/{controller}",
                //routeTemplate: "api/{controller}/{id}",
                defaults: new { id = RouteParameter.Optional }
            );

            // WebAPI when dealing with JSON & JavaScript!  
            // Setup json serialization to serialize classes to camel (std. Json format)  
            var formatter = GlobalConfiguration.Configuration.Formatters.JsonFormatter;
            formatter.SerializerSettings.ContractResolver = new     Newtonsoft.Json.Serialization.CamelCasePropertyNamesContractResolver();

            // Adding JSON type web api formatting.  
            config.Formatters.Clear();
            config.Formatters.Add(formatter);

        }
    }
}

RouteConfig.cs

using System.Web.Mvc;
using System.Web.Routing;


namespace HIDDEN
{
    public class RouteConfig
    {
        public static void RegisterRoutes(RouteCollection routes)
        {
            routes.IgnoreRoute("{resource}.axd/{*pathInfo}");

            routes.MapRoute(
                name: "Default",
                url: "{controller}/{action}/{id}",
                defaults: new { controller = "Home", action = "Index", id = UrlParameter.Optional }
            );
        }
    }
}

SitesController

using FirebirdSql.Data.FirebirdClient;
using System;
using System.Web.Http;
using System.Configuration;
using System.Collections;
using Microsoft.Web.Http;

        namespace HIDDEN.Controllers.V1
        {
        [ApiVersion("1.0")]
        [Route("api/v{version:apiVersion}/[controller]")]

        public class SitesController : ApiController
        {
              //code for V1
        }

        namespace HIDDEN.Controllers.V2
        {
        [ApiVersion("2.0")]
        [Route("api/v{version:apiVersion}/[controller]")]

        public class SitesController : ApiController
        {
              //code for V2
        }
    }

What is the advantage of setting up API versioning attributes into the pipeline and specifying ApiVersion on every controller (which is using attribute routing), when you can do [Route("api/v2/[controller]")] anyway? Does it add other functionality in somewhere else? — Craig H
– Craig H, Commented Oct 18, 2019 at 13:02
Hi Craig, so I could just leave [Route("api/v{version:apiVersion}/[controller]")] out of the controller? — Gregory
– Gregory, Commented Oct 18, 2019 at 13:35
@CraigH - yes, there is additional functionality. API Versioning provides a comprehensive framework for versioning policies, discovery, documentation, and so on. Using the literal string v2 will be unknown to API versioning as it does not allow, use, or parse magic strings. The {version:apiVersion} route parameter defines the name version, which uses the ApiVersionRouteConstraint. This is how API versioning knows where to extract the value from. — Chris Martinez
– Chris Martinez, Commented Feb 24, 2020 at 22:13

Hasta Tamang · Accepted Answer · 2019-10-18 14:14:11Z

4

Make sure you are using the correct ApiVersionRouteConstraint as there seems to be a conflict between Microsoft.AspNetCore.Mvc.Routing and Microsoft.Web.Http.Routing

If you are using this versioning library Microsoft.AspNet.WebApi.Versioning you should use Microsoft.Web.Http.Routing

using Microsoft.Web.Http.Routing;

In addition you can also add apiVersion constraints to your routes like below

config.Routes.MapHttpRoute(
                name: "DefaultApi",
                routeTemplate: "api/v{apiVersion}/{controller}/{action}/{id}",
                defaults: new { id = RouteParameter.Optional },
                constraints: new { apiVersion = new ApiVersionRouteConstraint() }
);

edited Oct 18, 2019 at 14:14

answered Oct 18, 2019 at 11:13

Hasta Tamang

2,2981 gold badge20 silver badges17 bronze badges

Sign up to request clarification or add additional context in comments.

10 Comments

Gregory Over a year ago

Thanks Hasta, corrected as you suggested. But still receiving 'System.invalidOperationException'.

Hasta Tamang Over a year ago

Could you confirm that you are using x.x.WebApi.Versioning if so do you have using Microsoft.Web.Http.Routing; in you WebApiConfig?

Gregory Over a year ago

Hi Hasta, Check out the code above, as you can see 'using System.Web.Http.Routing' when attempting to use Microsoft.Web.Http.Routing i'm getting a new error: 'ApiVersionRouteConstraint' is an ambiguous reference between 'Microsoft.Web.Http.Routing.ApiVersionRouteConstraint' and 'Microsoft.AspNetCore.Mvc.routing.ApiVersionRouteConstraint.

Hasta Tamang Over a year ago

I believe that is your issue. Use Microsoft.Web.Http.Routing instead.

Gregory Over a year ago

When trying 'using Microsoft.Web.Http.Routing' then DefaultInlineConstraintResolver is no longer working 'Missing assembly reference'

|

Ahmed Msaouri · Accepted Answer · 2019-10-18 11:24:45Z

1

I think you don't have well configured ASP.Net Web API Versioning

http://www.intstrings.com/ramivemula/articles/asp-net-web-api-versioning/

You can look at this post, you might have some property without the correct configuration such as:

ReportApiVersions = true;

answered Oct 18, 2019 at 11:24

Ahmed Msaouri

3161 silver badge10 bronze badges

3 Comments

Gregory Over a year ago

Hi Ahmed, will this approach work? Since 'Api-version' will not be provided in the request parameters. (only in URL)

Chris Martinez Over a year ago

@Gregory - yes, this will work. API Versioning doesn't care where the API version is requested when reporting API versions. All API version information is discovered and cached upfront. If you think about it, it has to do this in order to make a decision from the candidate actions. Matching a candidate does require reading one or more request sources that contain the incoming API version. Once a match is made, all other candidates are already known and their API versions can be reported if so configured.

Eduardo Brites Over a year ago

The link you provide on your answer is dead

Gregory · Accepted Answer · 2019-10-22 00:34:42Z

1

Fixed it, biggest problem was the different versions of the controller being in a different namespace.

This did the trick:

 namespace HIDDEN.Controllers.Sites
 {
     [Authorize]
     [ApiVersion("1.0")]
     [Route("v{version:apiVersion}/sites")]   
     public class valuesV1Controller : ApiController
     {
         // GET: api/values
         public IEnumerable<string> Get()
         {
             return new string[] { "value1", "value2" };
         }
     }

     [Authorize]
     [ApiVersion("2.0")]
     [ApiVersion("2.1")]
     [Route("v{version:apiVersion}/sites")]
     public class valuesV2Controller : ApiController
     {
         // GET: api/values
         public IEnumerable<string> Get()
         {
             return new string[] { "value3", "value4" };
         }
     }
 }

answered Oct 22, 2019 at 0:34

Gregory

1592 gold badges5 silver badges14 bronze badges

2 Comments

Chris Martinez Over a year ago

While this might the accepted answer, I'll add that namespaces are not an issue. Controllers may have the same type name in different namespaces. The Version By Namespace example in the API Versioning repo demonstrates one way of setting it up.

Chris Martinez Over a year ago

Another thing to mention is that the original question uses the [controller] token, but I believe that is only supported in ASP.NET Core route templates. This question and thread is for ASP.NET Web API. I'll also reiterate that mixing routing styles (convention-based vs attribute-based) can make troubleshooting difficult. I strongly recommend choosing one method or the other. There are edge cases where API Versioning will not work properly in Web API if you mix the two.

Abdul Rauf · Accepted Answer · 2019-10-21 12:53:21Z

-3

You can use swagger for better api documentation also for api versioning.

answered Oct 21, 2019 at 12:53

Abdul Rauf

211 silver badge6 bronze badges

1 Comment

Mubashar Shahzad Over a year ago

Your answer is not related to the question being asked. Please read the question first and then add your answer. or better write comments if anything is not clear.

Collectives™ on Stack Overflow

Web-Api versioning with URL c#

4 Answers 4

10 Comments

3 Comments

2 Comments

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

10 Comments

3 Comments

2 Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related