Jakie typy odpowiedzi możesz zwrócić poza JSON?

Question

Accepted Answer

FastAPI domyślnie zwraca JSON (serializując dicts, listy i modele Pydantic), ale obsługuje wiele innych **response types** do różnych potrzeb — HTML, pliki, strumienie, przekierowania i zwykły tekst — poprzez klasy `fastapi.responses`. ## Domyślne i powszechne klasy odpowiedzi ```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 ``` ## Serwowanie plików ```python @app.get("/download") def download(): return FileResponse( "report.pdf", media_type="application/pdf", filename="report.pdf", # prompts a download with this name ) ``` `FileResponse` efektywnie serwuje plik z dysku (obsługując nagłówki, typ zawartości) — do pobrań, obrazów, generowanych dokumentów. ## Streamowanie dużych lub generowanych danych ```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` wysyła dane przyrostowo z generatora — niezbędne dla **dużych lub stale generowanych** danych (duże pliki, eksporty CSV, transmisje na żywo) aby nie ładować wszystkiego do pamięci na raz. (Także podstawa Server-Sent Events.) ## Niestandardowe kodery JSON (szybszy JSON) ```python from fastapi.responses import ORJSONResponse app = FastAPI(default_response_class=ORJSONResponse) # use orjson for faster JSON serialization ``` ## Dlaczego to ważne Choć JSON obejmuje większość odpowiedzi API, rzeczywiste aplikacje często muszą zwracać inną zawartość — a znajomość response types FastAPI pozwala obsługiwać je prawidłowo. **`FileResponse`** jest potrzebne do serwowania plików i pobierania (raporty, obrazy, generowane dokumenty), **`StreamingResponse`** jest ważne dla **wydajnego pod względem pamięci** dostarczania dużych lub stale generowanych danych (duże eksporty, streaming plików, server-sent events — zwracanie części zamiast buforowania wszystkiego w pamięci, co ma znaczenie dla skalowalności), a `HTMLResponse`/`PlainTextResponse`/`RedirectResponse` obsługują zawartość inną niż JSON i nawigację. Zrozumienie dostępnych response types, a zwłaszcza kiedy **streamować** (dla dużych danych, aby uniknąć wyczerpania pamięci) kontra zwracać JSON jest praktyczną wiedzą do budowania API wykraczających poza proste endpointy JSON — obejmujące pobieranie plików, eksporty danych i duże lubreal-time odpowiedzi, które są powszechnymi wymaganiami w rzeczywistych aplikacjach.