Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yahrdev/fastapi_custom_auth_project
This project is a backend application built with FastAPI and MySQL. Here custom user authorization using JWT, OAuth2 etc was implemented.
https://github.com/yahrdev/fastapi_custom_auth_project
alembic backend fastapi jwt mysql oauth2 python sqlalchemy
Last synced: about 2 months ago
JSON representation
This project is a backend application built with FastAPI and MySQL. Here custom user authorization using JWT, OAuth2 etc was implemented.
- Host: GitHub
- URL: https://github.com/yahrdev/fastapi_custom_auth_project
- Owner: yahrdev
- Created: 2024-07-10T14:41:52.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-07-10T15:14:45.000Z (7 months ago)
- Last Synced: 2024-07-10T17:58:06.513Z (7 months ago)
- Topics: alembic, backend, fastapi, jwt, mysql, oauth2, python, sqlalchemy
- Language: Python
- Homepage:
- Size: 396 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
This project is a backend application built with FastAPI and MySQL. It provides endpoints for user registration, login, adding posts, retrieving posts, and deleting posts. The application follows the MVC design pattern and uses SQLAlchemy for database interactions. *Also implemented custom user authorization using JWT, OAuth2 etc.*
## API Endpoints
### 1. Signup endpoint
- **Description**: Allows users to sign up with their email and password.
- **Inputs**: `email`, `password`
- **Output**: Returns a token (JWT).
### 2. Login endpoint
- **Description**: Authenticates users using their email and password.
- **Inputs**: `email`, `password`
- **Output**: Returns a token (JWT) upon successful login.
### 3. AddPost endpoint
- **Description**: Adds a new post.
- **Inputs**: `text`, `token`
- **Output**: Returns `postID`.
- **Details**: Validates the payload size (the payload should not exceed 1 MB in size) and saves the post in memory.
### 4. GetPosts endpoint
- **Description**: Retrieves all posts added by the authenticated user.
- **Inputs**: `token`
- **Output**: Returns all posts added by the user.
- **Details**: Implements response caching for consecutive requests from the same user for up to 5 minutes.
### 5. DeletePost endpoint
- **Description**: Deletes a specified post.
- **Inputs**: `postID`, `token` (to authenticate the request)
- **Output**: Confirms deletion of the corresponding post from memory.
---------------------------------------------------------------------------------------------------------------
## Moduls/programs used
- Python and FastAPI: Core of the application.
- MySQL: Database for storing user and post data.
- Alembic: For database migrations.
- Pydantic: For data validation.
- JWT: For authentication.
------------------------------------------------------------------------------------------------------------------
## Requirements
- Python 3.9 or higher installed.
- MySQL server installed.
------------------------------------------------------------------------------------------------------------------
### Installation
Clone the repository:
```bash
git clone
cd fastapi_users_project
```
Create and activate a virtual environment:
```bash
python -m venv venv
source venv/bin/activate # On Windows use `venv\Scripts\activate`
```
Install the required dependencies:
```bash
pip install -r requirements.txt
```
Create a .env file in the project root with the following content:
```bash
DB_USER = your_db_user
DB_PASS = your_db_password
DB_HOST = localhost
DB_NAME = fastapiproj
DB_PORT = 3306
MODE = PROD
SECRET = your_secret_key
JWT_LIFETIME_MINUTES = 30
```
Set up the database:
```bash
mysql -u root -p
CREATE DATABASE fastapiproj;
```
Use Alembic to create the tables:
```bash
alembic revision --autogenerate -m "Initial migration"
alembic upgrade head
```
Start the FastAPI application:
```bash
uvicorn src.main:app --host 0.0.0.0 --port 8000
```
Access the application at http://localhost:8000. You can view the automatically generated API documentation at http://localhost:8000/docs.