Back to: ASP.NET Web API Tutorial

Implementing the PUT Method in Web API: Code Example

The PUT method in a Web API is crucial for updating existing resources. In this article, we’ll guide you through implementing the PUT method in ASP.NET Web API with a code example.

Understanding the PUT Method

The PUT HTTP method is used to update a resource or create it if it doesn’t exist. It is one of the standard HTTP methods used for CRUD (Create, Read, Update, Delete) operations. In the context of Web API, the PUT method is typically used to update an existing resource, such as an item, record, or entity, based on its unique identifier.

Code Example: Updating a Product

In this example, we’ll create an ASP.NET Web API project for managing products. We’ll implement the PUT method to update a product resource based on its unique identifier (ID).

Step 1: Create an ASP.NET Web API Project

1. Open Visual Studio and create a new ASP.NET Web API project.
2. Create a ProductController with the following PUT method:

public class ProductController : ApiController
{
    private List<Product> products = new List<Product>
    {
        new Product { Id = 1, Name = "Product A", Price = 10.99M },
        new Product { Id = 2, Name = "Product B", Price = 19.99M },
        new Product { Id = 3, Name = "Product C", Price = 5.99M }
    };

    // PUT api/product/5
    public IHttpActionResult Put(int id, [FromBody] Product product)
    {
        if (product == null || product.Id != id)
        {
            return BadRequest(); // Return a 400 Bad Request if the request data is invalid.
        }

        var existingProduct = products.FirstOrDefault(p => p.Id == id);
        if (existingProduct == null)
        {
            return NotFound(); // Return a 404 response if the product is not found.
        }

        existingProduct.Name = product.Name;
        existingProduct.Price = product.Price;
        return Ok("Product updated successfully.");
    }
}

In this code snippet:

• We have a list of sample products (products) to simulate a database.
• The PUT method accepts an id parameter specifying the product to be updated and a [FromBody] parameter for the updated product data.
• We check if the request data is valid and if the product exists. If both conditions are met, we update the product data and return a 200 OK response.

Step 2: Test the PUT Method

Build and run your Web API project. To test the PUT method, you can use a tool like Postman or a web browser.

Make a PUT request to the following URL:

PUT /api/product/2

Include the updated product data in the request body:

{
    "Id": 2,
    "Name": "Updated Product B",
    "Price": 24.99
}

This request will update “Product B” (assuming it exists) with the new data provided in the request body.

Conclusion

Implementing the PUT method in a Web API is essential for updating existing resources. In this code example, we demonstrated how to create a Web API project and implement the PUT method to update a product resource based on its ID. You can apply similar principles to handle PUT operations for other types of resources in your Web API.