FastAPI 開發完整指南

本文將帶你深入了解 FastAPI 這個現代化的 Python Web 框架,從基礎概念到實際應用。

為什麼選擇 FastAPI?

FastAPI 是近年來最受歡迎的 Python Web 框架之一,它具有以下優勢:

高效能

FastAPI 基於 Starlette 和 Pydantic,性能可以媲美 Node.js 和 Go。根據 TechEmpower 的基準測試,FastAPI 在 Python 框架中名列前茅。

自動文檔生成

框架自動生成符合 OpenAPI 標準的 API 文檔,包括:

Swagger UI
ReDoc
完整的 JSON Schema

類型安全

利用 Python 的類型提示和 Pydantic,在開發階段就能捕捉到許多錯誤。

核心概念

路由與端點

在 FastAPI 中定義路由非常直觀:

from fastapi import FastAPI

app = FastAPI()

@app.get("/items/{item_id}")
async def read_item(item_id: int, q: str = None):
    return {"item_id": item_id, "q": q}

依賴注入系統

FastAPI 的依賴注入系統讓代碼更加模組化和可測試:

from fastapi import Depends

def get_db():
    db = SessionLocal()
    try:
        yield db
    finally:
        db.close()

@app.get("/users/")
async def read_users(db: Session = Depends(get_db)):
    return db.query(User).all()

實戰技巧

資料庫整合

使用 SQLModel 可以無縫整合 SQLAlchemy 和 Pydantic:

定義一次模型,同時用於資料庫和 API
自動的資料驗證
類型安全的查詢

錯誤處理

適當的錯誤處理能提升 API 的可用性:

from fastapi import HTTPException

@app.get("/items/{item_id}")
async def read_item(item_id: int):
    item = db.get(Item, item_id)
    if not item:
        raise HTTPException(status_code=404, detail="Item not found")
    return item

中間件與 CORS

設定 CORS 讓前端能夠安全地呼叫 API:

from fastapi.middleware.cors import CORSMiddleware

app.add_middleware(
    CORSMiddleware,
    allow_origins=["*"],
    allow_credentials=True,
    allow_methods=["*"],
    allow_headers=["*"],
)

部署建議

使用 Docker

容器化部署是現代應用的標準做法:

FROM python:3.11-slim
WORKDIR /app
COPY requirements.txt .
RUN pip install -r requirements.txt
COPY . .
CMD ["uvicorn", "main:app", "--host", "0.0.0.0"]

環境變數管理

使用 Pydantic Settings 管理配置:

從環境變數讀取
支援 .env 檔案
類型驗證

總結

FastAPI 是一個功能強大、易於使用的現代 Web 框架。它的類型安全、自動文檔和高效能特性,使其成為開發 API 的絕佳選擇。

無論是小型專案還是大型應用,FastAPI 都能勝任。

FastAPI 開發完整指南:從入門到實戰