API Server Flask

Open-source API Server crafted in Flask using JWT Authentication and SQLite.

Simple Flask API Boilerplatearrow-up-right enhanced with JWT authentication, SqlAlchemy, SQLite persistence and deployment scripts via Docker. It has all the ready-to-use bare minimum essentials.

Version: v1.0.2arrow-up-right, release date 2022-06-07

API Methods - for full description please access API Unified Definition

  • USERS API:

    • /api/users/register: create a new user

    • /api/users/login: authenticate an existing user

    • /api/users/logout: delete the associated JWT token

    • /api/users/checkSession: check an existing JWT Token for validity

    • /api/users/edit - edit the information associated with a registered user

Flask API Server - Open-source Product.

✨ Requirements

  • Python3 (Python2 is not supported)

  • Flask==2.1.2

  • flask-restx==0.5.1

  • Flask-JWT-Extended==4.4.1

  • pytest

✨ Getting Started

πŸ‘‰ Step 1 - clone the project using GIT

πŸ‘‰ Step 2 - Install dependencies (using a virtual environment)

Install dependencies in once the virtualenv is activated

πŸ‘‰ Step 3 - Prepare the environment

Or for Windows-based systems

πŸ‘‰ Step 4 - Initialize the database, check run.py for shell context

πŸ‘‰ Step 5 - Start the API server

Visit http://localhost:5000 in your browser. The API server will be running.

✨ Project Structure

The codebase has a simple, intuitive structure where run.py is responsible to bundle and start the API Server using the setup coded by the api folder:

✨ Compatible Fullstack Products

The product can be used as a standalone server but also as an authentication server for React, Vue products. Such a product already configured with Django API Server is React Datta Ablearrow-up-right, an open-source React Dashboard.

React Datta Able - Open-Source Dashboard.

Last updated