Milyen válasz típusokat tudhatsz visszaadni a JSON-en kívül?

Question

Accepted Answer

A FastAPI alapértelmezésben JSON-t ad vissza (dicts, lists és Pydantic modellek szerializálásával), de számos más **válasz típust** támogat különféle igényekhez — HTML, fájlok, streamek, átirányítások és sima szöveg — a `fastapi.responses` osztályokon keresztül. ## Az alapértelmezett és gyakori válasz osztályok ```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 ``` ## Fájlok kiszolgálása ```python @app.get("/download") def download(): return FileResponse( "report.pdf", media_type="application/pdf", filename="report.pdf", # prompts a download with this name ) ``` A `FileResponse` hatékonyan kiszolgál egy fájlt a lemezről (fejlécek és content type kezelésével) — letöltésekhez, képekhez, generált dokumentumokhoz. ## Nagyméretű vagy generált adatok streamelése ```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") ``` A `StreamingResponse` egy generátor által inkrementálisan küld adatokat — lényeges a **nagyméretű vagy folyamatosan generált** adatokhoz (nagy fájlok, CSV exportok, élő feedek), így nem kell az egészet egyszerre a memóriába tölteni. (A Server-Sent Events alapja is.) ## Egyéni JSON kódoló (gyorsabb JSON) ```python from fastapi.responses import ORJSONResponse app = FastAPI(default_response_class=ORJSONResponse) # use orjson for faster JSON serialization ``` ## Miért fontos Bár a JSON a legtöbb API válaszra elegendő, a valós alkalmazásoknak gyakran más tartalmat kell visszaadniuk — és a FastAPI válasz típusainak ismerete lehetővé teszi ezek helyes kezelését. A **`FileResponse`** szükséges fájlok és letöltések kiszolgálásához (jelentések, képek, generált dokumentumok), a **`StreamingResponse`** fontos a nagyméretű vagy folyamatosan generált adatok **memória-hatékony** szállításához (nagy exportok, fájl streamelés, szerver által küldött események — darabok hozamzása ahelyett, hogy az egészet a memóriában pufferolnánk, ami a skálázhatóság szempontjából számít), az `HTMLResponse`/`PlainTextResponse`/`RedirectResponse` pedig a nem JSON tartalom és navigáció kezelésére szolgál. A rendelkezésre álló válasz típusok megértése, és különösen az, hogy mikor kell **streamelni** (nagyméretű adatokhoz, memória kimerülésének elkerüléséhez) versus JSON-t visszaadni, gyakorlati tudás az olyan API-k létrehozásához, amelyek túlmennek az egyszerű JSON végpontokon — fájl letöltéseket, adatexportokat és nagyméretű vagy valós idejű válaszokat fednek le, amelyek a valós alkalmazásoknak szokásos követelményei.