Jaké typy odpovědí můžete vrátit mimo JSON?

Question

Accepted Answer

FastAPI ve výchozím nastavení vrací JSON (serializuje dicts, lists a Pydantic models), ale podporuje mnoho dalších **typů odpovědí** pro různé potřeby — HTML, soubory, streamy, přesměrování a prostý text — prostřednictvím tříd `fastapi.responses`. ## Výchozí a běžné třídy odpovědí ```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 ``` ## Obsluha souborů ```python @app.get("/download") def download(): return FileResponse( "report.pdf", media_type="application/pdf", filename="report.pdf", # prompts a download with this name ) ``` `FileResponse` efektivně obsluhuje soubor z disku (zpracovává záhlaví, typ obsahu) — pro stahování, obrázky, generované dokumenty. ## Streamování velkých nebo generovaných dat ```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` odesílá data postupně z generátoru — nezbytná pro **velká nebo nepřetržitě generovaná** data (velké soubory, CSV exporty, živá data) aby jste je nemuseli najednou načítat do paměti. (Také základ Server-Sent Events.) ## Vlastní JSON kodéry (rychlejší JSON) ```python from fastapi.responses import ORJSONResponse app = FastAPI(default_response_class=ORJSONResponse) # use orjson for faster JSON serialization ``` ## Proč to je důležité Ačkoli JSON pokrývá většinu odpovědí API, skutečné aplikace často potřebují vrátit jiný obsah — a znalost typů odpovědí FastAPI vám umožní je správně zpracovat. **`FileResponse`** je potřebná pro obsluhu souborů a stahování (zprávy, obrázky, generované dokumenty), **`StreamingResponse`** je důležitá pro **paměť efektivní** doručování velkých nebo nepřetržitě generovaných dat (velké exporty, streamování souborů, server-sent events — generování částí místo ukládání všeho v paměti, což je důležité pro škálovatelnost), a `HTMLResponse`/`PlainTextResponse`/`RedirectResponse` zpracovávají obsah mimo JSON a navigaci. Porozumění dostupným typům odpovědí a zejména tomu, kdy **streamovat** (pro velká data, aby se předešlo vyčerpání paměti) versus vrátit JSON, je praktická znalost pro tvorbu API, která přesahují jednoduché JSON endpointy — pokrývající stahování souborů, exporty dat a velké nebo real-time odpovědi, které jsou běžné požadavky v reálných aplikacích.