Updating and Deleting Resources in RESTful APIs Using Java HttpClient and Gson

Updating and Deleting Resources with PUT, PATCH, and DELETE

Welcome to this lesson focused on enhancing your skills in interacting with RESTful APIs by updating and deleting resources. In the previous lessons, you learned how to retrieve and create resources using the GET and POST methods. Now, you will explore the PUT, PATCH, and DELETE methods, which are crucial for modifying existing resources or removing them when they are no longer needed.

Understanding PUT, PATCH, and DELETE Methods

To effectively manage resources within an API, it's essential to understand how to use the following methods: PUT : This method is used for completely updating a resource. You replace the current resource with the new data you provide in the request body. For example, if you're updating a to-do item, you'll include all the new details of the item in the body of the request and specify the resource ID in the request path to indicate which item you are updating. PATCH : Use this method to make partial updates to a resource. You only need to include the specific fields you're updating in the request body. For instance, if you're only changing the description of a to-do item, you'll pass just the new description in the body. The resource ID is specified in the request path to identify which item is being modified. DELETE : This straightforward method removes a resource from the server. You specify which resource to delete by including its identifier in the request path. No request body is needed since you're not sending any data, just instructing the server to remove the resource corresponding to that ID. Successful requests using these methods typically return status codes of 200 (OK) or 204 (No Content). A 200 status code means the operation was successful and also returns content, such as a representation of the updated resource. In contrast, a 204 status code indicates success but with no content returned, meaning the server successfully processed the request but isn't providing any additional information. These methods are crucial for performing full CRUD (Create, Read, Update, Delete) functionality in API management. Let's delve deeper into each method and explore how they are implemented using Java .

Setting Up the Java Environment

Before executing HTTP requests, we need to set up the Java environment by importing necessary classes from Java's HttpClient for handling HTTP requests and Gson for JSON processing. We'll define the base URL for our API interactions: Java import java.net.URI; import java.net.http.HttpClient; import java.net.http.HttpRequest; import java.net.http.HttpResponse; import com.google.gson.Gson; import java.util.Map; // Base URL for the API String baseUrl = "http://localhost:8000"; HttpClient client = HttpClient.newHttpClient(); Gson gson = new Gson(); With this setup in place, you're well-prepared to explore PUT, PATCH, and DELETE operations for resource management.

Join the 1M+ learners on CodeSignal

Be a part of our community of 1M+ users who develop and demonstrate their skills on CodeSignal

Updating Resources with PUT

The PUT method is utilized when you need to update an entire resource. Imagine you have a todo item that needs a complete overhaul, such as updating the task description, adding more details, or marking it as completed. The PUT request replaces the current resource representation with the new one you provide.

Here's an example of how to send a PUT request to update a todo item:

Java

// Todo ID to update
int todoId = 1;

// Updated todo data for PUT
Map<String, Object> updatedTodo = Map.of(
    "title", "Buy groceries and snacks",
    "done", true,
    "description", "Milk, eggs, bread, coffee, and chips."
);

String requestBody = gson.toJson(updatedTodo);

HttpRequest putRequest = HttpRequest.newBuilder()
    .uri(URI.create(baseUrl + "/todos/" + todoId))
    .header("Content-Type", "application/json")
    .PUT(HttpRequest.BodyPublishers.ofString(requestBody))
    .build();

HttpResponse<String> putResponse = client.send(putRequest, HttpResponse.BodyHandlers.ofString());

if (putResponse.statusCode() == 200) {
    System.out.println("Todo updated successfully with PUT!");
    System.out.println(putResponse.body());
} else {
    // Handle potential errors
    System.out.println("Error updating the todo with PUT");
    System.out.println("Status Code: " + putResponse.statusCode());
    System.out.println("Error Details: " + putResponse.body());
}

// Todo ID to update
int todoId = 1;

// Updated todo data for PUT
Map<String, Object> updatedTodo = Map.of(
    "title", "Buy groceries and snacks",
    "done", true,
    "description", "Milk, eggs, bread, coffee, and chips."
);

String requestBody = gson.toJson(updatedTodo);

HttpRequest putRequest = HttpRequest.newBuilder()
    .uri(URI.create(baseUrl + "/todos/" + todoId))
    .header("Content-Type", "application/json")
    .PUT(HttpRequest.BodyPublishers.ofString(requestBody))
    .build();

HttpResponse<String> putResponse = client.send(putRequest, HttpResponse.BodyHandlers.ofString());

if (putResponse.statusCode() == 200) {
    System.out.println("Todo updated successfully with PUT!");
    System.out.println(putResponse.body());
} else {
    // Handle potential errors
    System.out.println("Error updating the todo with PUT");
    System.out.println("Status Code: " + putResponse.statusCode());
    System.out.println("Error Details: " + putResponse.body());
}

In this code, we specify the complete new data for the todo item and send the request using Java's HttpClient with a PUT method. Upon receiving a 200 status code, you know the update was successful, and you can print the new representation of the todo item. It's important to note that for our API, a PUT request requires all fields (title, description, and done) to be provided. If any field is missing, the request will fail and return a status code of 400. In cases where you only need to update specific fields, rather than the entire resource, the PATCH method is more suitable.

Partial Updates with PATCH

Unlike PUT, the PATCH method is specifically designed for partial updates. When you need to modify only a specific field of a resource, PATCH ensures system efficiency and data integrity without the need to send a full representation.

Here's an example of performing a PATCH request on a resource:

Java

// Todo ID to update
int todoId = 2;

// Partial updated data
Map<String, Object> patchData = Map.of("description", "Updated description");

String patchRequestBody = gson.toJson(patchData);

HttpRequest patchRequest = HttpRequest.newBuilder()
    .uri(URI.create(baseUrl + "/todos/" + todoId))
    .header("Content-Type", "application/json")
    .method("PATCH", HttpRequest.BodyPublishers.ofString(patchRequestBody))
    .build();

HttpResponse<String> patchResponse = client.send(patchRequest, HttpResponse.BodyHandlers.ofString());

if (patchResponse.statusCode() == 200) {
    System.out.println("Todo updated successfully with PATCH!");
    System.out.println(patchResponse.body());
} else {
    // Handle potential errors
    System.out.println("Error updating the todo with PATCH");
    System.out.println("Status Code: " + patchResponse.statusCode());
    System.out.println("Error Details: " + patchResponse.body());
}

// Todo ID to update
int todoId = 2;

// Partial updated data
Map<String, Object> patchData = Map.of("description", "Updated description");

String patchRequestBody = gson.toJson(patchData);

HttpRequest patchRequest = HttpRequest.newBuilder()
    .uri(URI.create(baseUrl + "/todos/" + todoId))
    .header("Content-Type", "application/json")
    .method("PATCH", HttpRequest.BodyPublishers.ofString(patchRequestBody))
    .build();

HttpResponse<String> patchResponse = client.send(patchRequest, HttpResponse.BodyHandlers.ofString());

if (patchResponse.statusCode() == 200) {
    System.out.println("Todo updated successfully with PATCH!");
    System.out.println(patchResponse.body());
} else {
    // Handle potential errors
    System.out.println("Error updating the todo with PATCH");
    System.out.println("Status Code: " + patchResponse.statusCode());
    System.out.println("Error Details: " + patchResponse.body());
}

In this scenario, only the description field is updated. After sending the PATCH request through Java's HttpClient, we can check the response status code to confirm success. Successful updates with a status code of 200 allow you to view the updated resource fields, while any errors are managed by inspecting and printing error details.

Deleting Resources with DELETE

After learning how to update resources using PUT and PATCH, let's move on to deleting resources with the DELETE method. This method is straightforward — it's used to remove a resource from the server, which is important for keeping your data clean and relevant.

Here's how you can perform a DELETE request:

Java

// Todo ID to delete
int todoId = 3;

HttpRequest deleteRequest = HttpRequest.newBuilder()
    .uri(URI.create(baseUrl + "/todos/" + todoId))
    .DELETE()
    .build();

HttpResponse<String> deleteResponse = client.send(deleteRequest, HttpResponse.BodyHandlers.ofString());

if (deleteResponse.statusCode() == 204) {
    System.out.println("Todo deleted successfully!");
} else {
    // Handle potential errors
    System.out.println("Error deleting the todo");
    System.out.println("Status Code: " + deleteResponse.statusCode());
    System.out.println("Error Details: " + deleteResponse.body());
}

// Todo ID to delete
int todoId = 3;

HttpRequest deleteRequest = HttpRequest.newBuilder()
    .uri(URI.create(baseUrl + "/todos/" + todoId))
    .DELETE()
    .build();

HttpResponse<String> deleteResponse = client.send(deleteRequest, HttpResponse.BodyHandlers.ofString());

if (deleteResponse.statusCode() == 204) {
    System.out.println("Todo deleted successfully!");
} else {
    // Handle potential errors
    System.out.println("Error deleting the todo");
    System.out.println("Status Code: " + deleteResponse.statusCode());
    System.out.println("Error Details: " + deleteResponse.body());
}

In this example, we're sending a DELETE request to remove a specific todo item by specifying its ID in the request path. When the server successfully deletes the resource, you will typically receive a 204 status code. This code means "No Content," indicating that the deletion was successful, but there's no additional data to send back.

However, it's important to note that some services might return a 200 status code along with some content, such as a message. This can vary depending on how the service is designed, so always check the API documentation for specifics on how it handles deletions. Also, as with previous requests, these should be surrounded with try-catch blocks.

Updating and Deleting Resources in RESTful APIs Using Java HttpClient and Gson

Updating and Deleting Resources with PUT, PATCH, and DELETE

Understanding PUT, PATCH, and DELETE Methods

Setting Up the Java Environment

Join the 1M+ learners on CodeSignal

Updating Resources with PUT

Partial Updates with PATCH

Deleting Resources with DELETE

Summary and Preparation for Practice Exercises