Hvilke responstyper kan du returnere utover JSON?

Question

Accepted Answer

FastAPI returnerer JSON som standard (serialiserer dicts, lister og Pydantic-modeller), men det støtter mange andre **response types** for ulike behov — HTML, filer, strømmer, omdirigeringer og vanlig tekst — via `fastapi.responses` klassene. ## Standardklassene og vanlige responsklasser ```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 av 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 headere, innholdstype) — for nedlastinger, bilder, genererte dokumenter. ## Strømming av store eller genererte 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 trinnvis fra en generator — essensielt for **store eller kontinuerlig genererte** data (store filer, CSV-eksporter, live feeds) slik at du ikke laster alt inn i minnet på en gang. (Også grunnlaget for Server-Sent Events.) ## Tilpassede JSON-kodere (raskere JSON) ```python from fastapi.responses import ORJSONResponse app = FastAPI(default_response_class=ORJSONResponse) # use orjson for faster JSON serialization ``` ## Hvorfor det er viktig Mens JSON dekker de fleste API-svar, har virkelige applikasjoner ofte behov for å returnere annet innhold — og å kjenne FastAPI sine responstyper lar deg håndtere disse korrekt. **`FileResponse`** trengs for å servere filer og nedlastinger (rapporter, bilder, genererte dokumenter), **`StreamingResponse`** er viktig for **minneeffektiv** levering av store eller kontinuerlig genererte data (store eksporter, filstrømming, server-sendt events — yielding av biter i stedet for å bufre alt i minnet, som er viktig for skalering), og `HTMLResponse`/`PlainTextResponse`/`RedirectResponse` håndterer ikke-JSON innhold og navigasjon. Å forstå de tilgjengelige responsstypene og særlig når man skal **streame** (for store data for å unngå minnetømmelse) kontra returnere JSON er praktisk kunnskap for bygging av APIer som går utover enkle JSON-endepunkter — som dekker filnedlastinger, dataeksporter og store eller sanntids-svar som er vanlige krav i virkelige applikasjoner.