Federation API

Stack technique

• ⚡ FastAPI
  • 🔍 Pydantic
  • 🧰 SQLAlchemy
  • 💾 PostgreSQL
• 🔒 Secure password hashing
• 🔑 JWT authentication (for dev only)

Setup

1. 🎨 Récupérer le projet

git clone https://github.com/aphp/federation-api.git

2. 🚀 Lancer le projet

Avec Docker 🐋

• Créer le fichier de variables d'environnement federation-api/.env à base du template .env.example

  cd federation-api
  docker compose --env-file .docker.env up

• Accéder à la documentation de l'API sur localhost:8000/docs
• S'authentifier avec admin/1234 pour tester les routes de l'API

Avec Uvicorn 🦄

Avec Python 3.12 déjà installé, procéder comme suit:

• Installer UV et créer un environnement virtuel

  cd federation-api
  pip install uv && uv venv py312venv && uv pip install --no-cache -r requirements.txt

• Créer le fichier de variables d'environnement federation-api/.env à base du template .env.example

• Démarrer Uvicorn

  source py312venv/bin/activate
  (py312venv) uvicorn platform_registry.main:app --port 8000 --reload

• Accéder à la documentation de l'API sur localhost:8000/docs

• Pour tester l'API:

  1. configurer un serveur de BD PotgreSQL et lancer les migrations avec Alembic

  (py312venv) alembic upgrade head

  2. Lancer le script pour créer un utilisateur initial admin

  (py312venv) python platform_registry/initial_data.py

  3. S'authentifier avec admin/1234 pour tester les routes de l'API