Bagaimana Anda menstruktur aplikasi besar dengan APIRouter?

Question

Accepted Answer

**`APIRouter`** memungkinkan Anda membagi aplikasi FastAPI besar menjadi beberapa modul — setiap router mengelompokkan endpoint terkait (misalnya semua rute `/users`), dan aplikasi utama menyertakannya. Ini menjaga basis kode yang berkembang tetap terorganisir dan dapat dimelihara.

## Menentukan router di modul sendiri

```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` berfungsi seperti mini-aplikasi — Anda mendefinisikan operasi path padanya dengan dekorator yang sama, dan `prefix` diterapkan ke semuanya.

## Menyertakan router di aplikasi utama

```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()` memasang endpoint setiap router ke dalam aplikasi utama — merakit API lengkap dari bagian-bagian modular.

## Struktur proyek khas

```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
```

Setiap fitur/domain mendapatkan modul router sendiri — menjaga rute terkait, dan basis kode tetap terorganisir dengan baik.

## Dependensi dan konfigurasi tingkat 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
```

Router dapat membawa dependensi bersama (misalnya memerlukan auth admin untuk seluruh grup rute) — diterapkan ke semua endpoint mereka sekaligus.

## Mengapa ini penting

`APIRouter` sangat penting untuk membangun apa pun di luar aplikasi FastAPI trivial — tanpanya, semua endpoint akan berada dalam satu file, yang menjadi tidak dapat dikelola seiring dengan pertumbuhan API.

Memahaminya penting untuk **organisasi kode dan pemeliharaan**: membagi endpoint menjadi modul router berbasis fitur (pengguna, item, auth) menjaga kode terkait bersama, membuat proyek dapat dinavigasi, dan memungkinkan tim bekerja di area berbeda secara independen.

`prefix` dan `tags` menjaga rute dan dokumentasi tetap terorganisir, dan **dependensi tingkat router** (seperti memerlukan auth admin untuk seluruh grup) menyediakan perilaku yang jelas dan luas grup.

Struktur modular ini adalah praktik standar untuk aplikasi FastAPI nyata, menjadikan `APIRouter` dan pola organisasi proyek di sekitarnya pengetahuan yang penting dan praktis-esensial untuk membangun API yang dapat diskalakan dan dapat dipelihara.