3 simple steps to create your first ASP.NET Web API service

By | September 29, 2013
Share on FacebookShare on Google+Tweet about this on TwitterShare on LinkedInDigg thisPin on Pinterest

Introduction to ASP.NET Web API

ASP.NET Web API is a framework that simplifies the creation of HTTP services

Using ASP.NET Web API we can create HTTP services those are non-SOAP based like plain XML or JSON strings etc. with added advantages.

  • Allowing to create resource-oriented services using the full features of HTTP.
  • Exposing services to a variety of clients easily like browsers or mobile devices etc.
Before diving into details while going through this ASP.NET Web API Tutorial, I would like to clarify one misconception that ASP.NET Web API has replaced WCF. WCF is still a powerful programming model for creating SOAP based services that use a variety of transport protocols like HTTP, TCP, Named Pipes or MSMQ etc. You can find the same implementation by using WCF REST in another article i.e. “5 simple steps to create your first RESTful service“.

Apart from Visual Studio 2010 or 2012, we also need MVC 4.0 to implement this HTTP service. For the purpose of this implementation, I am going to use Visual Studio 2010.
You can download MVC 4.0 for Visual Studio 2010 from Microsoft as follows:

Following are 3 simple steps to create HTTP service that returns non-SOAP based data.

  • Create Web API Project
  • Prepare domain Model
  • Adding Controller class
You are designing an ASP.NET Web API application. You need to select an HTTP verb to allow blog administrators to moderate a comment. Which HTTP verb should you use?

  • A. GET
  • B. POST
  • C. DELETE
  • D. PUT

To further test your ASP.NET Web API skill, Take a Complete FREE Online Test or MCSD Practice Exam: 70-486 (Developing ASP.NET MVC Web Applications). Simply Click Here.

 Correct Answer: D

Let’s move forward step by step to create a simple HTTP service using ASP.NET Web API.

ASP.NET Web API Tutorial with Simplified Approach

1. Create Web API Project

  • Open Visual Studio and create “New Project” i.e. File -> New Project.
  • Choose “ASP.NET MVC 4 Web Application” template and name project as “FirstWebAPIService”.
  • When you click “OK” button, a new window will appear for selecting a sub-template. Actually for ASP.NET MVC 4 Web Application, we have multiple sub-options i.e. Empty, Internet Application, Web API etc.
  • Choose “Web API” and simply press “OK” button.
ASP.NET Web API Project
Web API Tutorial Template
  • A default ASP.NET MVC 4 Web API template project is created. As its an MVC application template, so you will easily find “Model”, “View” and “Controller” folders inside it.
2. Preparing domain Model
Now in a second step in this asp.net web api tutorial, we need to prepare the model.
  • Right click on the “Model” folder and choose “Class” under “Add” from the context menu as shown in figure.
  • Name the class as “Product.cs”.
Model for Web API
Product Model
Here is the code for Product class.

3. Adding Controller Class
Controller class plays an important role, because request coming from client hits the controller first. Then the controller decides which model to use to serve the incoming request. So, in order to add a controller:

  • Right click on the “Controller” folder and choose “Controller” under “Add” from the context menu as shown in figure.
  • Name the controller as “ProductsController”.
Product Controller in Web API Tutorial
First Web API Service
  • Click the “Add” button, a new controller class will be added.
More Web API Tutorial
In order to make the things simple, we will load the model with data inside this controller instead of loading it from database. You can easily find more Web API Tutorial here that explains the process to fetch the records from database. Following is the code for controller class.
Don’t forget to add “using FirstWebAPIService.Models;” at the top of the controller class.

Now, it’s time to test your HTTP service using ASP.NET MVC Web API.
Run the application by pressing “CTRL+F5”, Welcome window will appear as follows:

Output for ASP.NET Web API Service

In order to call our Product controller, change the URL as “http://localhost:XXXX/api/products”. You will see the results as shown in following output window.

Rendered Content for Web API Service
Final output returned can be displayed differently by different browsers. Here is the output of google chrome version 29.0.1547.66.
You are working as a Web API developer with WebDevTutorials. You have developed a Student HTTP Service using ASP.NET Web API technology and you want to return a View from Web API method.

  • A. Use ViewBag.
  • B. Use Partial View against Web API method.
  • C. You can’t return view from ASP.NET Web API method.
  • D. None of Above.

To further test your ASP.NET Web API skill, Take a Complete FREE Online Test or MCSD Practice Exam: 70-486 (Developing ASP.NET MVC Web Applications). Simply Click Here.

 Correct Answer: C

Hopefully, this simple web api tutorial will be helpful for developers to code their first HTTP service using ASP.NET MVC Web API. Further, for performing all CRUD operations using Web API, Follow the click. Soon you will be able to download this ASP.NET Web API Tutorial PDF.

ASP.NET MVC & Web API Jobs [Updated Daily]

Top ASP.NET MVC Jobs

Programmer
Source: Indeed
Details: MVC:. ASP.NET MVC, ASP.NET AJAX,C#, C++, SSIS, Object Oriented Programming, T-SQL, JAVA, Telerik Controls, Javascript....  More
6 days ago

Guaynabo, PR 17-August-2017

Programmer
Source: Indeed
Details: Experience in developing web applications using ASP.NET, MVC, Javascript, JQuery. CorTrust Bank is looking for a talented programmer to create secure and...  More
12 days ago

Mitchell, SD 11-August-2017

Application Developer -- C#, ASP.NET Web Forms/MVC
Source: Indeed
Details: .NET framework (3.5 or newer) -- especially with .NET Web Services, ASP.NET MVC, ASP.NET Web Forms and LINQ. We have a fulltime programmer position open for an...  More
1 day ago

Golden Valley, MN 22-August-2017

Sr. Developer / Architect - .Net MVC Angular 4.0
Source: Indeed
Details: Net. Developer / Architect - .Net MVC Angular 4.0*. Strong knowledge and working experience of ASP.NET MVC, Angular 4.0....  More
6 days ago

Miami, FL 17-August-2017

Sr Developer / Architect - .Net MVC Angular 4.0
Source: Indeed
Details: Strong knowledge and working experience of ASP.NET MVC, Angular 4.0 2. Essential experience - ASP.Net - Angular 4.0 - MVC 4 - C# - JavaScript, JSON, JQuery,...  More
6 days ago

Atlanta, GA 17-August-2017

Sr. .Net Developer
Source: Indeed
Details: ASP.NET web forms, ASP.NET MVC, EF. ASP.NET 4.5+, Visual Studio .NET 2012+, C#, MVC 4+, Web API (REST), HTML, jQuery, JavaScript, Knockout, Angular.JS,...  More
14 days ago

Homestead, PA 09-August-2017

.NET Developer
Source: Indeed
Details: 2+ Years of web development experience with ASP.NET and MVC 5. Hands on development of proprietary and third party applications using C#, ASP.NET, MVC , SQL....  More
30+ days ago

Chicago, IL 19-May-2017

Front End Developer
Source: Indeed
Details: Full stack experience with a backend such as Node, ASP.NET MVC, or Rails. Art of Context is a boutique, interactive firm that specializes in multi-channel...  More
2 days ago

Boston, MA 21-August-2017

Lead .NET Developer
Source: OutMatch
Details: MVC and MVVM front-end design and development with frameworks such as Kendo UI, knockout.js, Angular JS or similar. Lead .NET Developer....  More
18 hours ago

Dallas, TX 75251 23-August-2017

ASP.NET MVC, C# Developer
Source: Indeed
Details: MVC:. Has an immediate opening for an MVC, C# developer. Tech stack includes:....  More
24 days ago

Springfield, IL 30-July-2017

.NET Developer- Data Structure
Source: Indeed
Details: Middle tier (ASP.NET MVC / Java). Familiar with MVC, Entity Framework, ASP.NET,. Very strong knowledge in data structures and proven record in using the best...  More
6 days ago

Redmond, WA 17-August-2017

Programmer
Source: Indeed
Details: ASP.NET MVC, JavaScript, HTML5, CSS3, and Bootstrap. Purpose of Position*....  More
30+ days ago

Plano, TX 75024 27-June-2017

Jr .Net Developer
Source: Indeed
Details: Asp.net MVC Framework 6.0, AJAX, Angular 2, Bootstrap, CSS, 3rd party controls(Mandatory). Good communication and coordination skills working in onshore and...  More
9 days ago

Seattle, WA 14-August-2017

Front End Developer with Visual Studio experience (required)
Source: Indeed
Details: We are looking for an experienced Microsoft ASP.NET MVC developer with a focus on Front End technologies that can bring their expertise, experiences and...  More
16 days ago

Dallas-Fort Worth, TX 07-August-2017

ASP.NET MVC Developer, Lead
Source: Indeed
Details: MVC:. .NET MVC Developer, eWorld Project at DOJ*. We are looking for a lead developer for the .Net MVC team on a funded project at the Department of Justice...  More
13 days ago

Falls Church, VA 10-August-2017

Systems Engineer/.Net Developer (Secret Cleared)
Source: Indeed
Details: Basic understanding of Development Languages (C#, ASP.NET, MVC, SQL Server, Java, and JavaScript, and Oracle Products....  More
30+ days ago

Randolph AFB, TX 18-July-2017

C#/Full Stack Developer
Source: Indeed
Details: Two years demonstrated experience ASP.NET MVC 5+. C#/Full Stack Developer*....  More
5 days ago

Beaverton, OR 97005 18-August-2017

Web Developer - .NET
Source: Meridian Technology Group
Details: Required technical skills include C#, ASP.NET MVC, HTML, XML, Java Script, Visual Studio, PL/SQL, GIT, SOAP Web Services, Unit Testing with NUnit or MSTest,...  More
30+ days ago

Tualatin, OR 06-July-2017

.Net Developer Jr.
Source: Pinnacle Partners
Details: Bachelor’s Degreeis a hard requirement1-3years of web development experience.ASP.NET MVC (4.0 or higher)Knowledge and experience with JavaScript, LINQ and...  More
30+ days ago

St. Louis, MO 14-July-2017

.Net Developer, Sr
Source: Pinnacle Partners
Details: Job ID: DC19496976Pinnacle Partners is assisting our client in their search for a .NETDeveloperin their expanding office in the St. Louis area. This resource  More
30+ days ago

St. Louis, MO 14-July-2017

ASP.NET MVC Developer
Source: Indeed
Details: Experience in web development with ASP.NET MVC including C#, JQuery, JavaScript, AJAX, and Entity Framework....  More
5 hours ago

Houston, TX 23-August-2017

ASP.NET MVC Developer
Source: Indeed
Details: Strong understanding of ASP.NET, C#, LINQ, MVC, IIS, SQL Server. Contribute to the architecture and development of enterprise level CMS implementations....  More
11 hours ago

Beaverton, OR 97007 23-August-2017

.Net Developer
Source: WinterWyman
Details: Experience with Microsoft ASP.NET, MVC, Web API, and C#. Are you a skilled and dynamic .Net Developer looking to join an exciting company that specializes in...  More
12 hours ago

Danvers, MA 01923 23-August-2017

.Net Web Developer
Source: Indeed
Details: Agile Development /Test Driven Development, jQuery, ASP.NET MVC, SQL Server, SharePoint, Enterprise Search technologies....  More
13 hours ago

Washington, DC 23-August-2017

.Net Developer
Source: Indeed
Details: Strong experience with C#, ASP.NET MVC 4.0/5.0, JSON, SSIS, SSRS,. Experience in design, development and maintenance of Rich User Interactive SPA using...  More
1 day ago

New York, NY 22-August-2017

Top 10 Interview Questions and Answers Series:

Share on FacebookShare on Google+Tweet about this on TwitterShare on LinkedInDigg thisPin on Pinterest
Category: ASP.NET Web API Tags: , ,

About Web Development

Imran Abdul Ghani is working as Software Developer(Senior) with extensive knowledge in Web development technologies especially C#, ASP.NET, MVC, WCF, Web API, ADO.NET Entity Framework, jQuery etc. He has several years of experience in designing/developing enterprise level applications. He is Microsoft Certified Solution Developer for .NET (MCSD.NET) since 2005. You can reach his blogging at www.webdevelopmenthelp.net, www.topwcftutorials.net, and www.sharepointfordummies.net.

  • wow…seems great

  • Really great post .. thanks sharing your topic

    website

  • Thanks very much… I m waiting for CRUD operations using Web API…. Thanks again….

  • Easy to do tutorial. Thanks mate however I am having this error when I run the program:

    This XML file does not appear to have any style information associated with it. The document tree is shown below.

    No HTTP resource was found that matches the request URI ‘http://localhost:59074/api/products’.

    No type was found that matches the controller named ‘products’.

  • Dear Abraham,
    You need to check you configuration and verify the routeTemplate as follows:
    1. Open WebAPIConfig.cs file under “App_Start” folder in Visual Studio.
    2. Inside Register method, routeTemplate value should be equal to “api/{controller}/{id}”.

    As I have the following:
    config.Routes.MapHttpRoute(
    name: “DefaultApi”,
    routeTemplate: “api/{controller}/{id}”,
    defaults: new { id = RouteParameter.Optional }
    );

  • when i try this…everything was ok till chnging url bt when i change url it land at google search page …why this??

    • Dear Nilam,
      Kindly look for my above comments on Abraham query. You might need to update routeTemplate.

      If it doesn’t resolve your issue, kindly elaborate your issue a bit more.

  • This comment has been removed by a blog administrator.

  • swapna

    i am getting error as MvcApplication1.Controllers.productsController.Product’ is a ‘field’ but is used like a ‘type. Plzz help me out in this problem

    • I believe you are making some mistake while calling a method. This type of error occurs normally when someone calls a method at class level instead of making call inside a method.

  • Above are around 52 errors, If you can remove others, hopefully things will be clear but it seems you have some wrong placement of methods (outside class) etc.

  • Roman Denysiuk

    IMRAN, could you tell me the way how to allow update/delete/create records (through web service) only for authenticated users?

  • Edwin Yesid Castañeda Henao

    Imran, this blog is excellent. Conglaturations !!

  • user2083

    well explained! easy to understand for a newcomer.

    here one thing i want to mention is while executing above given example my browser was showing below error :

    “This XML file does not appear to have any style information associated with it. The document tree is shown below.

    No HTTP resource was found that matches the request URI ‘http://localhost:45788/api/products’.

    No type was found that matches the controller named ‘products’.

    And the reason i found was, in my application, ‘ProductsController’ class was by default inheriting “Controller” as base class as given below:

    “public class ProductsController : Controller”

    instead of ‘ApiController’ class as shown in above example code.

    So After adding namespace “using System.Web.Http;” in ‘ProductsController’ class and inheriting ‘ApiController’ as base class as follows:

    “public class ProductsController : ApiController”

    it worked.

    thanks again for this good piece of work.

  • user2083

    well explained! easy to understand for a newcomer.

    one thing i want to mention, while executing above given example browser was showing below error :

    “This XML file does not appear to have any style information associated with it. The document tree is shown below.

    No HTTP resource was found that matches the request URI ‘http://localhost:45788/api/products’.

    No type was found that matches the controller named ‘products’.

    And the reason i found was, in my application, ‘ProductsController’ class was by default inheriting “Controller” as base class as given below:

    “public class ProductsController : Controller”

    instead of ‘ApiController’ class as shown in above example code.

    So After adding namespace “using System.Web.Http;” in ‘ProductsController’ class and inheriting ‘ApiController’ as base class as follows:

    “public class ProductsController : ApiController”

    it worked.

    thanks again Imran for this good piece of work.