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“.

Creating ASP.NET Web API service that supports CRUD (Create, Retrieve, Update, Delete) operations

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

Application Developer, 4 Days Remote, 1 Day in Office
Source: Indeed
Details: Designing and developing user interfaces using ASP.NET web forms and ASP.NET MVC. .NET Framework, Ajax, ASP.NET web forms, ASP.NET MVC, jQuery, nHibernate,...  More
30+ days ago

Des Moines, IA 04-November-2016

Developer, 4 Days Remote, 1 Day in Office
Source: Indeed
Details: Designing and developing user interfaces using ASP.NET web forms and ASP.NET MVC. .NET Framework, Ajax, ASP.NET web forms, ASP.NET MVC, jQuery, nHibernate,...  More
30+ days ago

Iowa City, IA 04-November-2016

.Net Developer
Source: Indeed
Details: .Strong Experience developing MVC applications using ASP.Net MVC. .4+ years experience in software engineering....  More
30+ days ago

Redmond, WA 30-November-2016

.NET Developer (Remote)
Source: Indeed
Details: ASP.NET MVC using C#. 3+ years of experience building web-based applications using ASP.NET MVC – C#. This is a full-time remote position....  More
6 days ago

Nashville, TN 13-January-2017

.NET Developer
Source: TS Solutions
Details: ASP.NET MVC (4), C#, Azure, SQL Server. TokuSaku (TS) Solutions is looking for .NET developer with numerous bolt-on skill sets to help with our list of direct...  More
19 hours ago

Seattle, WA 19-January-2017

ASP.NET / C# Software Developer (Web Services & API)
Source: Indeed
Details: C#, ASP.NET, MVC or better required, Java/Node.js a plus. The Software Developer is an experienced engineer that uses C#, ASP.NET, MVC to build web services,...  More
4 days ago

Tacoma, WA 16-January-2017

Senior Software Engineer (.Net)
Source: SmartDrive Systems, Inc.
Details: Expertise in C#, ASP.Net MVC, WCF, Web API, Angular JS and SQL Server. Architect, design and develop high performing web sites, mobile applications and scalable...  More
30+ days ago

San Diego, CA 18-October-2016

UX Developer
Source: Indeed
Details: Atleast 3+years of experience in development using .NET Framework technologies like C#, ASP.NET, MVC etc. • Excellent written and verbal communication skills •...  More
6 days ago

Redmond, WA 13-January-2017

Senior C# .NET Software Engineer
Source: Clark Associates
Details: Join one of Pennsylvania’s fastest growing companies today! WebstaurantStore, a division of Clark Associates, is looking for Senior C# .NET Software Engineer  More
9 days ago

Lititz, PA 17543 10-January-2017

C# ASP.Net Web Developer
Source: Indeed
Details: Experience with various web technologies, such as HTML, CSS, AJAX, JQuery, JavaScript, AngularJS, Bootstrap, XML, ASP.NET, MVC, WebForms, Web Services, IIS....  More
7 days ago

Irvine, CA 12-January-2017

Asp.net C# developer
Source: Indeed
Details: Asp.net MVC web development experience. 2-3 year C# and .net experience....  More
8 days ago

Indianapolis, IN 12-January-2017

Developer - Web
Source: Geocaching
Details: Proficient with ASP.NET, MVC, REST, WCF, Web API and scalable service oriented architectures. About Geocaching HQ....  More
13 days ago

Seattle, WA 98103 07-January-2017

C# Software Developer (Web Services & API)
Source: Indeed
Details: C#, ASP.NET, MVC or better required, Java/Node.js a plus. If you’re looking for a rewarding career with a dynamic and fast-growth healthcare software company,...  More
7 days ago

Seattle, WA 12-January-2017

Sr. ASP.NET Developer
Source: Indeed
Details: *ABSOLUTELY NO 3RD PARTIES FOR THIS POSITION* Participate and collaborate in design sessions ·Code / refactor one or multiple front-end web applications   More
14 days ago

Dallas, TX 75251 05-January-2017

ASP.NET MVC Web Developer
Source: Indeed
Details: 3+ years of C#, ASP.Net MVC, Entity Framework, HTML, JavaScript, JQuery, AJAX. We are in the process of switching applications from ASP.NET web forms into MVC 5...  More
15 days ago

Tigard, OR 04-January-2017

Jr .Net Developer
Source: Indeed
Details: Familiar with Web-API and REST in the ASP.NET MVC world. Professional job experience with C# and ASP.NET MVC (not just ASP.NET web forms). Full time/Long Term*....  More
21 days ago

Redmond, WA 29-December-2016

Technical Lead
Source: Morgan Stanley
Details: Must be experienced in AngularJS, client-side MVC, HTML5, CSS3, JavaScript,. Must have hands-on recent expertise in C#, ASP.NET, MVC, Web API, Rest Service....  More
30+ days ago

New York, NY 10032 19-December-2016

.NET Developer
Source: Indeed
Details: Web development using ASP.NET MVC. CANDIDATE MUST BE AVAILABLE FOR IN-PERSON INTERVIEW\*\*\*\*\*....  More
1 hour ago

Minneapolis, MN 20-January-2017

Developer Sr.
Source: Adroit Partners, LLC
Details: Use technologies, such as C#, ASP.NET, MVC, SQL, No-SQL (Couchbase, MongoDB), Enterprise Service Bus, to develop technical solutions to complex problems that...  More
6 hours ago

Houston, TX 20-January-2017

Software Developer
Source: Cortland Capital Market Services
Details: ASP.NET/MVC, HTML, Ajax, JQuery, JSON, JavaScript, XML/XSLT, CSS, NET 3.5/4.0/4.5 . A unique opportunity for a skilled and career-minded software engineer with...  More
8 hours ago

Brea, CA 20-January-2017

C#.Net Application Developer(Local: F2F)
Source: Indeed
Details: Web development using ASP.NET MVC. C#.Net Applications Developer*....  More
15 hours ago

Eden Prairie, MN 20-January-2017

.NET Developer
Source: Indeed
Details: C# .NET, ASP.NET, MVC, HTML 5, JQUERY, ANGULAR, JSON, RESTFUL WEB SERVICES, ENTITY FRAMEWORK, LINQ, RESPONSIVE WEB DESIGN, MS SQL and MOBILE....  More
16 hours ago

Rockville, MD 19-January-2017

C#.Net Developer
Source: Indeed
Details: Experience building web based applications with ASP.NET, MVC, Web Forms, HTML, CSS, JavaScript, jQuery and other client-side scripting technologies....  More
17 hours ago

Winter Springs, FL 19-January-2017

Sr. Full Stack C#/.NET Developer (10+ Years experience)
Source: Indeed
Details: MVC:. Expertise in most of the following - REACT.JS, Web API (MS ASP.Net), MVC, WCF, HTML5, CSS, JavaScript, JSON, SOAP, REST, JQuery, .Net Framework, C#, Web...  More
1 day ago

Austin, TX 18-January-2017

UI developer w/ .NET background
Source: Avani Tech Solutions
Details: MVC. ASP MVC/Web API. 5 years developing applications using ASP.NET MVC. UI developer w/ .NET background....  More
1 day ago

Houston, TX 18-January-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 IMRAN ABDUL GHANI

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.