JSON'ın ötesinde hangi yanıt türlerini döndürebilirsiniz?

Question

Accepted Answer

FastAPI varsayılan olarak JSON döndürür (dicts, lists ve Pydantic modellerini serileştirir), ancak farklı ihtiyaçlar için `fastapi.responses` sınıfları aracılığıyla birçok diğer **yanıt türünü** destekler — HTML, dosyalar, akışlar, yönlendirmeler ve düz metin. ## Varsayılan ve yaygın yanıt sınıfları ```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 ``` ## Dosya sunma ```python @app.get("/download") def download(): return FileResponse( "report.pdf", media_type="application/pdf", filename="report.pdf", # prompts a download with this name ) ``` `FileResponse` bir dosyayı diskten verimli bir şekilde sunuyor (başlıkları, içerik türünü işleyerek) — indirmeler, resimler, oluşturulan belgeler için. ## Büyük veya oluşturulan verileri akışla gönderme ```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` bir oluşturucudan verileri kademeli olarak gönderir — **büyük veya sürekli olarak oluşturulan** veriler (büyük dosyalar, CSV dışa aktarımları, canlı akışlar) için gereklidir, böylece hepsini belleğe yüklemenize gerek kalmaz. (Ayrıca Server-Sent Events'in temelini oluşturur.) ## Özel JSON kodlayıcılar (daha hızlı JSON) ```python from fastapi.responses import ORJSONResponse app = FastAPI(default_response_class=ORJSONResponse) # use orjson for faster JSON serialization ``` ## Neden önemli JSON çoğu API yanıtını kapsasa da, gerçek uygulamalar genellikle başka içerik döndürmeye ihtiyaç duyar — ve FastAPI'nin yanıt türlerini bilmek bunları doğru şekilde işlemenizi sağlar. **`FileResponse`** dosya ve indirme sunumu için gereklidir (raporlar, resimler, oluşturulan belgeler), **`StreamingResponse`** **bellek açısından verimli** bir şekilde büyük veya sürekli olarak oluşturulan verilerin teslimi için önemlidir (büyük dışa aktarımlar, dosya akışı, sunucu tarafı olayları — her şeyi bellekte tutmak yerine parçalar halinde vererek, bu ölçeklenebilirlik açısından önemlidir), ve `HTMLResponse`/`PlainTextResponse`/`RedirectResponse` JSON olmayan içeriği ve navigasyonu işler. Mevcut yanıt türlerini, özellikle de **akış** yapılması gereken zamanını (büyük veriler için, bellek tükenmesini önlemek için) JSON döndürmeye karşı anlamak, basit JSON uç noktalarının ötesine giden API'ler oluşturmak için pratik bilgidir — dosya indirmeleri, veri dışa aktarımları ve gerçek dünya uygulamalarında yaygın gereksinimler olan büyük veya gerçek zamanlı yanıtları kapsayan.