আপনি APIRouter দিয়ে একটি বড় অ্যাপ কীভাবে গঠন করেন?

Question

Accepted Answer

**`APIRouter`** আপনাকে একটি বড় FastAPI অ্যাপকে একাধিক মডিউলে ভাগ করতে দেয় — প্রতিটি রাউটার সম্পর্কিত endpoints গোষ্ঠীবদ্ধ করে (যেমন সমস্ত `/users` রুট), এবং মূল অ্যাপ সেগুলি অন্তর্ভুক্ত করে। এটি একটি ক্রমবর্ধমান কোডবেস সংগঠিত এবং রক্ষণাবেক্ষণযোগ্য রাখে।

## একটি নিজস্ব মডিউলে একটি রাউটার সংজ্ঞায়িত করা

```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` একটি মিনি-অ্যাপের মতো কাজ করে — আপনি একই decorators দিয়ে এতে path operations সংজ্ঞায়িত করেন, এবং একটি `prefix` সবগুলিতে প্রয়োগ হয়।

## মূল অ্যাপে রাউটারগুলি অন্তর্ভুক্ত করা

```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 মূল অ্যাপে মাউন্ট করে — মডুলার টুকরা থেকে সম্পূর্ণ 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
```

প্রতিটি বৈশিষ্ট্য/ডোমেন নিজস্ব রাউটার মডিউল পায় — সম্পর্কিত রুটগুলি রাখে, এবং কোডবেসকে সুসংগঠিত রাখে।

## রাউটার-স্তরের নির্ভরতা এবং কনফিগ

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

রাউটারগুলি ভাগ করা নির্ভরতা বহন করতে পারে (উদাহরণস্বরূপ রুটের একটি সম্পূর্ণ গোষ্ঠীর জন্য admin auth প্রয়োজন) — একবারে তাদের সমস্ত endpoints এ প্রয়োগ করা হয়।

## এটি কেন গুরুত্বপূর্ণ

`APIRouter` একটি তুচ্ছ FastAPI অ্যাপের বাইরে কিছু তৈরির জন্য অপরিহার্য — ছাড়া, সমস্ত endpoints একটি ফাইলে থাকবে, যা API বৃদ্ধির সাথে সাথে অপরিচালনাযোগ্য হয়ে ওঠে।

এটি বোঝা **কোড সংগঠন এবং রক্ষণাবেক্ষণযোগ্যতার** জন্য গুরুত্বপূর্ণ: endpoints কে বৈশিষ্ট্য-ভিত্তিক রাউটার মডিউলে ভাগ করা (ব্যবহারকারী, আইটেম, প্রমাণীকরণ) সম্পর্কিত কোড একসাথে রাখে, প্রকল্পকে নেভিগেট করা সহজ করে, এবং দলগুলিকে স্বাধীনভাবে বিভিন্ন ক্ষেত্রে কাজ করতে দেয়।

`prefix` এবং `tags` রুট এবং ডকুমেন্টেশন সংগঠিত রাখে, এবং **রাউটার-স্তরের নির্ভরতা** (যেমন রুটের একটি সম্পূর্ণ গোষ্ঠীর জন্য admin auth প্রয়োজন) পরিষ্কার, গোষ্ঠী-ব্যাপী আচরণ প্রদান করে।

এই মডুলার কাঠামো বাস্তব FastAPI অ্যাপ্লিকেশনগুলির জন্য মান অনুশীলন, যা `APIRouter` এবং এর চারপাশের প্রকল্প-সংগঠন নিদর্শনগুলিকে স্কেলেবল, রক্ষণাবেক্ষণযোগ্য APIs তৈরির জন্য গুরুত্বপূর্ণ, ব্যবহারিকভাবে অপরিহার্য জ্ঞান করে তোলে।