Πώς δομείτε μια μεγάλη εφαρμογή με APIRouter;

Question

Accepted Answer

**`APIRouter`** σας επιτρέπει να χωρίσετε μια μεγάλη FastAPI εφαρμογή σε πολλά modules — κάθε router ομαδοποιεί σχετικά endpoints (π.χ. όλες τις διαδρομές `/users`), και η κύρια εφαρμογή τα περιλαμβάνει. Αυτό διατηρεί μια αυξανόμενη βάση κώδικα οργανωμένη και συντηρήσιμη.

## Ορισμός ενός 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` εφαρμόζεται σε όλα αυτά.

## Συμπερίληψη 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 από αρθρωτά κομμάτια.

## Μια τυπική δομή έργου

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

Κάθε χαρακτηριστικό/τομέας λαμβάνει το δικό του module router — διατηρεί τις σχετικές διαδρομές και τη βάση κώδικα καλά οργανωμένη.

## Εξαρτήσεις και ρύθμιση σε επίπεδο 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
```

Oι routers μπορούν να φέρουν κοινές εξαρτήσεις (π.χ. απαίτηση admin auth για ολόκληρη ομάδα διαδρομών) — εφαρμόζονται σε όλα τα endpoints τους ταυτόχρονα.

## Γιατί είναι σημαντικό

`APIRouter` είναι απαραίτητο για την κατασκευή οτιδήποτε πέρα από μια τετριμμένη FastAPI εφαρμογή — χωρίς αυτό, όλα τα endpoints θα ζούσαν σε ένα αρχείο, το οποίο γίνεται δυσδιάχυτο καθώς το API μεγαλώνει.

Η κατανόηση του είναι σημαντική για **οργάνωση κώδικα και συντηρησιμότητα**: η διαχώρηση endpoints σε modules router βασισμένα σε χαρακτηριστικά (χρήστες, στοιχεία, auth) διατηρεί τον σχετικό κώδικα μαζί, κάνει το έργο περιηγήσιμο και επιτρέπει στις ομάδες να εργάζονται ανεξάρτητα σε διαφορετικές περιοχές.

Το `prefix` και `tags` διατηρούν τις διαδρομές και την τεκμηρίωση οργανωμένες, και οι **εξαρτήσεις σε επίπεδο router** (όπως απαίτηση admin auth για ολόκληρη ομάδα) παρέχουν καθαρή, συμπεριφορά σε επίπεδο ομάδας.

Αυτή η αρθρωτή δομή είναι τυπική πρακτική για πραγματικές εφαρμογές FastAPI, καθιστώντας το `APIRouter` και τα πρότυπα οργάνωσης έργου γύρω του σημαντική, πρακτικά ουσιώδη γνώση για την κατασκευή επεκτάσιμων, συντηρήσιμων API.