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

Sr. .NET (Contract)
Source: Strategic Employment Partners
Details: C#, ASP.NET, MVC, SQL, and JavaScript. And maintain in-house applications using C#, ASP.NET MVC, SQL, JavaScript. A rapidly growing....  More
8 days ago

United States 10-October-2017

Full Stack .Net Engineer (Lead)
Source: Indeed
Details: Experienced with several of these languages and technologies, .NET, ASP.NET MVC, WCF, Rest, WebAPI, HTML5, AJAX, JSON, JQuery, ServiceBus, RabbitMQ, TeamCity...  More
13 days ago

Austin, TX 05-October-2017

Software Engineer I
Source: Vertafore
Details: Have developed either single page web applications leveraging modern frameworks (Angular, React) or more traditional multipage websites leveraging ASP.NET MVC...  More
27 days ago

Bothell, WA 98012 21-September-2017

.Net Software Engineer
Source: Porch
Details: Strong experience in developing Web Applications using C#.Net, ADO.NET/Asp.Net MVC, jquery, JavaScript, CSS, WEB APIs, SQL Server....  More
30+ days ago

Seattle, WA 14-August-2017

Junior/Mid Level Software Developer
Source: Indeed
Details: ASP.NET MVC (C#). Software developers are the engine behind the design, development, installation, testing and maintenance of software systems....  More
1 day ago

Kennesaw, GA 17-October-2017

Software Developer
Source: Mosaic Personnel
Details: Strong background in PHP, ASP.Net Web forms, ASP.NET MVC, C#. Why You'll Love This Software Developer Opportunity....  More
1 day ago

Oklahoma City, OK 17-October-2017

Applications Software Engineer - Web Developer Sr
Source: Indeed
Details: 5+ years' programming experience in C#, .NET framework, VB, MVC, EF and WCF. Experience with Web Development ASP.NET, ASP.NET, MVC, HTML5, CSS, JavaScript, AJAX...  More
1 day ago

Anaheim, CA 17-October-2017

Software Developer
Source: Indeed
Details: Create ASP.NET MVC controllers to access databases. Knowledge of ASP.NET MVC is preferred but not required. Our development environment runs on the Microsoft...  More
5 days ago

Orlando, FL 13-October-2017

Software Developer
Source: SDHR Consulting
Details: .NET Stack experience (C#, ASP.NET MVC, MS SQL Server). Do you have a passion for writing code?...  More
6 days ago

San Diego, CA 13-October-2017

Software Developer
Source: Evergreen Enterprises
Details: ASP.Net, MVC development skills using MS Visual Studio; About Evergreen Enterprises....  More
7 days ago

Richmond, VA 23225 11-October-2017

Software Developer / Software Engineer
Source: Natoli Engineering
Details: ASP.net MVC preferred. Software Developer / Software Engineer....  More
7 days ago

Saint Charles, MO 63304 11-October-2017

Software Developer
Source: Reynolds and Reynolds
Details: Knowledge of .NET framework including C#, ASP.NET, MVC, JavaScript, JQuery, HTML, CSS, web services, XML and SQL....  More
9 days ago

Draper, UT 09-October-2017

Software Developer
Source: Indeed
Details: Knowledge in Visual Studio 2005-2013 and .NET Framework 2.0 - 4.5.1, ASP.NET MVC 5.0, VB 6.0/.NET, C, C++, C#, Java, Tomcat, Transact-SQL, HTML, XML, JavaScript...  More
13 days ago

San Juan, PR 05-October-2017

Software Developer - Medical Billing
Source: SyMed Corporation
Details: Experience with ASP.NET MVC 5, LINQ, Entity Framework 6. Located in the beautiful Napa Valley, SyMed Corporation is a comprehensive medical billing and...  More
14 days ago

Napa, CA 94558 05-October-2017

Software Application Developer
Source: Indeed
Details: Successful candidates will likely have at least 5 years of experience in a professional capacity and a Bachelor’s degree in Computer Science, Information...  More
14 days ago

Los Angeles, CA 04-October-2017

Sr Software Developer
Source: Indeed
Details: C#, ASP.NET MVC. System redesign includes Car Buying, Retail and Scrap operations (using Mobile, MVC Web, WPF, Xamerin tablet interfaces)....  More
14 days ago

Atlanta, GA 30360 04-October-2017

Software Developer - Mid Level
Source: MartinFederal Consulting
Details: ASP.NET MVC and Web Forms. MartinFederal is seeking a self-motivated candidate for our Mid-Level Software Developer position in support of our DoD customer at...  More
17 days ago

Fort Meade, MD 20755 01-October-2017

Software Developer
Source: Gagemaker LP
Details: Intermediate to advanced skills in ASP.NET MVC , ASP.NET Web API. Software Developer Position Summary:....  More
20 days ago

San Antonio, TX 78216 28-September-2017

Software Developer ; Front-end
Source: Indeed
Details: If you are passionate about technology and enjoy creating simple solutions to complex requirements -- come join us! We are looking for topnotch developers...  More
21 days ago

San Diego, CA 27-September-2017

Software Developer 3
Source: Almac Group, Inc
Details: Minimum 2 years of experience developing applications utilizing ASP.net MVC and C#. 3 or more years of C# and ASP.net MVC experience working in a regulated...  More
28 days ago

Durham, NC 27704 20-September-2017

Software Developer
Source: Indeed
Details: Expertise should include HTML5, AngularJS, JavaScript, ASP.NET MVC and CSS. A solid understanding of working with MVC JavaScript frameworks such as Angular....  More
29 days ago

Carlsbad, CA 20-September-2017

Software Developer
Source: Indeed
Details: ASP.NET MVC, Web API. NET Framework 4.0 and above. Software Developer (.NET)*....  More
29 days ago

San Diego, CA 19-September-2017

Software Developer
Source: Indeed
Details: Experience with ASP.NET MVC and Web API. Client Resources Inc....  More
30 days ago

Lincoln, NE 18-September-2017

Software Developer
Source: Indeed
Details: 3+ years of experience with C# and ASP.NET MVC. The Software Developer will assist with new and ongoing software development as a member of an agile team...  More
23 days ago

Kennesaw, GA 25-September-2017

Software Developer 2
Source: Almac Group, Inc
Details: Minimum 1 year of experience developing applications utilizing ASP.net MVC and C#. Almac is an exceptional, award winning, drug development solutions provider...  More
30 days ago

Audubon, PA 19403 18-September-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.