Si e strukturoni një aplikacion të madh me APIRouter?

Question

Accepted Answer

**`APIRouter`** ju lejon të ndani një aplikacion të madh FastAPI në module të shumta — çdo router grupëzon endpoints të lidhura (p.sh. të gjithë rrugat `/users`), dhe aplikacioni kryesor i përfshin ato. Kjo mbëp një bazë kodi në rritje të organizuar dhe të lehtë për t'u mirëmbartur.

## Përcaktimi i një router-i në modulin e vet

```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): ...
```

Një `APIRouter` funksionon si një mini-aplikacion — përcaktoni operacionet e rrugës në të me të njëjtët dekorues, dhe një `prefix` zbatohet në të gjithë ato.

## Përfshirja e routerëve në aplikacionin kryesor

```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()` monton endpoints e secilit router në aplikacionin kryesor — montimin e API-t të plotë nga copëzat modulare.

## Një struktura tipike e projektit

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

Secilin feature/domain merr modulin e vet të router-it — duke mbajtur rrugat e lidhura, dhe bazën e kodit, mirë të organizuar.

## Varësitë dhe konfigurimi në nivel router-i

```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ët mund të mbajnë varësi të ndara (p.sh. kërkojnë autentifikimin e administratorit për të gjithë grupin e rrugave) — aplikuar në të gjithë endpoints-et e tyre në një herë.

## Pse ka rëndësi

`APIRouter` është thelbësor për ndërtimin e ndonjë aplikacioni më larg një aplikacioni trivial FastAPI — pa të, të gjithë endpoints do të jeteshin në një skedar, që bëhet i pamenaxhueshëm ndërsa API-t rritet.

Kuptimi i tij është i rëndësishëm për **organizimin e kodit dhe lehtësinë e mirëmbartjes**: ndarja e endpoints në module routerësh të bazuar në feature (përdoruesit, artikujt, autentifikimi) mbë kodin e lidhur së bashku, bën projektin të navigueshem, dhe lejon ekipet të punojnë në zona të ndryshme në mënyrë të pavarur.

`prefix` dhe `tags` mbajnë rrugat dhe dokumentacionin të organizuar, dhe **varësitë në nivel router-i** (si kërkesa për autentifikimin e administratorit për të gjithë grupin) ofrojnë sjellje të pastër në të gjithë grupin.

Ky struktur modular është praktika standarde për aplikacionet reale FastAPI, duke bërë `APIRouter` dhe modelet e organizimit të projektit rreth tij njohuri të rëndësishme, praktikisht thelbësore për ndërtimin e API-ve të skejabël dhe të lehtë për t'u mirëmbartur.