flask-backend-sample

Create an API service using Python with sqlite and Flask.

API document was written in swagger.

Features
Installation
DB diagram
API Documentation
API usage

Features

Sign-up/log-in a role user (customer and manager)
- Logged in user would become expired in 600 senconds
- Permission:
  - 0: Customer
  - 1: Manager
Product management (manager permission)
- CRUD of product (product can only be deleted when there is no its order)
Order management
- Create orders (customer permission)
- Retrieve order list

Installation

Clone this repository to your local machine:

git clone git@github.com:mrwenwei/botrista-backend-pre-test.git
cd botrista-backend-pre-test

Run in docker:
```
docker-compose up --build
```
Open the document url http://127.0.0.1:8080/apidocs

DB diagram

DB queries are utilized by ORM package SQLAlchemy

API Documentation

Written in http://127.0.0.1:8080/apidocs

API Usage

All the APIs can be called on swagger.

Create account

POST /signup

Body:
{
  "password": "string",
  "permission": 0 or 1,
  "username": "string"
}

Create customer (permission=0) or manager (permission=1) by using this endpoint.

Login and Logout
```
POST /login
```
Login with the username and password. After successfully login, API will return login token (To simplify the mechanism here I use user_id) in response and service will cache the user for 600 seconds. After 600s the user needs to login again.
```
POST /logout

Authentication:
token
```
Manager create product
```
POST /product

Body:
{
    "name": "string",
    "price": float,
    "stock": integer
}

Authentication:
token
```
Create unique name product with manager logged in token (user_id).

After successfully created product, it will return the product_id in response.

Manager update/delete product

PUT /product

Parameter:
product_id

Body (optional, you can edit any of it):
{
    "name": "string",
    "price": float,
    "stock": integer
}

Authentication:
token

DELETE /product

Parameter:
product_id

Authentication:
token

The product can not be deleted if there exists any order of the product.

Get product info (logged in required) Get specific product

GET /product

Parameter:
product_id

Authentication:
token

Get all filtered products

GET /products

Parameters: (optional)
price_lower_bound
price_upper_bound
stock_lower_bound
stock_upper_bound

Customer create order

POST /order

Body:
[
    {
        "product_id": integer,
        "quantity": positive integer
    }
]

Authentication:
token

Multiple products can be assigned. If the product exists and the stock is enough, then the order will be created sucessfully.

Get order list If you are a customer, you will get your orders only. If you are a manager, you could get all orders that created by customers.
```
GET /orders

Parameters: (optional)
order_id
product_id

Authentication:
token
```