A lightweight example of an e-store API with Flask, SQLite and Flask-RESTful.
-
Install Flask-RESTful with pip
pip install flask-restful -
Install the packages
pip install -r requirements.txt -
Run Flask
flask run --port=5000
-
GET /api/products - list of all available products
curl http://127.0.0.1:5000/api/products -
POST /api/orders - create new order
curl -X POST http://127.0.0.1:5000/api/orders -
GET /api/orders/:order_id - get order details
curl http://127.0.0.1:5000/api/orders/:order_id -
PATCH /api/orders/:order_id - update order
curl -X PATCH --data '{"status": "PAID"}' -H "Content-Type: application/json" \ http://127.0.0.1:5000/api/orders/:order_id -
GET /api/orders/:order_id/products - get order products
curl http://127.0.0.1:5000/api/orders/:order_id/products -
POST /api/orders/:order_id/products - add products to order
curl --data '[123]' -H "Content-Type: application/json" \ http://127.0.0.1:5000/api/orders/:order_id/products -
PATCH /api/orders/:order_id/products/:product_id - update product quantity
curl -X PATCH --data '{"quantity": 33}' -H "Content-Type: application/json" \ http://127.0.0.1:5000/api/orders/:order_id/products/:product_id -
PATCH /api/orders/:order_id/products/:product_id - add a replacement product
curl -X PATCH --data '{"replaced_with": {"product_id": 123, "quantity": 6}}' -H "Content-Type: application/json" \ http://127.0.0.1:5000/api/orders/:order_id/products/:product_id