Quels types de réponse pouvez-vous retourner au-delà de JSON ?

Question

Accepted Answer

FastAPI retourne du JSON par défaut (en sérialisant les dicts, les listes et les modèles Pydantic), mais il supporte de nombreux autres **types de réponse** pour des besoins différents — HTML, fichiers, flux de données, redirections et texte brut — via les classes `fastapi.responses`. ## Les classes de réponse par défaut et courantes ```python from fastapi.responses import ( JSONResponse, HTMLResponse, PlainTextResponse, RedirectResponse, FileResponse, StreamingResponse, ) @app.get("/json") def j(): return {"key": "value"} # default → JSON @app.get("/html", response_class=HTMLResponse) def h(): return "

Hello

" # serve HTML @app.get("/text", response_class=PlainTextResponse) def t(): return "plain text" @app.get("/go") def g(): return RedirectResponse(url="/new-location") # 307 redirect ``` ## Servir des fichiers ```python @app.get("/download") def download(): return FileResponse( "report.pdf", media_type="application/pdf", filename="report.pdf", # prompts a download with this name ) ``` `FileResponse` sert efficacement un fichier depuis le disque (en gérant les en-têtes, le type de contenu) — pour les téléchargements, les images, les documents générés. ## Diffuser en continu les données volumineuses ou générées ```python @app.get("/stream") def stream(): def generate(): for i in range(1000000): yield f"line {i} " # yield chunks — NOT all loaded into memory return StreamingResponse(generate(), media_type="text/plain") ``` `StreamingResponse` envoie les données de manière progressive à partir d'un générateur — essentiel pour les données **volumineuses ou continuellement générées** (gros fichiers, exports CSV, flux en direct) afin de ne pas les charger entièrement en mémoire à la fois. (Aussi la base des Server-Sent Events.) ## Encodeurs JSON personnalisés (JSON plus rapide) ```python from fastapi.responses import ORJSONResponse app = FastAPI(default_response_class=ORJSONResponse) # use orjson for faster JSON serialization ``` ## Pourquoi c'est important Bien que JSON couvre la plupart des réponses d'API, les applications réelles ont souvent besoin de retourner d'autres contenus — et connaître les types de réponse de FastAPI vous permet de les gérer correctement. **`FileResponse`** est nécessaire pour servir les fichiers et les téléchargements (rapports, images, documents générés), **`StreamingResponse`** est important pour la livraison **efficace en mémoire** des données volumineuses ou continuellement générées (gros exports, diffusion de fichiers, server-sent events — en cédant des chunks plutôt qu'en mettant en mémoire tampon tout ce qui se trouve en mémoire, ce qui importe pour la scalabilité), et `HTMLResponse`/`PlainTextResponse`/`RedirectResponse` gèrent le contenu non-JSON et la navigation. Comprendre les types de réponse disponibles et surtout quand **diffuser en continu** (pour les données volumineuses, pour éviter l'épuisement de la mémoire) par rapport à retourner du JSON est une connaissance pratique pour construire des API qui vont au-delà de simples endpoints JSON — couvrant les téléchargements de fichiers, les exports de données et les réponses volumineuses ou en temps réel qui sont des exigences courantes dans les applications du monde réel.