Kokius atsakymo tipus galite grąžinti be JSON?

Question

Accepted Answer

FastAPI pagal numatytuosius nustatymus grąžina JSON (serializuodamas žodynus, sąrašus ir Pydantic modelius), tačiau palaiko daug kitų **atsakymo tipų** įvairiems poreikiams — HTML, failus, srautus, peradresavimus ir grynąjį tekstą — naudodamas `fastapi.responses` klases. ## Numatytosios ir dažnos atsakymo klasės ```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 ``` ## Failų talpinimas ```python @app.get("/download") def download(): return FileResponse( "report.pdf", media_type="application/pdf", filename="report.pdf", # prompts a download with this name ) ``` `FileResponse` efektyviai talpina failą iš disko (tvarkydama antrautes, turinio tipą) — skirta atsisiuntimams, vaizdams, sugeneruotiems dokumentams. ## Didelių arba sugeneruotų duomenų srautavimas ```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` siunčia duomenis žingsniais iš generatoriaus — naudingas **dideliems arba nuolat sugeneruotiems** duomenims (dideli failai, CSV eksportai, tiesioginės transliacijos) taip, kad nereikėtų visų iš karto įkelti į atmintį. (Taip pat Server-Sent Events pagrindas.) ## Pasirinktiniai JSON kodavimo įrenginiai (greitesnis JSON) ```python from fastapi.responses import ORJSONResponse app = FastAPI(default_response_class=ORJSONResponse) # use orjson for faster JSON serialization ``` ## Kodėl tai svarbu Nors JSON apima daugelį API atsakymų, tikrosiose programose dažnai reikia grąžinti kitą turinį — ir žinodami FastAPI atsakymo tipus, galite juos teisingai tvarkyti. **`FileResponse`** reikalinga failams ir atsisiuntimams talpinti (ataskaitoms, vaizdams, sugeneruotiems dokumentams), **`StreamingResponse`** svarbi didelių arba nuolat sugeneruotų duomenų **atmintimi efektyviai** pristatymui (dideli eksportai, failų srautavimas, server-sent events — duodant gabalus vietoj viso duomenų buferinio saugojimo atmintimi, kas svarbu keičiamumui), o `HTMLResponse`/`PlainTextResponse`/`RedirectResponse` tvarkosi su ne-JSON turiniu ir navigacija. Supratimas apie turimus atsakymo tipus ir ypač kada **srautinti** (dideliems duomenims, kad išvengtumėte atminties išsemiimo) arba grąžinti JSON yra praktinis žinojimas API kurimui, kurie eina toliau nei paprasti JSON galapunktai — apimant failų atsisiuntimus, duomenų eksportus ir didelius arba realaus laiko atsakymus, kurie yra bendri reikalavimai tikrosiose programose.