MVC Routes within WebAPI controller

Question

Quick question regarding routes within MVC and WebAPI. I have added a route to route config.cs:

        routes.MapRoute(
            name: "ConfirmEmail",
            url: "ConfirmEmail/{userid}",
            defaults: new { controller = "Email", action = "ConfirmEmail" }
        );

This is registered in the global.asax as per normal:

RouteConfig.RegisterRoutes(RouteTable.Routes);

I am trying to generate a URL for use within an email which is sent as part of a function call within a WebAPI controller function. I am using the UrlHelper.Link function to attempt to generate a URL, however I receive an error saying the route cannot be found by name:

var url = Url.Link("ConfirmEmail", new { userid = "someUserId" });

Now I was under the impression route dictionaries were shared in both MVC and WebAPI controller contexts however I cannot see the MVC routes within the route dictionary of the incoming Web API call (on the Request object) however the WebAPI routes I have defined are there.

Am I missing something?

Owre · Accepted Answer · 2015-09-01 11:20:51Z

11

Here is a much more cleaner way to generate links to MVC routes from WebApi. I use this method in a custom base api controller.

protected string MvcRoute(string routeName, object routeValues = null)
{
    return new System.Web.Mvc.UrlHelper(System.Web.HttpContext.Current.Request.RequestContext)
       .RouteUrl(routeName, routeValues, System.Web.HttpContext.Current.Request.Url.Scheme);

}

answered Sep 1, 2015 at 11:20

Owre

5615 silver badges15 bronze badges

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

1 Comment

shaun Over a year ago

Worked like a charm for me.

Graham Whitehouse · Accepted Answer · 2015-03-20 10:47:32Z

Using Richards hint of where to find the routes, I have put together the following function:

    // Map an MVC route within ApiController
    private static string _MvcRouteURL(string routeName, object routeValues)
    {
        string mvcRouteUrl = "";

        // Create an HttpContextBase for the current context, used within the routing context
        HttpContextBase httpContext = new System.Web.HttpContextWrapper(HttpContext.Current);

        // Get the route data for the current request
        RouteData routeData = HttpContext.Current.Request.RequestContext.RouteData;

        // Create a new RequestContext object using the route data and context created above
        var reqContext = new System.Web.Routing.RequestContext(httpContext, routeData);

        // Create an Mvc UrlHelper using the new request context and the routes within the routing table
        var helper = new System.Web.Mvc.UrlHelper(reqContext, System.Web.Routing.RouteTable.Routes);

        // Can now use the helper to generate Url for the named route!
        mvcRouteUrl = helper.Action(routeName, null, routeValues, HttpContext.Current.Request.Url.Scheme);

        return mvcRouteUrl;
    }

It's a bit raw but did the job for me, just thought I'd put this here in case anyone else had the same problem!

Richard · Accepted Answer · 2015-03-19 16:42:10Z

1

The routing tables for MVC and Web API are completely different. While the syntax looks similar, the route table they operate on is different.

However, MVC uses static objects for configuration, so you can access the global MVC route table from within an API controller using System.Web.Routing.RouteTable.Routes.

This won't allow you to use Url.Link however, so I would suggest using a constant within your route registration for the format.

answered Mar 19, 2015 at 16:42

Richard

30.7k12 gold badges79 silver badges121 bronze badges

1 Comment

Graham Whitehouse Over a year ago

Yep, thought that was the case... Interestingly you can generate a web api URL within an MVC view using the routing tables... Oh well!

Collectives™ on Stack Overflow

MVC Routes within WebAPI controller

3 Answers 3

1 Comment

Comments

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

1 Comment

Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related