Apakah jenis respons yang boleh anda kembalikan selain JSON?

Question

Accepted Answer

FastAPI mengembalikan JSON secara lalai (menserialisasi dicts, lists, dan model Pydantic), tetapi mendukung banyak **jenis respons** lain untuk kebutuhan berbeda — HTML, file, streams, pengalihan, dan teks biasa — melalui kelas `fastapi.responses`. ## Kelas respons lalai 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 ``` ## Melayani 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` melayani file dari disk dengan cekap (menangani header, jenis konten) — untuk muat turun, gambar, dokumen yang dijana. ## Penstriman data besar atau yang dijana ```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` menghantar data secara tambahan dari penjana — penting untuk data **besar atau yang dijana secara berterusan** (file besar, ekspor CSV, umpan langsung) supaya anda tidak memuatkannya semua ke dalam memori sekaligus. (Juga asas Server-Sent Events.) ## Penyandi 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 Walaupun JSON meliputi kebanyakan respons API, aplikasi sebenar sering perlu mengembalikan kandungan lain — dan mengetahui jenis respons FastAPI membolehkan anda mengendalikannya dengan betul. **`FileResponse`** diperlukan untuk melayani file dan muat turun (laporan, gambar, dokumen yang dijana), **`StreamingResponse`** penting untuk penghantaran **cekap memori** data besar atau yang dijana secara berterusan (ekspor besar, penstriman file, server-sent events — menghasilkan bahagian daripada menimbal semuanya ke dalam memori, yang penting untuk kebolehskalaan), dan `HTMLResponse`/`PlainTextResponse`/`RedirectResponse` mengendalikan kandungan bukan JSON dan navigasi. Memahami jenis respons yang tersedia dan terutamanya apabila **aliran** (untuk data besar, untuk mengelakkan kehabisan memori) berbanding mengembalikan JSON adalah pengetahuan praktikal untuk membina API yang melampaui titik akhir JSON yang ringkas — meliputi muat turun file, ekspor data, dan respons besar atau masa nyata yang merupakan keperluan biasa dalam aplikasi dunia sebenar.