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

In a REST API, insert (aka create) is used to add a new resource to the existing collection. In this lesson, we'll see how to implement an API endpoint using POST, which adds/creates a new product to the existing collection of products.

The `request` object of Flask can be used to retrieve the body of a POST request. The `route` decorator can be used to map a method to the POST request. Let us see how to implement an API to add a new product by using the `request` object and the `route` decorator.


# Steps


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

2. Add a new method. Name the method `add_product`.
```python
def add_product():
```

3. Add the following code.

```python
data = request.get_json()
data['id'] = str(len(products) + 1)
products.append(data)
location = url_for('.get_product', product_id = data['id'], _external=True)
response = jsonify(dict(product=data, location=location), 201)
response.headers['Location'] = location
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 POST.

```python
@products_blueprint.route('/products', methods=['POST'])
```

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 POST --data '{"name":"rest-container","description":"container for rest","version": "2.2"}' -H'Content-Type: application/json' http://localhost:5000/api/products -v
```

7. The obtained output should be as follows.
```
< HTTP/1.1 201 CREATED
< Content-Type: application/json
< Content-Length: 92
< Location: http://localhost:5000/api/products/3
{"location":"http://localhost:5000/api/products/3","product":{"id":"3","name": "rest-container","description": "container for rest","version": "2.2"}}
```

Learn how to implement products API using Flask to create a new product.

Introduction

Client

Server

Project: Tickets API

Conclusion

Implement the POST Endpoint for Creating a New Product

Steps