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

Web Developer
Source: Indeed
Details: ASP.NET MVC, Entity Framework:. 3-5+ years of experience designing complex web applications in ASP.NET MVC, Entity Framework....  More
10 days ago

Redmond, WA 20-April-2017

Software Developer (Jr/Mid)
Source: Blue Canopy
Details: ASP.NET MVC and Web Forms, SQL Server, Visual Studio, TFS, C#, HTML, CSS, JavaScript. Blue Canopy Group, LLC is seeking a Software Developer (Jr/Mid) for our...  More
3 days ago

Fort Meade, MD 27-April-2017

Jr. Front End Angular 2 Developer
Source: Phenomenex
Details: Experience with ASP.NET MVC, REST Services. The right candidate will have a passion for software development, good communication skills, and the ability to...  More
5 days ago

Torrance, CA 90501 25-April-2017

Web Developer
Source: BoatUS
Details: ASP. BoatU.S., a part of GEICO and the Berkshire Hathaway family of companies, is looking for a Web Developer at our Headquarters in Alexandria, VA....  More
2 days ago

Alexandria, VA 28-April-2017

.NET Full Stack Developer
Source: Indeed
Details: .NET / ASP.NET / MVC development environment:. Candidates should have full stack experience for ASP.NET MVC Web Development in particular....  More
5 days ago

Cerritos, CA 90703 25-April-2017

Jr. Software Developer
Source: Ellie Mae
Details: Familiarity with ASP.NET MVC and/or .NET Web API a plus. Ellie Mae is a provider of enterprise on-demand solutions, including an online network, software and...  More
10 days ago

Pleasanton, CA 94588 19-April-2017

Web Developer
Source: Indeed
Details: Experience with bootstrap, ASP.NET MVC a plus. Expertise in front-end web development • Proficiency with HTML, CSS, javascript, Angular.js • Experience with...  More
30+ days ago

Redmond, WA 23-March-2017

Web Developer
Source: Indeed
Details: The National Fire Protection Association’s mission is to help save lives and reduce loss with information, knowledge and passion. An international nonprofit  More
16 days ago

Quincy, MA 14-April-2017

.NET Software Developer (Jr/Mid)
Source: Blue Canopy
Details: ASP.NET MVC and Web Forms, SQL Server, Visual Studio, TFS, C#, HTML, CSS, JavaScript. Blue Canopy Group, LLC is seeking a .Net Software Developer (Jr/Mid) for...  More
22 days ago

Fort Meade, MD 08-April-2017

Full Stack .Net Developer
Source: Indeed
Details: Candidates should have full stack experience for ASP.NET MVC Web Development in particular. Cypress North Corp, a leading software engineering and digital...  More
23 days ago

Buffalo, NY 14210 06-April-2017

Software Engineer .NET, C#
Source: American College of Healthcare Executives
Details: Utilize ACHE’s evolving technology stack including Visual Studio, C#, MS SQL Server, ASP.NET, MVC, XML/XSLT, JavaScript, and jQuery....  More
4 days ago

Chicago, IL 60606 26-April-2017

Creative Full-Stack ASP.Net Developer
Source: Indeed
Details: Minimum 3-5yrs ASP.Net MVC (C#) web development experience “Full-Stack” preferred:. Understanding of C#, MVC, HTML, Javascript, CSS, Entity Framework, SQL...  More
27 days ago

Denver, CO 03-April-2017

Jr. .Net Developer - TS/SCI
Source: LongView International Technology Solutions Inc.
Details: Strong knowledge of Visual Studio 2013, Team Foundation Server, ASP.Net MVC, Angular 1.7, Bootstrap v3, WebAPI , LINQ,....  More
30+ days ago

Fort Belvoir, VA 29-March-2017

Mobile Application Developer
Source: Indeed
Details: Proficient in writing Web API (ASP.NET MVC WebAPI, EF6.0). Prior experience in Hybrid web application development using ASP.NET MVC, and client frameworks like...  More
3 days ago

Charlotte, NC 26-April-2017

Web Developer
Source: GenConnect Recruiting and Consulting
Details: Solid understanding of Microsoft ASP.Net MVC 5 and Microsoft ASP.Net Web Api 2. Are you interested in joining a company that will map out your development...  More
27 days ago

Atlanta, GA 03-April-2017

Senior ASP.NET Developer
Source: Brogden Enterprises, Inc.
Details: Experience working with ASP.NET MVC and nHibernate. Member of the programming team responsible for the design, development and enhancement of websites....  More
9 days ago

Aberdeen, MD 21-April-2017

Senior ASP.NET Developer
Source: Brogden Enterprises, Inc.
Details: Experience working with ASP.NET MVC and nHibernate. Member of the programming team responsible for the design, development and enhancement of websites....  More
9 days ago

Huntsville, AL 21-April-2017

Software Engineer C#/ASP.NET MVC/JavaScript
Source: Cormant, Inc.
Details: You will be working on full stack development including Marionette client, and a C# MVC architecture with NHibernate/RDBMS as the back-end....  More
9 days ago

San Luis Obispo, CA 21-April-2017

Web Developer
Source: Hubert
Details: Experience with any modern MVC web architecture (ASP.NET MVC, Ruby/Rails, Django/Python, etc.). Programmer, web programmer, web development, MVC web...  More
27 days ago

Harrison, OH 45030 03-April-2017

Senior ASP.NET MVC Developer
Source: Indeed
Details: 4+ years experience developing web applications using ASP.NET MVC. The successful candidate provides great interpersonal and communication skills coupled with...  More
10 days ago

Lake Orion, MI 20-April-2017

Sr. C#/ASP.NET Developer
Source: Logic20/20
Details: *Strong C#, .NET framework (ASP.NET MVC, Entity Framework), jQuery, HTML 5 development Qualifications. Logic20/20 is a Seattle based Management & Technology...  More
12 days ago

Seattle, WA 98115 18-April-2017

SQL Report Developer (N. Pittsburgh)
Source: Indeed
Details: Experience with ASP.NET MVC is a plus. Please no contractors, local candidates only....  More
1 day ago

Pittsburgh, PA 29-April-2017

Application Developer
Source: Indeed
Details: MVC:. Microsoft.Net Framework 4.0 and higher, C#, ASP.Net, MVC, WebAPI, Javascript, AJAX, JSON. Franklin based technology consulting firm is recruiting a .Net...  More
13 days ago

Franklin, TN 37067 17-April-2017

Full Stack .NET Developer
Source: Forte Group
Details: Experience with ASP.NET, MVC and .NET Framework; One of the largest technology providers is currently looking for a Full Stack .NET Developer to join their team...  More
30+ days ago

Chicago, IL 60606 23-March-2017

Full Stack .Net Developer with MS dynamics
Source: Indeed
Details: (SDE with C#/ASP.Net/MVC, SQL Server, etc. - Microsoft stack) ~ Experience working with PCI compliant systems - examples: great plains or MS Dynamics  More
30+ days ago

Seattle, WA 02-March-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.