Kif tistruttura applikazzjoni kbira bl-APIRouter?

Question

Accepted Answer

**`APIRouter`** iħallilok taqsam applikazzjoni FastAPI kbira f'moduli multipli — kull router iġbor endpoints relatati (per eżempju, ir-routes `/users` kollha), u l-app prinċipali jinkludihom. Dan iżomm il-codebase li qed tikber organizzata u faċli biex tingħażel.

## Tiddifinixxjoni ta' router fis-module tiegħu stess

```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` jaħdem bħal mini-app — tiddifinixxjoni path operations fuqu bil-istess decorators, u `prefix` japplika għal kollox.

## L-inklużjoni ta' routers fl-app prinċipali

```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()` imonta endpoints ta' kull router fl-app prinċipali — tassembla l-API sħiħ minn biċċ modulari.

## Struttura ta' proġett tipika

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

Kull feature/domain jikseb module router tiegħu — iżomm routes relatati, u l-codebase sabiex ikun organizzat tajjeb.

## Dipendenti u konfigurazzjoni fil-livell tar-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 jistgħu jġorru dipendenti shared (per eżempju, jirrikjedu autentikazon ta' admin għal grupp sħiħ ta' routes) — applika għal endpoints tagħhom kollha f'waħda.

## Għaliex dan huwa importanti

`APIRouter` essenzjali għall-bini tal-kull ħaġa lil hinn minn app FastAPI trivjali — mingħajr, endpoints kollha jridu jkunu f'file wieħed, li jsir immaniġġjabbli bħala API tikber.

L-ħamsa tiegħek tiegħu importanti għal **organizzazzjoni tal-kodiċi u l-maintainability**: taqsim tal-endpoints f'modules router ibbażati fuq il-feature (users, items, auth) iżomm il-kodiċi relatat flimkien, jagħmel il-proġett faċli għan-navigazzjoni, u jħalli l-timijiet jaħdmu f'areas differenti b'mod indipendenti.

`prefix` u `tags` iżommu routes u dokumentazzjoni organizzata, u **dipendenti fil-livell tar-router** (bħal jirrikjedu autentikazon ta' admin għal grupp sħiħ) jagħtu imġieba nettja fil-livell tal-grupp.

Di struttura modulari hija prattika standard għal applikazzjonijiet FastAPI reali, jagħmlu `APIRouter` u l-patterns ta' organizzazzjoni tal-proġett madwaru għarfien importanti, prattikament essenzjali għall-bini ta' APIs skalabbli u faċli biex tingħażel.