Getting Started With ASP.NET Web API – Part One

ASP.NET Web API

ASP.NET Web API is a framework which provides manageable resource oriented services for building HTTP RESTful (Representational State Transfer) services in a convenient way. Web API is an attractive solution for testing, managing, hosting, developing, and consuming HTTP (Hypertext Transfer Protocol) based services using the ASP.NET. ASP.NET Web API uses the full features of HTTP such as request/response headers, URIs, versioning, and content formats, as well as Web API supports MVC features including routing, Action Results, model binder, dependency injection and more.

Why does Web API stand alone?

Web API allows us to build HTTP Services. Today in this world most devices use the internet, which could be Web browsers, mobile devices (including Windows phone, apple, Androids), PCs, and laptops, and all of these require Web API Services. ASP.NET Web API can be used in conjunction with the ASP.NET Web Forms, ASP.NET MVC and WCF HttpBinding.

Features of Web API

• Web API is built on top of the ASP.NET platform.
  
  
• It is interoperable with other ASP.NET toolkits such as Web Forms and MVC.
  
  
• It uses support of ASP.NET Routing ad which enables us to build routes to our API.
  
  
• Strongly typed HTTP Request/Response.
  
  
• It uses NEW HTTPClient class that allows us to build HTTP Client side application.

HTTP Method and Operations

Let’s create a project for Web API. Open Visual Studio 2013, go to New and choose Project.

So select a template. I’m going to create a Web API, so select a Web API template from the list of templates. Click on the ok button to create a Web API project including MVC features.

Your project is ready for use. You’re familiar with MVC, and lots of features in Web API are similar to MVC. I’m not saying that Web API and MVC features are exactly the same but as an ASP.NET MVC developer you can definitely differentiate between both of them.

How does MVC request Work?

To find this expand App_Start folder from the solution Explorer and select RouteConfig.cs file. You can find MVC default route under this file. When request comes to MVC it takes a URL and parses the first three segments of the URL so the first segment is controller, and then we have the action which finds the method inside this controller, and finally we have a default or optional ID parameter here.

How does Web API request Work?

Just like MVC Routeconfig file, we have WebApiConfig.cs file for the Web API. In the AppStart folder you can find that file. So just like in RouteConfig file, we have the default Web API route in the Web API. Web API routes prefix with api, and we can choose this name as anything like inverse API, Facebook API or whatever is our requirement. With the prefix api we also have controller and Id as well, the thing is that we don’t have actions here, the reason behind that is the Actions are HTTP methods and depending on the client request, for example if you have get request, then get() method would be called; if you have post request, then post() method would called.

routeTemplate: "api/{controller}/{id}",

Now go to your Web API controller and open the controller folder where you can find the Values Controller and click on it. In MVC if we want to call something then we have to use MVC controller, on the other hand, in Web API, if we want to call something we’re using API Controller.

So in API controller action methods are actually HTTP methods such as Get, Post, Put, Delete.

The figure shows that API Controller has four HTTP methods.

In the Values controller I'm going to make some changes inside the Get() method.

Run the application by pressing Ctrl+F5. I’ve put api as a prefix here and our controller name is Values controller.

So look into our output, we get xml representation of my string array.

Let’s try to create something more interesting, in this article I'm going with only Get() method. I need to create a model class. So just go to Models folder in the solution and right click on it and choose a New Item.

Go to Code panel and choose a class from the list; give an appropriate name for your class and click onto “Add” button.