ASP.NET Web API 2 custom routing to specific method

Question

How can I configure routing in ASP.NET Web API to route it to specific method in controller with GET method?

Registration in WebAPiConfig looks like this:

    config.MapHttpAttributeRoutes();

    config.Routes.MapHttpRoute(
        name: "HealthCheck",
        routeTemplate: "healthcheck",
        defaults: new { action =" DefaultAction" }
    );

The controller looks like this:

[RoutePrefix("healthcheck")]
public class HealthCheckController : ApiController
{
    [HttpGet]
    [ActionName("DefaultAction")]
    public HttpResponseMessage GetHealthCheckStatus()
    {
        return Request.CreateResponse(HttpStatusCode.OK);
    }    
}

I get Not Found instead of Ok when hitting that URL. Any help would be appreciated

UPDATE Thank you for all the suggestions, I checked them all and none works. The route debugger shows no matches. I am putting this on hold for a while.

peco · Accepted Answer · 2017-09-14 07:12:54Z

2

In your Startup.cs register attribute routes:

config.MapHttpAttributeRoutes();

And in the controller:

[RoutePrefix("healthcheck")]
public class HealthCheckController : ApiController
{
    [HttpGet]
    [Route]
    public IHttpActionResult GetHealthCheckStatus()
    {
        return Ok();
    }
}

answered Sep 14, 2017 at 7:12

peco

4,0001 gold badge23 silver badges27 bronze badges

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

5 Comments

Boris Modylevsky Over a year ago

Thank you for your answer but it still does not work.

peco Over a year ago

Did you remove the HealthCheck-route from the HttpRouteCollection ?

Boris Modylevsky Over a year ago

Do you mean "config.Routes.MapHttpRoute( name: "HealthCheck" ... ) ? Yes I did. It did not help

peco Over a year ago

Ok, weird. Works here :I

Boris Modylevsky Over a year ago

After having a lunch break, it started working. Thanks a lot!

Ghulam Mohayudin · Accepted Answer · 2017-09-14 07:32:01Z

2

Remove this in config

config.Routes.MapHttpRoute(
    name: "HealthCheck",
    routeTemplate: "healthcheck",
    defaults: new { action =" DefaultAction" }
);

and do this in controller

public class HealthCheckController : ApiController
{
    [AcceptVerbs("GET")]
    [Route("healthcheck")]
    public HttpResponseMessage GetHealthCheckStatus()
    {
        return Request.CreateResponse(HttpStatusCode.OK);
    }
}

edited Sep 14, 2017 at 7:32

answered Sep 14, 2017 at 7:26

Ghulam Mohayudin

1,11310 silver badges20 bronze badges

2 Comments

Boris Modylevsky Over a year ago

Thank you for your answer. But it did not help

Ghulam Mohayudin Over a year ago

There might be some problem with your configrations \

3615 · Accepted Answer · 2017-09-14 07:32:37Z

1

I haven't tested it for web-api, but tested it for MVC, I think it should work the same.

In route registration you should ensure, that this route comes before the standard api route, because route order matters:

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

        routes.MapRoute(
            "HealthCheck",
            "healthcheck",
            new {Controller = "Default", action = "Index"}
        );

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

In the controller you may not prefix the controllers and action names, but to specify correct controller name and action name in the template:

public class DefaultController : Controller
{

    [HttpGet]
    public ActionResult Index()
    {
        return Content("I'm hit");
    }
}

If you still having problems, then you can read this article and enable route debugging too see which route is invoked and what are the params.

answered Sep 14, 2017 at 7:32

3615

3,8853 gold badges22 silver badges38 bronze badges

1 Comment

3615 Over a year ago

Probably there is something else wrong in your project that makes routing go wild. I would suggest you to create a small project and check if you can reproduce the issue you have described there. If yes - put it here, if no - check what's different in your code.

Nkosi · Accepted Answer · 2017-09-14 10:12:21Z

1

Since you are enabling attribute routing, you can specify the action as the default endpoint for the controller using RoutePrefix by using [Route("")] with empty route template.

[RoutePrefix("healthcheck")]
public class HealthCheckController : ApiController {
    [HttpGet]
    [Route("")] // Matches GET http://mysite/healthcheck
    public IHttpActionResult GetHealthCheckStatus() {
        return Ok();
    }
}

With the above then there would be no need for the convention-based HealthCheck route from the OP. It can be removed safely from WebApiConfig

answered Sep 14, 2017 at 10:12

Nkosi

249k38 gold badges472 silver badges506 bronze badges

Collectives™ on Stack Overflow

ASP.NET Web API 2 custom routing to specific method

4 Answers 4

5 Comments

2 Comments

1 Comment

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

5 Comments

2 Comments

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Related