Hvilke svartyper kan du returnere ud over JSON?

Question

Accepted Answer

FastAPI returnerer JSON som standard (serialiserer dicts, lists og Pydantic models), men det understøtter mange andre **svartyper** til forskellige behov — HTML, filer, streams, omdirigeringer og almindelig tekst — via klasserne i `fastapi.responses`. ## Standard- og almindelige svarklasser ```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 ``` ## Servering af filer ```python @app.get("/download") def download(): return FileResponse( "report.pdf", media_type="application/pdf", filename="report.pdf", # prompts a download with this name ) ``` `FileResponse` serverer effektivt en fil fra disk (håndterer headers, indholdstype) — til downloads, billeder, genererede dokumenter. ## Streaming af store eller genererede data ```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` sender data trinvist fra en generator — vigtig for **store eller kontinuerligt-genererede** data (store filer, CSV-eksporter, live feeds) så du ikke indlæser alt i hukommelsen på én gang. (Også grundlaget for Server-Sent Events.) ## Brugerdefinerede JSON-encoders (hurtigere JSON) ```python from fastapi.responses import ORJSONResponse app = FastAPI(default_response_class=ORJSONResponse) # use orjson for faster JSON serialization ``` ## Hvorfor det betyder noget Selvom JSON dækker de fleste API-svar, har virkelige applikationer ofte brug for at returnere andet indhold — og at kende FastAPI's svartyper lader dig håndtere disse korrekt. **`FileResponse`** er nødvendig til at servere filer og downloads (rapporter, billeder, genererede dokumenter), **`StreamingResponse`** er vigtig for **hukommelses-effektiv** levering af store eller kontinuerligt-genererede data (store eksporter, filstreaming, server-sent events — afgivelse af bidder i stedet for at gemme alt i hukommelsen, hvilket betyder noget for skalerbarhed), og `HTMLResponse`/`PlainTextResponse`/`RedirectResponse` håndterer ikke-JSON indhold og navigation. At forstå de tilgængelige svartyper og især hvornår man skal **streame** (til store data, for at undgå hukommelsesfuldstændig) versus returnere JSON er praktisk viden til at bygge API'er der går ud over simple JSON-endpoints — dækkende fildownloads, dataeksporter og store eller real-time svar, som er almindelige krav i virkelige applikationer.