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.

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 Scala 3.

Before executing HTTP requests, let's once again import the necessary libraries and define our base URL:

Scala
Copy to clipboard
1import requests.*
2import scala.util.{Try, Success, Failure}
3
4// Base URL for the API
5val baseUrl = "http://localhost:8000"

With this setup in place, you're well-prepared to explore PUT, PATCH, and DELETE operations for resource management.

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:

Scala
Copy to clipboard
1// Todo ID to update
2val todoId = 1
3
4// Updated todo data for PUT
5val updatedTodo = ujson.Obj(
6  "title" -> "Buy groceries and snacks",
7  "done" -> true,
8  "description" -> "Milk, eggs, bread, coffee, and chips."
9)
10
11// Send PUT request and handle the response
12Try(requests.put(s"$baseUrl/todos/$todoId", data = updatedTodo)) match {
13  case Success(response) if response.statusCode == 200 =>
14    println("Todo updated successfully with PUT!")
15    println(ujson.read(response.text()))
16  case Success(response) =>
17    println("Error updating the todo with PUT")
18    println(s"Status Code: ${response.statusCode}")
19    println(s"Error Details: ${response.text()}")
20  case Failure(exception) =>
21    println(s"Request failed: ${exception.getMessage}")
22}

In this code, we specify the complete new data for the todo item and send the request using the requests.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.

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:

Scala
Copy to clipboard
1// Todo ID to update
2val todoId = 2
3
4// Partial updated data
5val patchData = ujson.Obj("description" -> "Updated description")
6
7// Send PATCH request and handle the response
8Try(requests.patch(s"$baseUrl/todos/$todoId", data = patchData)) match {
9  case Success(response) if response.statusCode == 200 =>
10    println("Todo updated successfully with PATCH!")
11    println(ujson.read(response.text()))
12  case Success(response) =>
13    println("Error updating the todo with PATCH")
14    println(s"Status Code: ${response.statusCode}")
15    println(s"Error Details: ${response.text()}")
16  case Failure(exception) =>
17    println(s"Request failed: ${exception.getMessage}")
18}

In this scenario, only the description field is updated. After sending the PATCH request through the requests.patch method, 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.

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:

Scala
Copy to clipboard
1// Todo ID to delete
2val todoId = 3
3
4// Send DELETE request and handle the response
5Try(requests.delete(s"$baseUrl/todos/$todoId")) match {
6  case Success(response) if response.statusCode == 204 =>
7    println("Todo deleted successfully!")
8  case Success(response) =>
9    println("Error deleting the todo")
10    println(s"Status Code: ${response.statusCode}")
11    println(s"Error Details: ${response.text()}")
12  case Failure(exception) =>
13    println(s"Request failed: ${exception.getMessage}")
14}

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.

This lesson provided you with a comprehensive understanding of the PUT, PATCH, and DELETE methods, enhancing your ability to modify and manage resources through API interactions. You learned how to update complete resources with PUT, make partial modifications with PATCH, and delete resources using DELETE. Understanding these operations is key to mastering CRUD functionality in RESTful API management.

As you proceed to the practice exercises, you're encouraged to apply these concepts to reinforce your understanding and learn through practice. Each operation is a building block towards becoming proficient in interacting with APIs using Scala 3. Keep up the great work as you progress through the exercises, further cementing your knowledge and skills in API resource management!