Vilka svarstyper kan du returnera bortom JSON?

Question

Accepted Answer

FastAPI returnerar JSON som standard (serialiserar dictionaries, listor och Pydantic-modeller), men det stöder många andra **svarstyper** för olika behov — HTML, filer, strömmar, omdirigeringar och vanlig text — via klasserna i `fastapi.responses`. ## Standard- och vanliga svarsklasser ```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 ``` ## Servera 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` serverar effektivt en fil från disk (hanterar headers, innehållstyp) — för nedladdningar, bilder, genererade dokument. ## Strömma stora eller genererade 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` skickar data inkrementellt från en generator — väsentligt för **stora eller kontinuerligt genererade** data (stora filer, CSV-exporter, direktsändningar) så att du inte laddar allt i minnet på en gång. (Också grunden för Server-Sent Events.) ## Anpassade JSON-kodare (snabbare JSON) ```python from fastapi.responses import ORJSONResponse app = FastAPI(default_response_class=ORJSONResponse) # use orjson for faster JSON serialization ``` ## Varför det är viktigt Eftersom JSON täcker de flesta API-svar behöver verkliga applikationer ofta returnera annat innehål — och att känna till FastAPIs svarstyper låter dig hantera dessa korrekt. **`FileResponse`** behövs för att servera filer och nedladdningar (rapporter, bilder, genererade dokument), **`StreamingResponse`** är viktig för **minneseffektiv** leverans av stora eller kontinuerligt genererade data (stora exporter, filströmning, server-sent events — som ger bitar istället för att buffra allt i minnet, vilket är viktigt för skalbarhet), och `HTMLResponse`/`PlainTextResponse`/`RedirectResponse` hanterar innehål och navigering utan JSON. Att förstå tillgängliga svarstyper och särskilt när man ska **strömma** (för stora data, för att undvika minnesöverbelastning) kontra returnera JSON är praktisk kunskap för att bygga API:er som går bortom enkla JSON-slutpunkter — täcker filnedladdningar, dataexporter och stora eller realtidsresponser som är vanliga krav i verkliga applikationer.