🚀 Test Technique Laravel

Ce projet est une API développée avec Laravel 11, dans le cadre d'un test technique pour un poste back-end senior.
Elle met en œuvre les bonnes pratiques de structuration, typage, validation, sécurité et qualité de code.

---

🧱 Fonctionnalités principales

• Authentification sécurisée via Laravel Sanctum
• Versioning API : Structure v1 avec préfixes pour évolutions futures
• Routes nommées : Navigation et génération d'URLs facilitées
• Validation stricte : Types d'ID vérifiés automatiquement
• Gestion des entités :
  • Administrateur : seul type d'utilisateur authentifié
  • Profil : CRUD restreint aux administrateurs
  • Commentaire : un commentaire par administrateur et par profil
• Upload de fichier image pour les profils
• Endpoints publics et privés clairement séparés
• Accès public uniquement aux profils actifs, avec restriction de champs

---

✅ Prérequis

• Docker
• Docker Compose
• Git

---

🐳 Installation avec Docker

Le projet utilise Docker pour garantir un environnement de développement cohérent et facile à mettre en place.

1. Cloner le repository

git clone [votre-repo]
cd [votre-repo]

2. Configuration de l'environnement

cp .env.example .env

Assurez-vous que votre fichier .env contient les bonnes configurations pour PostgreSQL :

DB_CONNECTION=pgsql
DB_HOST=db
DB_PORT=5432
DB_DATABASE=laravel_test
DB_USERNAME=laravel
DB_PASSWORD=secret

3. Lancer l'environnement Docker

# Construire et démarrer les conteneurs
docker-compose up -d

# Installer les dépendances
docker-compose exec app composer install

# Générer la clé d'application
docker-compose exec app php artisan key:generate

# Exécuter les migrations
docker-compose exec app php artisan migrate

# Charger les données de test
docker-compose exec app php artisan db:seed

L'application est maintenant accessible à l'adresse : http://localhost:8000

🛠 Stack Technique

• PHP 8.2
• Laravel 11
• PostgreSQL 15
• Nginx dernière version stable
• Docker & Docker Compose

📦 Services Docker

• app : Application PHP/Laravel
• nginx : Serveur web
• db : Base de données PostgreSQL

🔧 Commandes Docker utiles

# Voir l'état des conteneurs
docker-compose ps

# Voir les logs
docker-compose logs

# Logs d'un service spécifique
docker-compose logs app
docker-compose logs db
docker-compose logs nginx

# Exécuter des commandes Artisan
docker-compose exec app php artisan [commande]

# Accéder au shell PHP
docker-compose exec app bash

# Arrêter l'environnement
docker-compose down

# Arrêter et supprimer les volumes
docker-compose down -v

📡 Endpoints API v1

🔄 Versioning : Toutes les routes sont préfixées par /api/v1/ pour permettre les évolutions futures de l'API.

🔓 Endpoints publics

• GET /api/v1/profiles : Liste des profils actifs uniquement (le champ statut est masqué)
  • Route nommée : v1.public.profiles.index

🔐 Authentification

• POST /api/v1/auth/register : Inscription administrateur
  • Route nommée : v1.auth.register
• POST /api/v1/auth/login : Connexion administrateur (retourne un token Sanctum)
  • Route nommée : v1.auth.login

🔒 Endpoints administrateur (authentifiés)

Gestion des profils

• POST /api/v1/admin/profiles : Création d'un profil (avec image)
  • Route nommée : v1.admin.profiles.store
• PUT /api/v1/admin/profiles/{id} : Mise à jour d'un profil
  • Route nommée : v1.admin.profiles.update
  • ✅ Validation ID : Seuls les ID numériques sont acceptés
• DELETE /api/v1/admin/profiles/{id} : Suppression d'un profil
  • Route nommée : v1.admin.profiles.destroy
  • ✅ Validation ID : Seuls les ID numériques sont acceptés

Gestion des commentaires

• POST /api/v1/admin/profiles/{id}/comments : Ajout d'un commentaire unique à un profil
  • Route nommée : v1.admin.profiles.comments.store
  • ✅ Validation ID : Seuls les ID numériques sont acceptés

🛡️ Sécurité et validations

• Rate Limiting : 60 requêtes par minute pour les endpoints admin
• Middleware personnalisés : owns.profile pour vérifier la propriété
• Validation stricte des ID : Les paramètres {profile} n'acceptent que des entiers positifs
• Authentification Sanctum : Tokens sécurisés pour les sessions API

📚 Documentation API

Une collection Postman est disponible pour tester facilement tous les endpoints de l'API.

🧪 Tests

# Exécuter les tests avec Docker
docker-compose exec app php artisan test

Inclut :

• Tests unitaires
• Tests de validation
• Tests des règles de sécurité
• Tests de logique métier
• Tests des nouvelles routes v1

🧰 Qualité du code

Formatage : PHP-CS-Fixer

docker-compose exec app ./vendor/bin/php-cs-fixer fix

Analyse statique : PHPStan

docker-compose exec app ./vendor/bin/phpstan analyse

• Séparation métier / contrôleur via Services & FormRequests
• Types PHP 8+ et validation forte
• Architecture avec versioning pour maintenabilité
• Routes nommées pour faciliter les refactorings

🔄 Évolutions futures

Grâce au système de versioning mis en place :

• v2 : Nouvelles fonctionnalités sans casser la v1
• Migration progressive : Les clients peuvent migrer à leur rythme
• Maintenance facilitée : Corrections de bugs sur plusieurs versions en parallèle