Bạn có thể trả về những loại response nào ngoài JSON?

Question

Accepted Answer

FastAPI trả về JSON mặc định (serialize dict, list, và Pydantic model), nhưng nó hỗ trợ nhiều **loại response** khác cho các nhu cầu khác nhau — HTML, file, stream, redirect, và văn bản thuần — qua các class `fastapi.responses`. ## Response class mặc định và phổ biến ```python from fastapi.responses import ( JSONResponse, HTMLResponse, PlainTextResponse, RedirectResponse, FileResponse, StreamingResponse, ) @app.get("/json") def j(): return {"key": "value"} # mặc định → JSON @app.get("/html", response_class=HTMLResponse) def h(): return "

Hello

" # phục vụ HTML @app.get("/text", response_class=PlainTextResponse) def t(): return "plain text" @app.get("/go") def g(): return RedirectResponse(url="/new-location") # redirect 307 ``` ## Phục vụ file ```python @app.get("/download") def download(): return FileResponse( "report.pdf", media_type="application/pdf", filename="report.pdf", # nhắc tải xuống với tên này ) ``` `FileResponse` phục vụ hiệu quả một file từ đĩa (xử lý header, content type) — cho tải xuống, ảnh, tài liệu được sinh ra. ## Stream dữ liệu lớn hoặc được sinh ra ```python @app.get("/stream") def stream(): def generate(): for i in range(1000000): yield f"line {i} " # yield từng khối — KHÔNG nạp tất cả vào bộ nhớ return StreamingResponse(generate(), media_type="text/plain") ``` `StreamingResponse` gửi dữ liệu từng phần từ một generator — thiết yếu cho dữ liệu **lớn hoặc được sinh liên tục** (file lớn, xuất CSV, feed trực tiếp) để bạn không nạp tất cả vào bộ nhớ cùng một lúc. (Cũng là cơ sở của Server-Sent Events.) ## Bộ mã hóa JSON tùy chỉnh (JSON nhanh hơn) ```python from fastapi.responses import ORJSONResponse app = FastAPI(default_response_class=ORJSONResponse) # dùng orjson cho serialize JSON nhanh hơn ``` ## Tại sao điều này quan trọng Dù JSON bao quát phần lớn response API, ứng dụng thực thường cần trả về nội dung khác — và biết các loại response của FastAPI cho phép bạn xử lý chúng đúng đắn. **`FileResponse`** cần cho việc phục vụ file và tải xuống (báo cáo, ảnh, tài liệu được sinh ra), **`StreamingResponse`** quan trọng cho việc giao dữ liệu lớn hoặc được sinh liên tục một cách **tiết kiệm bộ nhớ** (xuất lớn, stream file, server-sent events — yield từng khối thay vì buffer mọi thứ trong bộ nhớ, điều quan trọng cho khả năng mở rộng), và `HTMLResponse`/`PlainTextResponse`/`RedirectResponse` xử lý nội dung không phải JSON và điều hướng. Hiểu các loại response sẵn có và đặc biệt khi nào nên **stream** (cho dữ liệu lớn, để tránh cạn bộ nhớ) so với trả về JSON là kiến thức thực tiễn để xây dựng API vượt ra ngoài các endpoint JSON đơn giản — bao quát tải xuống file, xuất dữ liệu, và các response lớn hoặc thời gian thực vốn là yêu cầu phổ biến trong ứng dụng thực tế.