Je, unaipangaje programu kubwa kwa kutumia APIRouter?

Question

Accepted Answer

**`APIRouter`** inakuruhusu kugawanya programu kubwa ya FastAPI kuwa moduli kadhaa — kila router hukusanya endpoints zinazohusiana (k.m. routes zote za `/users`), na programu kuu huzijumuisha. Hii huweka msingi wa msimbo unaokua ukiwa umepangwa na unaodumishika.

## Kufafanua router katika moduli yake mwenyewe

```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` hufanya kazi kama programu ndogo (mini-app) — unafafanua path operations juu yake kwa decorators zile zile, na `prefix` hutumika kwa zote.

## Kujumuisha routers katika programu kuu

```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()` huweka endpoints za kila router ndani ya programu kuu — ukikusanya API nzima kutoka kwa vipande vya kimoduli.

## Muundo wa kawaida wa mradi

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

Kila kipengele/kikoa hupata moduli yake ya router — ikiweka routes zinazohusiana, na msingi wa msimbo, ukiwa umepangwa vizuri.

## Dependencies na config za kiwango cha 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 zinaweza kubeba dependencies za pamoja (k.m. kuhitaji uthibitishaji wa admin kwa kundi zima la routes) — zikitumika kwa endpoints zao zote kwa pamoja.

## Kwa nini ni muhimu

`APIRouter` ni ya lazima kwa kujenga chochote zaidi ya programu ndogo ya FastAPI — bila hiyo, endpoints zote zingekaa katika faili moja, ambalo huwa lisilodhibitika kadiri API inavyokua.

Kuelewa ni muhimu kwa **upangaji wa msimbo na udumishaji**: kugawanya endpoints kuwa moduli za router zenye msingi wa vipengele (users, items, auth) huweka msimbo unaohusiana pamoja, hufanya mradi uweze kuvinjariwa, na kuwawezesha timu kufanya kazi katika maeneo tofauti kwa kujitegemea.

`prefix` na `tags` huweka routes na nyaraka zikiwa zimepangwa, na **dependencies za kiwango cha router** (kama kuhitaji uthibitishaji wa admin kwa kundi zima) hutoa tabia safi ya kundi zima.

Muundo huu wa kimoduli ni utaratibu wa kawaida kwa programu halisi za FastAPI, jambo linalofanya `APIRouter` na mifumo ya upangaji wa mradi kuizunguka kuwa maarifa muhimu na ya lazima kivitendo ya kujenga API zinazoweza kupanuliwa na kudumishika.