آپ APIRouter کے ساتھ بڑی ایپ کو کیسے ترتیب دیتے ہیں؟

Question

Accepted Answer

**`APIRouter`** آپ کو ایک بڑی FastAPI ایپ کو متعدد ماڈیولز میں تقسیم کرنے دیتا ہے — ہر router متعلقہ endpoints کو گروپ کرتا ہے (مثلاً تمام `/users` routes)، اور مین ایپ انہیں شامل کرتی ہے۔ یہ بڑھتے ہوئے codebase کو منظم اور قابلِ دیکھ بھال رکھتا ہے۔

## اپنے ماڈیول میں router کو متعریف کرنا

```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` ایک mini-app کی طرح کام کرتا ہے — آپ اس پر 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()` ہر router کے endpoints کو مین ایپ میں mount کرتا ہے — modular pieces سے مکمل API کو جمع کرتے ہوئے۔

## ایک عام project structure

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

ہر feature/domain کو اپنا router ماڈیول ملتا ہے — متعلقہ routes کو، اور codebase کو، اچھی طرح منظم رکھتے ہوئے۔

## Router-level dependencies اور config

```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 مشترک dependencies کو رکھ سکتے ہیں (مثلاً routes کے پورے گروپ کے لیے admin auth کی ضرورت ہو) — ایک ساتھ تمام endpoints پر لاگو۔

## یہ کیوں اہم ہے

`APIRouter` کسی بھی چیز سے زیادہ سے trivial FastAPI ایپ کے لیے ضروری ہے — اس کے بغیر، تمام endpoints ایک فائل میں رہتے، جو API کے بڑھنے کے ساتھ ناقابلِ انتظام ہو جاتا ہے۔

اس کو سمجھنا **code organization اور maintainability** کے لیے اہم ہے: endpoints کو feature-based router modules (users, items, auth) میں تقسیم کرنا متعلقہ code کو ایک ساتھ رکھتا ہے، project کو قابلِ رفتار بناتا ہے، اور teams کو مختلف شعبوں میں آزادانہ طریقے سے کام کرنے دیتا ہے۔

`prefix` اور `tags` routes اور documentation کو منظم رکھتے ہیں، اور **router-level dependencies** (جیسے پورے گروپ کے لیے admin auth کی ضرورت) صاف، group-wide سلوک فراہم کرتے ہیں۔

یہ modular structure حقیقی FastAPI ایپلیکیشنز کے لیے معیاری طریقہ ہے، `APIRouter` اور اس کے ارد گرد کے project-organization patterns کو عملی، ضروری علم بناتے ہوئے scalable، maintainable APIs بنانے کے لیے۔