Explain the ASP.NET WebAPI HttpRoute plumbing

Question

I am a long-serving ASP.NET VB web forms programmer, but need to start using WebAPI to create a simple service. I've followed the PluralSight tutorial on http://www.asp.net, and have these two snippets:

HelloApiController.vb

Imports System.Web.Http

Namespace HelloWebApiDemo

    Public Class HelloApiController
        Inherits ApiController

        Public Function [Get]()
            Return "Hello from API at " & DateTime.Now.ToString
        End Function

    End Class

End Namespace

Global.asax.vb

Imports System.Web.Http
Imports System.Web.Http.Routing

Public Class Global_asax
    Inherits System.Web.HttpApplication

    Sub Application_Start(ByVal sender As Object, ByVal e As EventArgs)
        GlobalConfiguration.Configuration.Routes.Add("default", New HttpRoute("{controller}"))
    End Sub

End Class

When run, the URL for retrieving information is: http://localhost:63678/helloapi

Can anyone please explain the correlation of how "{controller}" automagically maps to the above URL? I don't see the word helloapi anywhere in the code. What if I created a second class that inherits ApiController - how would IIS differentiate between which one I wanted to access?

Also, does the method name [Get]() automatically get mapped to the respective HTTP verb? Again, what happens if I wanted to give it a different name?

Thanks.

score 2 · Accepted Answer · answered Sep 24 '13 at 11:58

2

One of the great things about web API is that it works by convention. Web API is able to route the GET request to HelloApiController by using the convention of URI path getting mapped to the class name prefix (leaving out Controller). If you have another controller, say FooController, the URI of http://server/foo is what is needed to hit your second controller.

As for the method names, it goes by HTTP verb. By default, the method names of Get and the method names starting with Get such as GetFoo is mapped to HTTP GET and so on. This can be changed. The concept of routing is very powerful and it cannot be explained here through an answer. I highly recommend Mike Wasson's getting started stuff in ASP.NET web site. Check out this and the rest of the stuff.

answered Sep 24 '13 at 11:58

Badrinarayanan Lakshmiraghavan

19,159
4
62
61

Okay thanks very much for clarifying. I'd seen Mike Wasson's tutorials but avoided them because we don't need web pages per-se as we don't require an interface for this, and so I wanted to avoid having to learn MVC and just focus on the API if possible. The API will only be accessed by an automated data export system that POSTs XML to our API. Any other tutorials would be welcome though that you can recommend though... :-) – EvilDr Sep 24 '13 at 13:32
Also is there anything on the actual `"{controller}"` code I can read into. A Google search is nearly useless because its such a common word. – EvilDr Sep 24 '13 at 13:34

Explain the ASP.NET WebAPI HttpRoute plumbing

1 Answers1