.Net 4.8 Web API Example Tutorial Building REST Services

Embarking on your journey to explore ASP.NET Web API? Let's dive into an insightful example using .NET 4.8. ASP.NET Web API is a framework that adds a layer of consistency across different HTTP-based APIs, making it a robust choice for building modern web services.

Before we jump into the .NET 4.8 Web API example, ensure you have the following prerequisites: Visual Studio 2017 or later, .NET Framework 4.8 installed, and a basic understanding of HTTP methods (GET, POST, PUT, DELETE).

Setting Up a Simple Web API Project in .NET 4.8

Let's start by creating a new Web API project in Visual Studio using the ".NET Framework" option and targeting .NET 4.8.

Once the project is set up, we have a basic Web API awaiting our modifications. Now, let's create a simple API to manage lists of items.

Creating a Model Class

A model class represents the data we'll be sending and receiving between our client and server. Let's create a simple "Item" class in a new file named "Item.cs":

public class Item
{
    public int Id { get; set; }
    public string Name { get; set; }
    public string Description { get; set; }
}

Building the API

Now, let's create a new controller named "ItemsController" to handle our API operations:

public class ItemsController : ApiController
{
    private static List _items = new List();

    // Get all items
    public IEnumerable GetAll()
    {
        return _items;
    }

    // Get a single item by ID
    public Item Get(int id)
    {
        return _items.FirstOrDefault(i => i.Id == id);
    }

    // Add a new item
    public Item Post(Item item)
    {
        item.Id = _items.Count + 1;
        _items.Add(item);
        return item;
    }

    // Update an existing item
    public Item Put(int id, Item updatedItem)
    {
        var item = _items.FirstOrDefault(i => i.Id == id);
        if (item == null)
            throw new HttpResponseException(HttpStatusCode.NotFound);

        item.Name = updatedItem.Name;
        item.Description = updatedItem.Description;

        return item;
    }

    // Delete an item
    public void Delete(int id)
    {
        var item = _items.FirstOrDefault(i => i.Id == id);
        if (item == null)
            throw new HttpResponseException(HttpStatusCode.NotFound);

        _items.Remove(item);
    }
}

Conducting CRUD Operations with .NET 4.8 Web API

Now that our API is set up, let's explore creating, retrieving, updating, and deleting items using HTTP methods.

You can test these operations using tools like Postman or curl for making HTTP requests. Here's how you can perform each operation:

Create (POST)

To create a new item, send a POST request to /api/items with the following JSON body:

{
    "Name": "Sample Item",
    "Description": "This is a sample item."
}

Read (GET)

To retrieve all items, send a GET request to /api/items. To read a single item, use /api/items/{id}.

Update (PUT)

To update an item, send a PUT request to /api/items/{id} with the updated JSON body:

{
    "Name": "Updated Item",
    "Description": "This is an updated item."
}

Delete (DELETE)

To delete an item, send a DELETE request to /api/items/{id}.

With this .NET 4.8 Web API example, you've now built and explored a simple yet powerful API. From here, you can build upon this foundation to create more advanced Web APIs tailored to your needs. Happy coding!