Conas a dhéanann tú struchtúr ar fheidhmchlár mór le APIRouter?

Question

Accepted Answer

**`APIRouter`** a fhágann tú do dhroichead fheidhmchlár FastAPI mór a roinnt ina modúlacha iolracha — gach ródaí a dhéanann grúpa ar dheighealtas a bhaineann leis (mar shampla, gach fhreagairt `/users`), agus an phríomhfheidhmchlár a chuimsíonn iad. Fhágann sé seo bunús cód fáss a choinneáil eagraithe agus inbhuanaithe.

## Ródaire a dhíníonn ina mhodúl féin

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

Oibreann `APIRouter` cosúil le mini-fheidhmchlár — déanann tú oibríochtaí cosáin a dhíníonn air le na braistintí céanna, agus cuireadh `prefix` i bhfeidhm ar gach ceann acu.

## Ródairí a chur san áireamh san bhfeidhmchlár príomh

```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()` a dhéanann fhreagairt gach ródaí a thiomsú isteach san bhfeidhmchlár príomh — ag cur an API iomlán le chéile ó phíosaí modúlach.

## Struchtúr tionscadail tipiciúil

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

Faigheann gach gné/fearann a mhodúl ródaí féin — ag coinneáil ar bhealach slí agus an bunús cód, go maith-eagraithe.

## Spleáchais agus cumraitheach ag leibhéal an ródaí

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

Is féidir le ródairí spleáchais roinnte a iompar (mar shampla, a bheith ag iarraidh fíordheimhnithe riarachán d'fhear iomlán de bhealach) — i bhfeidhm ar gach ceann acu ar a n-iomlán.

## Cén fáth a bhíonn sé tábhachtach

`APIRouter` tá sé riachtanach chun rud ar bith a thógáil níos túisce ná feidhmchlár FastAPI fánach — gan é, bheadh gach fhreagairt i bhFileachán amháin, rud a bhíonn doiligh a bhainistiú de réir mar a dhéanann an API fás.

Tá sé tábhachtach a thuiscint do **eagrú an chóid agus inbhuanaitheacht**: scairt ar fhreagairt i modúlacha ródaí bunaithe ar ghné (úsáideoirí, míreanna, fíordheimhniú) a choinneáil cód gaolmhar le chéile, an tionscadal a dhéanamh inmharcála, agus fóireann a ligean ar oibríochtaí ar limistéir éagsúla go neamhspleách.

An `prefix` agus `tags` a choinneáil ar bhealach agus ar dhocúmantú eagraithe, agus **spleáchais ag leibhéal an ródaí** (cosúil le fiordheimhniú a iarraidh d'fhócas iomlán) soláthar iompar geal agus leathan-grúpa.

Tá an struchtúr modúlach seo ina chleachtas caighdeánach do dhrochlíonadh FastAPI fíor, agus `APIRouter` agus na patrún eagrúcháin thionscadail timpeall air ina ghné thábhachtach, i ndáiríre ar chóir gur eol do thógáil API inmharcála, inmharcála.