Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/martincantillo/flask-jwt
API with Flask-JWT-Extended
https://github.com/martincantillo/flask-jwt
flask flask-jwt-extended flask-sqlalchemy jwt marshmallow-sqlalchemy
Last synced: about 1 month ago
JSON representation
API with Flask-JWT-Extended
- Host: GitHub
- URL: https://github.com/martincantillo/flask-jwt
- Owner: MartinCantillo
- Created: 2023-12-06T21:53:08.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-08T03:08:06.000Z (about 1 year ago)
- Last Synced: 2024-03-22T14:27:49.702Z (10 months ago)
- Topics: flask, flask-jwt-extended, flask-sqlalchemy, jwt, marshmallow-sqlalchemy
- Language: Python
- Homepage:
- Size: 13.9 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Flask-JWT-Extended
## Description
This project demonstrates a simple implementation of JWT (JSON Web Token) authentication using Flask and Flask-JWT-Extended. It includes user authentication, token generation, and protected routes.
## Prerequisites
- Python 3.x
- Flask 3.0.0 
- Flask-JWT-Extended 4.5.3 
- Flask-SQLAlchemy
- Flask-Marshmallow
- MySQL database
## Installation
1. Clone the repository:
```bash
git clone https://github.com/MartinCantillo/Flask-jwt
```
2. Install dependencies:
```bash
pip install -r requirements.txt
```
3. Set up the MySQL database. Update the `app.config['SQLALCHEMY_DATABASE_URI']` in `app.py` with your database connection details.
4. Run the application:
```bash
python app.py
```
## Configuration
- **MySQL Database:** Update the `app.config['SQLALCHEMY_DATABASE_URI']` in `app.py` with your database connection details.
- **JWT Configuration:** Update the `app.config["JWT_SECRET_KEY"]` in `app.py` with a secure secret key.
## Usage
1. **Login without Cookies:**
```bash
POST /login_without_cookies
```
Authenticate and receive a JWT token.
2. **Login with Cookies:**
```bash
POST /login_with_cookies
```
Authenticate and receive a JWT token, which is also stored in the cookies.
3. **Logout with Cookies:**
```bash
POST /logout_with_cookies
```
Log out and remove the JWT token from cookies.
4. **Protected Route:**
```bash
GET /protected
```
Access a protected route by providing a valid JWT token (can be in headers, cookies, JSON, or query string).
5. **Protected Route with Headers:**
```bash
GET /only_headers
```
Access a protected route by providing a valid JWT token only in headers.
## Models
- **Role Model:**
- `id_rol`: Integer, primary key
- `nombre_rol`: String(50)
- **User Model:**
- `id`: Integer, primary key
- `username`: Text, unique
- `full_name`: String(50)
- `password`: String(50)
- `rol_id`: Integer, foreign key referencing `tblRol.id_rol`
## Schemas
- **Role Schema:**
- `id_rol`
- `nombre_rol`
- **User Schema:**
- `id`
- `username`
- `full_name`
- `password`
- `rol_id`
- `rol`
## Routes
- `/login_without_cookies`: Authenticate without storing the token in cookies.
- `/login_with_cookies`: Authenticate and store the token in cookies.
- `/logout_with_cookies`: Log out and remove the token from cookies.
- `/protected`: Access a protected route (token can be in headers, cookies, JSON, or query string).
- `/only_headers`: Access a protected route with the token only in headers.
## Additional Notes
- Ensure that your MySQL server is running and the database is created.
- Customize the JWT secret key and database URI according to your security requirements.
- This project is intended as a basic demonstration and may need further enhancements for a production environment.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.