morshedmasud / flask-rest-api-boilerplate

Simple User CRUD Boilerplate with Flask, Restplus and Swagger Documentation

Flask Rest API Boilerplate

Technology used

• Python3.8
• Flask
• Flask-restplus
• Sqlite

Features

• JWT Authentication
• Swagger Documentation
• User CRUD
• Unittest

Setup in your local machine

1. Clone project

git clone https://github.com/morshedmasud/flask-rest-api-boilerplate

2. Create virtualenv

virtualenv -p python3 venv

3. Active virtualenv

. venv/bin/activate

4. Go to project root path and install all dependency

make install

5. Database migrations

python manage.py db init
python manage.py db migrate --message 'initial database migration'

6. Database Update

python manage.py db upgrade

7. Run Application

make run

8. To Tests

make tests

Open the following url for view swagger documentation

http://127.0.0.1:5000/