User Management RESTful API with FastAPI, Redis and JWT

Table of Contents

• Introduction
  • Features
  • Author
• Prerequisites
  • Docker Compose (Linux)
  • Python 3.8
• How to Launch
  • First launch
  • Standard setup
• Usage
• Improvement Proposal

Introduction

This is a secure and efficient REST API for user administration. From creating new users to managing subordinates of a manager, this API provides a comprehensive solution. It is designed to ensure the integrity and security of the data with an educational purpose in mind.

This API has JWT (Json Web Token) protection, so only a user registered in the application can perform operations on it.

As a database, a lightweight option such as Redis has been chosen, which is often used as a cache instead of a database. The reason for using it is that since it is a 'simple' and educational application a non-relational option was the best. Among the candidates Redis seemed to me the easiest option to implement.

On the other hand, the language used was Python and FastAPI was chosen as the development framework, due to the similarities it shares with other frameworks when developing APIs such as Springboot (for endpoint implementation).

To be able to use all the functions provided by this API you will have to authenticate yourself, for this a user with admin role has been added by default in the database.

Features

• User registration and management.
• Role-based access control.
• JSON Web Token (JWT) protection for secure authentication.
• Data storage using Redis, a fast and lightweight option suitable for caching.

Author

• Author: Pablo Galán Acedo
• LinkedIn: Pablo Galán Acedo - LinkedIn
• GitHub: GitHub Repository

Prerequisites

Before you can run this project, make sure you have the following prerequisites installed on your system:

• Docker
• make (Linux command)
• Python 3.8

Python 3.8

Make sure you have Python 3.8 installed on your system. You can download it from the official Python website

How to launch

To set up and run this project, follow these steps:

First launch

• Clone the repository

git clone link_to_github_repository
cd user-management-api-fast-secure-redis

• Run the setup command using make:

make default-setup

Standard setup

Once you have made the first launch and there is a container for the database, you will only have to launch the following make each time you want to activate the service and preserve the data on your database:

make setup

Usage

Once the API is up and running, you can access it using the provided Swagger interface. Visit the Swagger API documentation (http://localhost:8000/docs#/) page to explore and interact with the endpoints. Then to access to all the functionality you must log in with the mentionated default user:

• username: 404bdab1-3dd5-4173-9713-43ec7858b0b5
• password: test

Improvement proposal

• Atomize the user types, having classes for each type, user, manager and administrator. Eliminating the roles field.
• Creating integration tests