FastAPI

Aperçu

FastAPI est un framework web Python moderne et hautes performances pour la création d'API. Il propose une documentation interactive automatique, la validation des annotations de type et le support asynchrone prêt à l'emploi.

Démarrage rapide

git clone https://<git-server>/<username>/<repo-name>.git
cd <repo-name>

pip install -r requirements.txt

uvicorn app.main:app --reload

git add .
git commit -m "Initial setup"
git push origin main

Développement local avec Docker

Si vous n'avez pas Python installé localement, vous pouvez utiliser Docker pour exécuter votre application FastAPI.

Exécuter des commandes avec Docker

# Installer les dépendances
docker run --rm -v $(pwd):/app -w /app python:3.12 pip install -r requirements.txt

# Exécuter le serveur de développement
docker run --rm -v $(pwd):/app -w /app -p 8000:8000 python:3.12 sh -c "pip install -r requirements.txt && uvicorn app.main:app --host 0.0.0.0 --reload"

Configuration de la base de données

La plateforme NStrim met à votre disposition une base de données MySQL/MariaDB. Configurez votre connexion dans le fichier .env ou directement dans votre module de configuration de base de données.

DATABASE_URL=mysql+pymysql://<username>:<password>@db.<session-domain>:3306/<username>

Structure du projet

├── app/
│   ├── main.py                # Point d'entrée de l'application FastAPI
│   ├── routers/               # Modules de routes
│   ├── models/                # Modèles SQLAlchemy
│   ├── schemas/               # Schémas Pydantic
│   └── database.py            # Connexion à la base de données
├── templates/                 # Templates Jinja2
├── static/                    # CSS, JS, images
├── requirements.txt           # Dépendances Python
└── Dockerfile                 # Config Docker
        

Tâches courantes

Créer un point d'API

from fastapi import APIRouter

router = APIRouter()

@router.get("/users")
async def get_users():
    return [{"name": "Alice"}, {"name": "Bob"}]

@router.post("/users")
async def create_user(name: str, email: str):
    return {"name": name, "email": email}

Utiliser SQLAlchemy

from sqlalchemy import Column, Integer, String
from app.database import Base

class User(Base):
    __tablename__ = "users"

    id = Column(Integer, primary_key=True, index=True)
    name = Column(String(100))
    email = Column(String(255), unique=True)

Schéma Pydantic pour la validation

from pydantic import BaseModel

class UserCreate(BaseModel):
    name: str
    email: str

class UserResponse(BaseModel):
    id: int
    name: str
    email: str

    class Config:
        from_attributes = True

Commandes utiles

Dépannage

Flux de déploiement