Flask Api Template
A basic template to help kickstart development of a Flask API
Overview
The Flask REST API Template is a basic template that serves as a starting point for developing a pure Flask API. It's designed to be front-end independent, allowing developers to make all decisions regarding the application. The template includes basic login functionality based on JWT checks, with the storage and transmission of the token left to the developer.
Features
- Minimal Flask 2.X App
- Async/Await Functionality
- Unit tests
- Basic Type Hints
- Integration With Redis for Background Tasks
- App Structured Using Blueprints
- Application Factory Pattern Used
- Authentication Functionality Using JWT
- Basic Database Functionality Included (SQLite3)
- Rate Limiting Functionality Based on Flask-Limiter for All Routes in the Authentication Blueprint
- Support for .env and .flaskenv Files Built-in
Summary
The Flask REST API Template is a basic template for building a Flask API. It provides a starting point with minimal Flask app functionality, async/await support, unit tests, basic type hints, integration with Redis for background tasks, and more. The template follows a structured approach with blueprints and uses the application factory pattern. It includes authentication functionality using JWT and basic database functionality with SQLite3. Installation involves cloning the repository, setting up a virtual environment, installing dependencies, setting up a SQLite3 database, performing database migrations, and running the application.