Gain insights into using Python to consume and create REST APIs, delving into HTTP methods like GET and PUT. Ideal for enhancing intermediate Python skills.

Flask.tar.gz

Get Products

Get Product

Create Product

Update Product

Delete Product

Product OPTIONS

REST is the most used mechanism to publish APIs for general consumption. Each language has its own set of libraries and methods that help a developer consume these APIs. This course will teach you how to use Python and its libraries for consuming and creating REST APIs in the easiest way possible.

In the first part of this course, you’ll learn how to work with Python in using REST APIs for various scenarios. Then, in the second part, you’ll focus on building your own REST APIs using the HTTP methods, including GET, PUT, etc.

This course is geared toward intermediate users who have a basic understanding of Python and want to improve their skills in using existing REST APIs and building their REST API implementations.

Python REST API Development: A Comprehensive Guide

The equivalent of the Delete CRUD operation in REST is the DELETE method. It can be used in REST API to indicate that a particular resource in a collection needs to be removed or marked as not processable. If one looks at the URI for DELETE, it will look the same as that for GET. Hence, from a URI perspective, DELETE and GET use the same template.

In Flask, the path parameter of the URI gets mapped to the parameter of the method. The product ID passed as the path parameter can be used to delete the corresponding product from the list. In this section, let's see how to provide a DELETE REST endpoint.

# Steps

1. Open `server/api/products_api.py`.

2. Add a new method that accepts a parameter named `product_id`. Name the method `delete_product`.
```python
def delete_product(product_id):
```


3. Add the following code to the `delete_product` method.
```python
for product in products:
    if product['id'] == product_id:
        products.remove(product)
        break
response = make_response('', 204)
response.mimetype = 'application/json'
return response
```

4. Decorate the method with the `route()` decorator of `products_blueprint`. Pass the URI that will represent the endpoint and the supported HTTP method, which is `DELETE`. Add the path parameter named `product_id` to the URI.
```python
@products_blueprint.route('/products/<product_id>', methods=['DELETE'])
```

5. Run the application.

6. Hit the following URL using your preferred tool. When testing on the Educative platform, please replace `http://localhost` with the URL provided in the SPA widget.
```
$ curl -X DELETE http://localhost:5000/api/products/1
```

7. This should result in the following output.
```
< HTTP/1.1 204
```

Learn how to implement the products API using Flask to delete an existing product.

Introduction

Client

Server

Project: Tickets API

Conclusion

Implement the DELETE Endpoint for Removing an Existing Product