netkap/restful-api

Restful API for products.

Installation and run

Download this repo and delete db.sqlite(if present)

open terminal in the folder where app.py is located (usually shift + right click -> open powershell for windows) and type :

pip install -r requirements.txt

In the same or new powershell type python and press enter to open python and type:

from app import db
db.create_all()
exit()
python app.py

In your folder there will be a new file db.sqlite

Docker (for those who don't wanna run locally )

for Docker users run:

docker pull netkap/tr2

docker run -dp 0.0.0.0:5000:5000 netkap/tr2

(for some port 5000 is busy just change the first port to somehting else ex- docker run -dp 0.0.0.0:5005:5000 netkap/tr2)

RESTful

Restful API for products.

Go to Localhost/apidocs for docmentation. for example http://localhost:5000/apidocs/ or http://127.0.0.1:5000/apidocs/

This RESTful API runs Flask server , uses SQLALCHEMY as DataBase Toolkit also Marshmallow is used for object serialization and deserialization. SWAGGER UI for API Documentation

Further Scope:

Adding authentication

Set CI CD pipelines

Deploying to web