Skip to content

FastAPI DevOps Playground - Social Media API

📝 Description

API REST complète construite avec FastAPI et SQLAlchemy ORM pour gérer un système de posts de type réseau social. L'application inclut l'authentification JWT, la gestion des utilisateurs, les posts et un système de votes.

✨ Fonctionnalités

  • 🔐 Authentification JWT avec tokens expirables
  • 👤 Gestion des utilisateurs (inscription, connexion)
  • 📄 CRUD complet pour les posts (Create, Read, Update, Delete)
  • 👍 Système de votes (like/unlike)
  • 🔍 Recherche et pagination des posts
  • 🔒 Autorisation : seul le propriétaire peut modifier/supprimer ses posts
  • 🗄️ Base de données PostgreSQL avec SQLAlchemy ORM
  • 📊 Validation des données avec Pydantic V2

🏗️ Architecture

app/
├── routers/          # Routes API organisées par domaine
│   ├── auth.py       # Authentification (login)
│   ├── post.py       # CRUD posts
│   ├── user.py       # Gestion utilisateurs
│   └── votes.py      # Système de votes
├── models.py         # Modèles SQLAlchemy (Post, User, Votes)
├── schemas.py        # Schémas Pydantic pour validation
├── database.py       # Configuration base de données
├── oauth2.py         # Gestion JWT tokens
├── utils.py          # Utilitaires (hash password)
└── main.py           # Point d'entrée FastAPI

🗄️ Modèles de données

Post

  • id: Identifiant unique
  • title: Titre du post
  • content: Contenu
  • published: Statut de publication
  • created_at: Date de création
  • user_id: Référence vers l'utilisateur propriétaire

User

  • id: Identifiant unique
  • email: Email (unique)
  • password: Mot de passe hashé
  • created_at: Date de création

Votes

  • post_id: Référence vers le post
  • user_id: Référence vers l'utilisateur

⚙️ Installation

Prérequis

  • Python 3.12+
  • PostgreSQL

Étapes d'installation

  1. Cloner le repository et basculer sur la branche ORM
git checkout feature/fastapi-ORM
  1. Créer et activer l'environnement virtuel
python3 -m venv venv
source venv/bin/activate
  1. Installer les dépendances
pip install -r requirements.txt
  1. Configurer PostgreSQL

Créer une base de données PostgreSQL :

CREATE DATABASE fastapi_db;
CREATE USER fastapi WITH PASSWORD 'fastapi';
GRANT ALL PRIVILEGES ON DATABASE fastapi_db TO fastapi;
  1. Configurer les variables d'environnement (optionnel)

Créer un fichier .env :

DB_HOSTNAME=localhost
DB_PORT=5432
DB_PASSWORD=fastapi
DB_NAME=fastapi_db
DB_USERNAME=fastapi
SECRET_KEY=your-secret-key
ACCESS_TOKEN_EXPIRE_MINUTES=30
  1. Lancer l'application

en local

uvicorn app.main:app --reload --port 8080

en production

uvicorn --host 0.0.0.0 app.main:app --reload --port 8080

6-bis **Utiliser gunicorn

gunicorn -w 4 -k uvicorn.workers.UvicornWorker app.main:app --bind 0.0.0.0:8080

L'API sera accessible sur : http://localhost:8080

Documentation interactive : http://localhost:8080/docs

🚀 Utilisation de l'API

Authentification

1. Créer un compte

POST /users/
Content-Type: application/json

{
  "email": "user@example.com",
  "password": "securepassword"
}

2. Se connecter

POST /login
Content-Type: application/x-www-form-urlencoded

username=user@example.com&password=securepassword

Réponse :

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "bearer"
}

3. Utiliser le token

Ajouter le header à toutes les requêtes protégées :

Authorization: Bearer <votre_token>

Posts

Créer un post

POST /posts/
Authorization: Bearer <token>
Content-Type: application/json

{
  "title": "Mon premier post",
  "content": "Contenu du post",
  "published": true
}

Récupérer tous les posts

GET /posts/
Authorization: Bearer <token>

Récupérer un post spécifique

GET /posts/{id}
Authorization: Bearer <token>

Mettre à jour un post

PUT /posts/{id}
Authorization: Bearer <token>
Content-Type: application/json

{
  "title": "Titre modifié",
  "content": "Contenu modifié",
  "published": true
}

Supprimer un post

DELETE /posts/{id}
Authorization: Bearer <token>

Votes

Voter pour un post (like)

POST /votes/
Authorization: Bearer <token>
Content-Type: application/json

{
  "post_id": 1,
  "dir": 1
}

Retirer son vote (unlike)

POST /votes/
Authorization: Bearer <token>
Content-Type: application/json

{
  "post_id": 1,
  "dir": 0
}

🔍 Query Parameters

Les query parameters permettent de filtrer et paginer les résultats :

Pagination

GET /posts?limit=10&skip=0
  • limit : Nombre maximum de résultats (défaut: 10)
  • skip : Nombre de résultats à ignorer (défaut: 0)

Recherche

GET /posts?search=FastAPI
  • search : Recherche dans les titres des posts

Combinaison

GET /posts?search=FastAPI&limit=5&skip=2

Note : Pour rechercher avec des espaces, utiliser %20 :

GET /posts?search=seminars%20fiqh

🧪 Tester l'API

Avec Postman

  1. Importer la collection (si disponible)
  2. Créer une variable d'environnement {{URL}} = http://localhost:8080
  3. Tester les endpoints

Avec Swagger UI

Accéder à http://localhost:8080/docs pour une interface interactive.

Peupler la db de données avec Posts,Votes,Users

 python3 -m example_data.seed_db

🩺 Health checks

Deux endpoints dédiés (sans logique métier ni auth) pour les probes Kubernetes :

Endpoint Rôle Probe K8s Réponse
GET /healthz/live le process répond (liveness) livenessProbe 200 tant que le process tourne
GET /healthz/ready dépendances prêtes (readiness) readinessProbe 200 si SELECT 1 DB OK, sinon 503

Les probes du Deployment pointent sur ces endpoints (et non plus sur /), pour ne pas router de trafic vers un pod dont la base n'est pas joignable (#47).

🔒 Sécurité

  • Mots de passe hashés avec bcrypt
  • Authentification par JWT tokens
  • Tokens expirables (configurable)
  • Protection CSRF
  • Validation des données avec Pydantic

Durcissement au niveau cluster (Sprint 3) — voir Infrastructure EKS et l'ADR 008 :

  • Conteneur non-root, readOnlyRootFilesystem, capabilities: drop ALL, seccompProfile: RuntimeDefault (#43)
  • ServiceAccount dédié, automountServiceAccountToken: false (#45)
  • Pod Security Admission enforce: restricted sur le namespace (#48, effectif depuis INC-045)
  • NetworkPolicy default-deny + allowlists egress (#48), non enforced tant que le VPC CNI n'est pas en addon managé (#55)

📦 Technologies utilisées

  • FastAPI : Framework web moderne et rapide
  • SQLAlchemy : ORM Python
  • PostgreSQL : Base de données relationnelle
  • Pydantic V2 : Validation des données
  • JWT : Authentification par tokens
  • Bcrypt : Hashage des mots de passe
  • Uvicorn : Serveur ASGI

📝 Notes de migration Pydantic V2

Ce projet utilise Pydantic V2. Changements importants : - orm_mode = True → from_attributes = True - BaseSettings déplacé vers pydantic-settings - Installation requise : pip install pydantic-settings

🤝 Contribution

Les contributions sont les bienvenues ! N'hésitez pas à ouvrir une issue ou une pull request.

📄 Licence

Ce projet est un playground éducatif pour apprendre FastAPI et les pratiques DevOps.