Jenis respons apa yang dapat Anda kembalikan selain JSON?

Question

Accepted Answer

FastAPI mengembalikan JSON secara default (menserialisasi dict, list, dan model Pydantic), tetapi mendukung banyak **jenis respons** lain untuk kebutuhan berbeda — HTML, file, stream, redirect, dan plain text — melalui kelas `fastapi.responses`. ## Kelas respons default dan umum ```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 ``` ## Menyajikan file ```python @app.get("/download") def download(): return FileResponse( "report.pdf", media_type="application/pdf", filename="report.pdf", # prompts a download with this name ) ``` `FileResponse` secara efisien menyajikan file dari disk (menangani header, tipe konten) — untuk unduhan, gambar, dokumen yang dihasilkan. ## Streaming data besar atau yang dihasilkan ```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` mengirim data secara bertahap dari generator — penting untuk **data besar atau yang dihasilkan secara berkelanjutan** (file besar, ekspor CSV, feed langsung) sehingga Anda tidak memuatnya semuanya ke memori sekaligus. (Juga dasar dari Server-Sent Events.) ## Encoder JSON khusus (JSON lebih cepat) ```python from fastapi.responses import ORJSONResponse app = FastAPI(default_response_class=ORJSONResponse) # use orjson for faster JSON serialization ``` ## Mengapa ini penting Meskipun JSON mencakup sebagian besar respons API, aplikasi nyata sering perlu mengembalikan konten lain — dan mengetahui jenis respons FastAPI memungkinkan Anda menanganinya dengan benar. **`FileResponse`** diperlukan untuk menyajikan file dan unduhan (laporan, gambar, dokumen yang dihasilkan), **`StreamingResponse`** penting untuk pengiriman yang **efisien memori** dari data besar atau yang dihasilkan secara berkelanjutan (ekspor besar, streaming file, server-sent events — menghasilkan potongan daripada membuffer semuanya di memori, yang penting untuk skalabilitas), dan `HTMLResponse`/`PlainTextResponse`/`RedirectResponse` menangani konten non-JSON dan navigasi. Memahami jenis respons yang tersedia dan khususnya kapan harus **stream** (untuk data besar, menghindari kehabisan memori) versus mengembalikan JSON adalah pengetahuan praktis untuk membangun API yang melampaui endpoint JSON sederhana — mencakup unduhan file, ekspor data, dan respons besar atau real-time yang merupakan persyaratan umum dalam aplikasi dunia nyata.