คุณจัดโครงสร้างแอปขนาดใหญ่ด้วย APIRouter ได้อย่างไร?

Question

Accepted Answer

**`APIRouter`** ช่วยให้คุณแบ่งแอป FastAPI ขนาดใหญ่ออกเป็นหลาย modules — แต่ละ router จัดกลุ่ม endpoints ที่เกี่ยวข้องกัน (เช่น routes `/users` ทั้งหมด) และแอปหลักจะ include พวกมัน สิ่งนี้ทำให้ codebase ที่เติบโตขึ้นมีการจัดระเบียบและดูแลง่าย

## การนิยาม router ใน module ของตัวเอง

```python
# routers/users.py
from fastapi import APIRouter

router = APIRouter(
    prefix="/users",          # all routes here start with /users
    tags=["users"],           # grouped under "users" in the docs
)

@router.get("/")              # GET /users/
def list_users(): ...

@router.get("/{user_id}")     # GET /users/{user_id}
def get_user(user_id: int): ...
```

`APIRouter` ทำงานเหมือนแอปย่อย ๆ — คุณนิยาม path operations บนมันด้วย decorators เดียวกัน และ `prefix` จะใช้กับทุกตัว

## การ include routers ในแอปหลัก

```python
# main.py
from fastapi import FastAPI
from routers import users, items, auth

app = FastAPI()
app.include_router(users.router)     # mounts /users/* endpoints
app.include_router(items.router)
app.include_router(auth.router)
```

`app.include_router()` ติดตั้ง endpoints ของแต่ละ router เข้าไปในแอปหลัก — ประกอบ API ที่สมบูรณ์จากชิ้นส่วนแบบ modular

## โครงสร้างโปรเจกต์ทั่วไป

```text
app/
  main.py              # creates the app, includes routers
  routers/
    users.py           # APIRouter for /users
    items.py           # APIRouter for /items
    auth.py            # APIRouter for /auth
  models.py            # Pydantic models
  database.py          # DB setup
  dependencies.py      # shared dependencies
```

แต่ละ feature/domain มี router module ของตัวเอง — ทำให้ routes ที่เกี่ยวข้องและ codebase มีการจัดระเบียบที่ดี

## dependencies และ config ระดับ router

```python
router = APIRouter(
    prefix="/admin",
    dependencies=[Depends(verify_admin)],   # apply a dependency to ALL routes in the router
)
# you can also nest routers via include_router on a router
```

routers สามารถพก dependencies ที่ใช้ร่วมกันได้ (เช่น require admin auth สำหรับกลุ่ม routes ทั้งหมด) — ใช้กับทุก endpoint ของมันในคราวเดียว

## ทำไมจึงสำคัญ

`APIRouter` เป็นสิ่งจำเป็นสำหรับการสร้างแอป FastAPI อะไรก็ตามที่เกินกว่าระดับเล็กน้อย — หากไม่มีมัน endpoints ทั้งหมดจะอยู่ในไฟล์เดียว ซึ่งจะจัดการไม่ได้เมื่อ API เติบโตขึ้น

การเข้าใจมันมีความสำคัญต่อ **การจัดระเบียบโค้ดและความง่ายในการดูแล**: การแบ่ง endpoints ออกเป็น router modules ตาม feature (users, items, auth) ทำให้โค้ดที่เกี่ยวข้องอยู่ด้วยกัน ทำให้โปรเจกต์ค้นหาง่าย และให้ทีมทำงานในส่วนต่าง ๆ ได้อย่างอิสระ

`prefix` และ `tags` ทำให้ routes และเอกสารมีการจัดระเบียบ และ **router-level dependencies** (เช่น การ require admin auth สำหรับกลุ่มทั้งหมด) ให้พฤติกรรมระดับกลุ่มที่สะอาด

โครงสร้างแบบ modular นี้เป็นแนวปฏิบัติมาตรฐานสำหรับแอป FastAPI จริง ทำให้ `APIRouter` และ patterns การจัดระเบียบโปรเจกต์รอบ ๆ มันเป็นความรู้ที่สำคัญและจำเป็นในทางปฏิบัติสำหรับการสร้าง API ที่ขยายขนาดได้และดูแลง่าย