Flask_api

Flask_api is a Python application for test API REST. It's the model of simple storehouse. API lets view, create and delete goods in DB and orders for buyers. Added simple authentication with google oAuth2 and JWT tokens. Added logging to MongoDB and send filtered logs

Technologies used:

• APIFlask
• psycopg2
• pytest
• FlaskJWT
• GoogleAuth
• Docker compose
• Github Action
• Redis cache
• MongoDB

Requirements

• Python 3.7+
• Installed docker compose in Linux

Installation

For Linux :

• 1. Clone the repository from GitHub. Then install all the dependencies.

$ git clone git@github.com:zvic81/flask_api.git

• 2. Run docker compose for building docker images and running it, need file docker-compose.yml in dir flask_api

$  cd flask_api
$  docker compose up -d

• 3. Try open http://127.0.0.1:5000 for swagger gui app or use Postman

Description

For google oAuth there must be file client_secret_web.json in project root dir. URL for file https://console.cloud.google.com/apis/credentials?project=vzaharov

App needs started Redis docker with name "redis-py". It ran by docker-compose.yml but you can start redis manually $docker run -p 6379:6379 -d --network=host --name redis-py redis.

App needs started MongoDB docker. It ran by docker-compose.yml but you can start redis manually $docker run -it -p 27017:27017 --name mongo-logs mongo:4.4.6. Version 4.4.6 recomended because ver 5.0 doesnt work on my office pc (error MongoDB 5.0+ requires a CPU with AVX support. Container failed to start)

Endpoints:

• get /docs - main page for swagger documentation, some function may be ran there
• get /goods' - get all goods in short view
• get /orders - get all orders for current user. Need jwt token given in endpoint /login. Endpoint gives only orders with email user from jwt token
• get /goods/int:good_id - get entire information for good with id
• post /goods - add new good to DB
• post /orders - add new order
• put /goods/int:good_id' - change good with id
• delete /goods/int:good_id - delete good with id
• get /login - enter login-email for protected access
• get /callback - servise endpoint for reciving jwt token after authentication
• get /refresh_token - get new token if current is expired, Need send refresh token
• get /goods_cached - get all orders with added calculated price. Calcaulating take 1 sec every item but using redis cache it runs immediatly
• get /logs - get the app's logs saved in mongoDB. Parameters in query are required: 'timestart' 'timeend' 'module'(one of app-routes-all). Example "/logs?timestart=2023-04-30 18:00:00&timeend=2023-05-03 18:00:00&module=routes"

There is samples json requests in file flask_api.postman_collection for Postman

There is file linting-and-pull-request in dir .github - script for github action. It makes checking linting and auto pull request to branch main

There are tests in dir tests, description in every script

Structure of DB and test data in file db/flask_db.sql