Welke antwoordtypen kun je retourneren buiten JSON?

Question

Accepted Answer

FastAPI retourneert standaard JSON (serialiseert dicts, lists en Pydantic-modellen), maar ondersteunt veel andere **response types** voor verschillende behoeften — HTML, files, streams, redirects en plaintext — via de `fastapi.responses` klassen. ## De standaard en veelgebruikte response-klassen ```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 ``` ## Files serveren ```python @app.get("/download") def download(): return FileResponse( "report.pdf", media_type="application/pdf", filename="report.pdf", # prompts a download with this name ) ``` `FileResponse` serveert efficiënt een bestand van schijf (headers en inhoudstype afhandelen) — voor downloads, afbeeldingen en gegenereerde documenten. ## Het streamen van grote of gegenereerde gegevens ```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` stuurt gegevens incrementeel vanuit een generator — essentieel voor **grote of continu gegenereerde** gegevens (grote bestanden, CSV-exports, live feeds) zodat je alles niet in één keer in geheugen laadt. (Ook de basis van Server-Sent Events.) ## Aangepaste JSON-encoders (sneller JSON) ```python from fastapi.responses import ORJSONResponse app = FastAPI(default_response_class=ORJSONResponse) # use orjson for faster JSON serialization ``` ## Waarom het belangrijk is Hoewel JSON de meeste API-antwoorden dekt, hebben praktische toepassingen vaak andere inhoud nodig — en het kennen van FastAPI's response types stelt je in staat deze correct af te handelen. **`FileResponse`** is nodig voor het serveren van bestanden en downloads (rapporten, afbeeldingen, gegenereerde documenten), **`StreamingResponse`** is belangrijk voor **geheugenefficiënte** levering van grote of continu gegenereerde gegevens (grote exports, bestandstreaming, server-sent events — chunks opleveren in plaats van alles in het geheugen bufferen, wat van belang is voor schaalbaarheid), en `HTMLResponse`/`PlainTextResponse`/`RedirectResponse` verwerken niet-JSON-inhoud en navigatie. De beschikbare response types begrijpen en vooral wanneer je **streamt** (voor grote gegevens om geheugenuitputting te vermijden) versus JSON retourneert is praktische kennis voor het bouwen van API's die verder gaan dan eenvoudige JSON-eindpunten — dekking van bestandsdownloads, gegevensexports en grote of realtime-antwoorden die veel voorkomen in praktische toepassingen.