Response Formats
last update: 2025-06-07
FastAPI 支援多種回應資料格式與控制方式，可根據情境回傳 JSON、HTML、純文字、串流、檔案、導向等內容，也能客製化 HTTP 狀態碼與標頭。
1. 預設回應（JSON 格式）
FastAPI 預設會將字典型態資料自動轉換為 JSON：
from fastapi import FastAPI
from fastapi.responses import JSONResponse
app = FastAPI()
@app.get("/json")
def return_json():
return JSONResponse{"message": "這是 JSON 回應"}2. 純文字回應（Plain Text）
使用 PlainTextResponse 回傳純文字：
from fastapi.responses import PlainTextResponse
@app.get("/text")
def return_text():
return PlainTextResponse("這是純文字內容")3. HTML 回應
使用 HTMLResponse 可傳送 HTML 結構給前端：
4. 回傳檔案（FileResponse）
5. 串流資料（StreamingResponse）
使用 StreamingResponse 可用於大量或即時輸出資料：
6. 導向（RedirectResponse）
使用 RedirectResponse 可將請求導向至其他 URL：
此方法常用於導向登入頁面、外部網站或自動轉跳。
7. 回應模型（Response Model）
透過 Pydantic 定義輸出結構，限制欄位與資料類型：
8. 自訂狀態碼與標頭
透過 Response 或 JSONResponse 控制回應狀態與標頭：
小結
回應類型
回傳格式
使用方式
JSON（預設）
dict
直接 return 字典
純文字
str
response_class=PlainTextResponse
HTML
html string
response_class=HTMLResponse
檔案下載
檔案內容
FileResponse(filepath)
串流
產生器輸出
StreamingResponse(generator)
自訂狀態與標頭
JSON 或其他
JSONResponse(..., status_code=..., headers=...)
回應模型（驗證）
Pydantic 模型
response_model=Model
導向
HTTP 302
RedirectResponse(url)
掌握 FastAPI 的各種回應方式，有助於打造符合實際需求的 API 回傳行為，無論是介面整合、前端頁面、檔案服務或大型資料輸出都能靈活應對。
Last updated