Skip to main content

Introduction to ASP.NET Web API Features and why should we use Web API?

HTTP is not just for serving up web pages. It is also a powerful platform for building APIs that expose services and data. HTTP is simple, flexible, and ubiquitous. Almost any platform that you can think of has an HTTP library.

The ASP.NET Web API shipped with ASP.NET MVC 4 and is a framework for building HTTP services. ASP.NET Web API is a framework for building web APIs on top of the .NET Framework. With the help of Web API, we can create RESTful services which can be consumed by a broad range of clients including browsers and mobile devices.

Web API Features:

·        Web API is an HTTP Service.
·        It uses HTTP as an Application protocol, not a transport protocol.
·        Web API is an ideal platform for building pure HTTP-based services where the request and response happen with HTTP protocol.
·        Web API can be hosted within the application or on IIS and with Web API 2 you can host it on Cloud.
·        It is designed for a broad range of clients including browsers and mobile devices.
·        Web API comes with MVC4 and it supports the MVC features such as routing, controllers, action results, filter, IOC or dependency injection, etc. that making it more simple and robust.
·        With WebAPI content negotiation, we can return data based on the client requests, i.e. WebAPI framework deals with the request type and returns the data appropriately based on the media type.
·        The client can make a GET, PUT, POST, and DELETE request and get the WebAPI response appropriately.
·        Web API responses have an Accept header and HTTP status code.
·        By default WebAPI provides JSON-based responses.
·        Web API uses MediaTypeFormatter to format the response into JSON, XML, or whatever format you want to add as a MediaTypeFormatter.

Why should we use Web API?

Whenever there is a new technology to work on, the first question will be why we should use it, though we can achieve the same thing with existing technology and Web API is not an exception in this case.

Let’s find out why we should use Web API:

·         Web API is open source, and open-source developers will surely love this.
·         Web API supports MVC features such as routing, filtering, controllers, etc. and one can create Web API with basic knowledge of MVC and can use MVC features with Web API.
·         Web API service based on lightweight architecture and it is good for devices that have limited bandwidth like mobiles.
·         If we want to create a web service that only runs on HTTP protocol and doesn’t use any significant protocol to run, then Web API is the best choice for you.
·         With the Web API, we can build simple, HTTP-based services on top of the existing WCF message pipeline.
·         Like the WCF service it doesn’t have annoying and extensive configuration.
·         With the help of Web API we can easily create RESTful services, though we can also create RESTful services with WCF, but service configuration is difficult.
Labels:

Comments

  1. godseyeviewApril 23, 2014 at 2:09 AM

    WCF is dead. its an awful architecture. with pretty much useless extra features

    ReplyDelete
  2. godseyeviewApril 23, 2014 at 2:13 AM

    WCF is dead. it has an awful architecture as well as useless extra features with no worthwhile real use cases for it. Too many esoteric configuration hacks

    ReplyDelete

Post a Comment

Popular posts from this blog

Error 405 : ASP.NET Core Web API PUT and DELETE Methods not allowed

Recently, while working with .Net core API I came across the issue of “Error 405 — Methods not Allowed” After some research, I found out that both GET and POST requests working fine but neither PUT nor DELETE requests working. Another thing is that the PUT and DELETE request was also working fine on my local machine but failed when we host on our Azure server. When I explored the issue on the web it led me to the conclusion that WebDAVModule seems to set PUT and DELETE request methods disabled by default and due to that PUT and DELETE throw 405 errors. To make the PUT and DELETE requests work, we need to override the WebDAVModule setting in web.config file by adding the below settings under “ system.webServer ”. < system.webServer >   < modules runAllManagedModulesForAllRequests = " false " >     < remove name = " WebDAVModule " />   </ modules > </ system.webServer > There may be 2 web.config files in y...
Post a Comment
Read more

C#: Merging Excel cells with NPOI HSSFWorkbook

In this post we’ll see how to merge the two or more cell with each other while creating the excel sheet using NPOI . Mentioned below is code to merge multiple cells, in this example we are merging first cell to fifth cell of first row (you can adjust row or cell range by passing particular parameters in CellRangeAddress). //Created new Workbook var hwb = new NPOI.HSSF.UserModel. HSSFWorkbook (); //Create worksheet with name. var sheet = hwb.CreateSheet( "new sheet" ); //Create row and cell. var row = sheet.CreateRow(0); var cell = row.CreateCell(0); ; //Set text inside cell cell.SetCellValue( "This is Merged cell" ); cell.CellStyle.WrapText = true ; //define cell range address // parameters: -> first row to last and first cell to last cell var cra = new NPOI.SS.Util. CellRangeAddress (0, 0, 0, 4); //Add merged region to sheet. sheet.AddMergedRegion(cra); Hope this solution helps you J
4 comments
Read more

How to set Swagger as the default start page for API hosted on the Azure web app?

I created an Asp.Net Core 2.x Web API and configured Swagger on it, below is the code added in Configure method under Startup.cs file, for full swagger configuration, check here //Add swagger configuration app.UseSwagger(); app.UseSwaggerUI(c => {     c.SwaggerEndpoint( "../swagger/v1/swagger.json" , "Test API V1" ); }); On my local machine when I run the API it is automatically redirected to the Swagger page. However, when I hosted this API as an Azure web app it is not redirecting directly to the Swagger and to access the swagger, I had to append /swagger in the URL, for example, https://testapi.azurewebsites.net/swagger/ Solution: Set RoutePrefix to string.Empty under app.UseSwaggerUI like below: app.UseSwaggerUI(c => {     c.SwaggerEndpoint( "../swagger/v1/swagger.json" , "Test API V1" );      c.RoutePrefix = string .Empty; // Set Swagger UI at apps root }); And that’s it, now when you b...
Post a Comment
Read more