Kwalay ka tsara babbar app tare da APIRouter?

Question

Accepted Answer

**`APIRouter`** yana ba ka damar raba babbar FastAPI app zuwa nau'i da yawa — kowane router yana tara wayoyin da suka danganta (misali, duka `/users` hanya), kuma babbar app sai ta haɗa su. Wannan yana kiyaye girman tushen lambar ajiye da shirewa.

## Saita router a cikin naunin sa

```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` yana aiki kamar mini-app — kana bayyana ayyuka na hanya akan shi tare da kalmomin kayan ado gida, kuma `prefix` yana shafi duka.

## Haɗi routers a cikin babbar app

```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()` yana shigar ayyuka na kowane router zuwa babbar app — tariha cikakken API daga gida da saka.

## Tsarin gida mai yawa

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

Kowane fasali/yanki yana samun naunin router nasa — kiyaye haɗi wayoyin, kuma lambar aiki, sai a shirewa.

## Dogara da saiti a matakin 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 sai da iya ɗauka dogara da gida (misali, bukacin aiki na admin don jimlar hanya) — aiki ga duka ayyuka su a lokaci gida.

## Me take nauyi shi

`APIRouter` wajibi ne don gina wani abu waje da app na FastAPI mara hankali — ba shi, duka ayyuka zasu zauna a cikin fayil gida, wanda zai zama wahala a sarrafa yayin da API ke girma.

Ganewa yawu ne don **tsarin lambar aiki da kula da shikewar**: raba ayyuka zuwa nau'in ɗauki lambar router (masu amfani, items, aiki) kiyaye lambar da ta danganta tare, sai a ɗauko shirin da zai kai, kuma ba tawaye damar aiki a babbar fili.

`prefix` da `tags` kiyaye hanyoyi da cikakken gida shirewa, kuma **dogara a matakin router** (kamar bukacin aiki na admin don jimlar jiya) bada tsarkaciya, gida-jiya halayyar.

An tsarin modular gida tunanin gida ga hakika FastAPI shafuka, sailarin `APIRouter` kuma tsarin ajiye-shirin na gida shi nauyi yawu, aiki-kamata ilimin aiki API mai yawa, kiyaye.