Mitä vastaustyppejä voit palauttaa JSON:n lisäksi?

Question

Accepted Answer

FastAPI palauttaa oletuksena JSON:ää (sarjallistaa dicts, lists ja Pydantic models), mutta se tukee monia muita **vastaustyyppejä** eri tarpeisiin — HTML, tiedostot, streamit, uudelleenohjaukset ja tavallinen teksti — `fastapi.responses` luokkien kautta. ## Oletusvastaus- ja yleiset vastausluokat ```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 ``` ## Tiedostojen tarjoaminen ```python @app.get("/download") def download(): return FileResponse( "report.pdf", media_type="application/pdf", filename="report.pdf", # prompts a download with this name ) ``` `FileResponse` tarjoaa tehokkasti tiedoston levyltä (käsittelee otsakkeita, sisältötyyppiä) — latausille, kuville, generoiduille asiakirjoille. ## Suurten tai generoitujen tietojen striimaaminen ```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` lähettää tietoja asteittain generaattorilta — välttämätön **suurille tai jatkuvasti generoiduille** tiedoille (suuret tiedostot, CSV-viennit, suorat syötteet) jotta et lataa kaikkea kerralla muistiin. (Myös Server-Sent Events:in pohja.) ## Mukautetut JSON-koodaajat (nopeampi JSON) ```python from fastapi.responses import ORJSONResponse app = FastAPI(default_response_class=ORJSONResponse) # use orjson for faster JSON serialization ``` ## Miksi se on tärkeää Vaikka JSON kattaa suurimman osan API-vastauksista, oikeat sovellukset tarvitsevat usein palauttaa muuta sisältöä — ja FastAPI:n vastoustyyppien tunteminen antaa sinulle mahdollisuuden käsitellä ne oikein. **`FileResponse`** vaaditaan tiedostojen ja latausten tarjoamiseen (raportit, kuvat, generoidut asiakirjat), **`StreamingResponse`** on tärkeä **muistin tehokkaallle** toimittamiselle suurista tai jatkuvasti generoiduista tiedoista (suuret viennit, tiedostojen striimaaminen, palvelimen lähettämät tapahtumat — tuottaa palasia muistin puskuroimisen sijaan, mikä on tärkeää skaalautuvuuden kannalta), ja `HTMLResponse`/`PlainTextResponse`/`RedirectResponse` käsittelevät ei-JSON sisältöä ja navigointia. Saatavilla olevien vastoustyyppien ymmärtäminen ja erityisesti milloin **striimaata** (suurille tiedoille muistin ehtymisen välttämiseksi) versus palauttaa JSON on käytännön tieto API:en rakentamiseen, jotka ylittävät yksinkertaiset JSON-päätepisteet — kattaen tiedostojen lataukset, tietojen viennit ja suuret tai reaaliaikaiset vastaukset, jotka ovat yleisiä vaatimuksia todellisissa sovelluksissa.