FastAPI User Management API

A simple RESTful API for user management built with FastAPI and SQLAlchemy. This API provides basic CRUD operations for managing user records in a MySQL database. It also supports filtering and querying users based on various criteria.

The only required parameter for the endpoints that require a parameter is the name parameter. All other fields are optional.

There is a foreign key relationship between the users table and the tracks table. Before a user is assigned a track (represented by track_id on the user table), there must have been some tracks created so the user can be assigned a track that exists.

Features
Prerequisites
Installation
Usage
API Endpoints
Request and Response Formats
Sample Usage
Known Limitations

Features

Create a new user
Retrieve user details by ID
Update user information
Delete a user
List all users with optional filtering criteria
Automatic timestamps for date_created and date_modified
Soft deletion with is_deleted flag

Prerequisites

Before running the application, ensure you have the following prerequisites installed:

Python 3.8 or higher
MySQL database server
MySQL connector for Python (install with pip install mysql-connector-python)
Psycopg2 for PostgreSQL (install with pip install psycopg2-binary)
FastAPI and SQLAlchemy (install with pip install fastapi sqlalchemy)

Installation

Clone the repository:

git clone https://github.com/Cofucan/fastapi-user-management.git

Change to the project directory:
```
cd fastapi-user-management
```
Create a virtual environment (optional but recommended):
```
python -m venv venv
```
Activate the virtual environment:
```
venv\Scripts\activate
```
Install project dependencies:
```
pip install -r requirements.txt
```
Configure the database:
- Update the DATABASE_URL variable in the main.py file to point to your MySQL database.

Run the application:

uvicorn main:app --host 0.0.0.0 --port 8000 --reload

The API will be accessible at http://localhost:8000.

Usage

API Endpoints

The API provides the following endpoints:

POST /api/: Create a new user.
GET /api/: List all users with optional filtering criteria.
GET /api/{user_id}: Retrieve user details by ID.
PUT /api/{user_id}: Update user information.
DELETE /api/{user_id}: Delete a user.

Request and Response Formats

UserCreate (Request Payload for Creating a User)

name (str, required): User's name.
gender (str, optional): User's gender ('M' for Male, 'F' for Female, 'O' for Other).
email (str, optional): User's email address.
username (str, optional): User's username.
track_id (int, optional): ID of the user's track.

UserUpdate (Request Payload for Updating a User)

name (str, optional): User's name.
gender (str, optional): User's gender.
email (str, optional): User's email address.
username (str, optional): User's username.
track_id (int, optional): ID of the user's track.

UserResponse (Response Format for User Details)

id (int): User ID.
name (str): User's name.
gender (str, optional): User's gender.
email (str, optional): User's email address.
username (str, optional): User's username.
track_id (int, optional): ID of the user's track.
date_modified (datetime, optional): Timestamp of the last modification.

UserFilter (Request Payload for Filtering Users)

name (str, optional): Filter users by name.
stage (int, optional): Filter users by stage.
gender (str, optional): Filter users by gender.
email (str, optional): Filter users by email.
username (str, optional): Filter users by username.
track_id (int, optional): Filter users by track ID.

Sample Usage

Create a New User: This ONLY required parameter to this endpoint is the name. All other parameters are not required. If they are not specified, they will be set to null.

POST /api/

{
  "name": "John Doe",
  "gender": "M",
  "email": "johndoe@example.com",
  "username": "johndoe123",
  "track_id": 1
}

Response:

{
  "id": 1,
  "name": "John Doe",
  "gender": "M",
  "email": "johndoe@example.com",
  "username": "johndoe123",
  "track_id": 1, 
  "date_modified": "2023-09-13T12:34:56.789Z"
}

Get Users with Filtering Criteria: This fetches all users that match the criteria specified in the json request. If no attribute is specified, then it returns all the users.

GET /api/

{
  "gender": "M"
}

Response:

[
  {
    "id": 1,
    "name": "John Doe",
    "gender": "M",
    "email": "johndoe@example.com",
    "username": "johndoe123",
    "track_id": 1,
    "date_modified": "2023-09-13T12:34:56.789Z"
  },
  {
     "id": 4,
     "name": "William Dean",
     "gender": "M",
     "email": "williamdean@example.com",
     "username": "williamabc",
     "track_id": 3,
     "date_modified": "2023-09-13T12:34:56.789Z"
  }
]

Get User by ID

GET /api/2

Response

{
  "id": 2,
  "name": "Alex Jones",
  "gender": null,
  "email": null,
  "username": null,
  "track_id": null,
  "date_modified": "2023-09-15T04:05:00.786386"
}

Update User Information

PUT /api/2

{
  "name": "Jane Doe",
  "gender": "F",
  "email": "janedoe@example.com"
}

Response

{
    "id": 2,
    "name": "Jane Doe",
    "gender": "f",
    "email": "janedoe@example.com",
    "username": null,
    "track_id": null,
    "date_modified": "2023-09-15T08:14:17.916300"
}

Delete a User: When a user is deleted, the is_deleted column is set to true but the record still remains. This is done for data recovery purposes. The data would be deleted from the server after some stipulated amount of time.

DELETE /api/1

Known Limitations

The API does not provide user authentication or authorization. It is recommended to implement authentication middleware for production use.
Error handling could be improved with more detailed error messages for different scenarios.

Cofucan / simple_fastapi_user_api