ASP.NET Web API: Designing RESTful APIs for the Modern Web

The Modern API Requirement

With the rise of Single Page Applications (like AngularJS and Backbone.js) and mobile clients, web backends are no longer just rendering HTML pages. They must serve structured JSON data to browser clients securely.

In response, Microsoft has consolidated its HTTP API prototype work into ASP.NET Web API, shipped alongside ASP.NET MVC 4.

The Web API Design Philosophy

Web API is designed directly around HTTP primitives, replacing legacy WCF SOAP configurations.

Key architectural features:

• ◆Attribute Routing and Web Routing: Mapping URL paths directly to controller actions:

// Simple REST Controller in C# Web API
public class ProductsController : ApiController {
    // GET /api/products
    public IEnumerable<Product> GetAllProducts() {
        return _repository.List();
    }

    // GET /api/products/5
    public Product GetProduct(int id) {
        return _repository.Find(id);
    }
}

• ◆Native Content Negotiation: Evaluating client Accept headers automatically to return JSON, XML, or binary data.
• ◆Test-Friendly Controllers: Bypassing standard ASP.NET server contexts to simplify unit testing, establishing a clean service architecture.