How to trigger debugging with Web Api

Question

Is it possible to navigate to a URL where a web api exists? My efforts suggest no, common sense says it should be. Thus, I guess I have a fault else where.

I've started VS 2015, added a new project (ASP.NET) and chose web api. I have created my api

public class DefaultController : ApiController
{
    public void Index()
    {
        //logic with break points set
    }
}

I also created a 'normal' MVC controller and as such, when I start the project, my web browser shows me the Index file in my Home controller.

Now, I want to navigate to the associated URL of my web api The URL I have for my Home controller (Index view) is

http://localhost:61895/

Therefore my api should be (I think)

http://localhost:61895/api/default/

but I see the following in the browser

HTTP 404. The resource you are looking for (or one of its dependencies) could have been removed, had its name changed, or is temporarily unavailable. Please review the following URL and make sure that it is spelled correctly.

And my WebApiConfig is

public static class WebApiConfig
{
    public static void Register(HttpConfiguration config)
    {
        // Web API configuration and services

        // Web API routes
        config.MapHttpAttributeRoutes();

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

edit

I also tried localhost:61895/api/Default/Index but the same issue

How do I debug my API in Visual Studio

I think you may be looking for localhost:61895/api/Default/Index as the URL. — Martin Noreke
– Martin Noreke, Commented Sep 5, 2015 at 12:43

Alan Tsai · Accepted Answer · 2015-09-05 14:20:49Z

3

The way Web Api works on the routing is different to Mvc Controller.

There is no action part in web api.

The http action have to match the Beginning of the Action or the Attribute. For Example:

public class DefaultController : ApiController
{
    public void GetIndex()
    {
        //logic with break points set
    }
}

or

public class DefaultController : ApiController
{
    [HttpGet]
    public void Index()
    {
        //logic with break points set
    }
}

The the url will be

localhost:61895/api/Default

There is a good example at asp.net:

http://www.asp.net/web-api/overview/web-api-routing-and-actions/routing-in-aspnet-web-api

edit

add some screen shot. I create a new web api project, and create new controller default:

public class DefaultController : ApiController
{
    public void GetIndex()
    {
        var a = "a";
    }
}

Then my url:

http://localhost:4349/api/default

as you can see the break point get hit.

As per discussion in comments, the issue was the Global.asax.cs file

The order matters, and must in the following order

 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);
    }
}

GlobalConfiguration.Configure(WebApiConfig.Register);

has to be before

RouteConfig.RegisterRoutes(RouteTable.Routes);

edited Sep 5, 2015 at 14:20

answered Sep 5, 2015 at 12:50

Alan Tsai

2,5251 gold badge15 silver badges16 bronze badges

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

17 Comments

MyDaftQuestions Over a year ago

So, how do I debug the code in visual studio? +1 as this is clear :)

Alan Tsai Over a year ago

@MyDaftQuestions Put the break point in the begging of GetIndex() method (like you would do in any other application), and run VS in debug mode. Then navigate to the url, then it should stop at the break point

MyDaftQuestions Over a year ago

I added the extra GetIndex and added the [HttpGet] to my original Index method - I then navigate to localhost:61895/api/Default - it doesn't help

Alan Tsai Over a year ago

@MyDaftQuestions you dont need both. just either one with [HttpGet] or one called GetIndex

MyDaftQuestions Over a year ago

I tried with [HttpGet] and my original Index, and then I removed this and tried only with GetIndex (and no attribute). Same issue

|

Collectives™ on Stack Overflow

How to trigger debugging with Web Api

1 Answer 1

edit

17 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

edit

17 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related