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

REST API uses PUT to update an existing resource in a collection. We'll see how to implement an API endpoint that uses PUT to update an existing product in the collection.

The `request` object of Flask can be used to retrieve the body of a PUT request, and path parameter mapping can be used to get the ID of the product to be updated. The `Route` decorator can be used to map a method to the PUT request. Let's see how to do the same.

# Steps

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

2. Add a new method. Name the method `update_product`. Provide it the required parameter, which is product ID, and name the parameter `product_id`.
```python
def update_product(product_id):
```

3. Add the following code.
```python
	data = request.get_json()
	updated_product = None
	for product in products:
    	if product['id'] == product_id:
        	product.update(data)
        	updated_product = product
	return jsonify(updated_product)
```

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 PUT.
```python
@products_blueprint.route('/products/<product_id>', methods=['PUT'])
```

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 PUT --data '{"version": "3.0"}' -H'Content-Type: application/json' http://localhost:5000/api/products/3 -v
```

7. This should give the following output.
```
< HTTP/1.1 200 OK
< Content-Type: application/json
< Content-Length: 84
{"description":"container for rest","id":"3","name":"rest-container","version":"3.0"}
```

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

Introduction

Client

Server

Project: Tickets API

Conclusion

Implement the PUT Endpoint for Updating an Existing Product

Steps