**`response_model`** কীসের জন্য?

Question

Accepted Answer

**`response_model`** প্যারামিটার একটি endpoint এর প্রতিক্রিয়ার আকৃতি ঘোষণা করে। FastAPI এটি ব্যবহার করে ফেরত দেওয়া ডেটা **যাচাই, ফিল্টার এবং সিরিয়ালাইজ** করতে — এবং API ডকুমেন্টেশনে প্রতিক্রিয়া নথিভুক্ত করতে। এর সবচেয়ে গুরুত্বপূর্ণ কাজ: নিশ্চিত করা যে আপনি শুধুমাত্র অভিপ্রেত ফিল্ড প্রকাশ করেন (যেমন কখনো পাসওয়ার্ড ফাঁস না করা)।

## সমস্যা: সংবেদনশীল ফিল্ড ফাঁস করা

```python
class User(BaseModel):
    name: str
    email: str
    password: str        # ⚠️ should NEVER be in the response!

@app.get("/users/{id}")
def get_user(id: int) -> User:
    return db.get_user(id)   # returning the full object would expose the password
```

## সমাধান: একটি আলাদা প্রতিক্রিয়া মডেল

```python
class UserOut(BaseModel):    # the SAFE public shape — no password
    name: str
    email: str

@app.get("/users/{id}", response_model=UserOut)
def get_user(id: int):
    return db.get_user(id)   # returns a full user, but FastAPI FILTERS it to UserOut
# response → { "name": "...", "email": "..." }  — password stripped automatically
```

`response_model=UserOut` এর সাথে, FastAPI যাই কিছু আপনি ফেরত দেন তা নিয়ে **শুধুমাত্র সেই ফিল্ডে ফিল্টার করে** যা `UserOut` এ ঘোষিত — তাই পাসওয়ার্ড (এবং অন্য যে কোনো অতিরিক্ত ফিল্ড) প্রতিক্রিয়া থেকে সরিয়ে দেওয়া হয়, যদিও আপনি সম্পূর্ণ অবজেক্ট ফেরত দিয়েছেন।

## response_model কী করে

```text
✓ FILTERS the output to only the declared fields (key for hiding sensitive data)
✓ VALIDATES that your response matches the declared schema (catches mistakes)
✓ SERIALIZES the data to JSON correctly
✓ DOCUMENTS the response shape in the OpenAPI/Swagger docs
```

## আধুনিক বিকল্প: রিটার্ন টাইপ অ্যানোটেশন

```python
@app.get("/users/{id}")
def get_user(id: int) -> UserOut:    # the -> return type works like response_model
    return db.get_user(id)
# response_model_exclude_unset=True → omit fields not explicitly set
```

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

`response_model` **নিরাপত্তা** এবং পরিষ্কার API ডিজাইন উভয়ের জন্যই গুরুত্বপূর্ণ।

এর সবচেয়ে গুরুত্বপূর্ণ ভূমিকা হল অনিচ্ছাকৃত ডেটা লিক প্রতিরোধ করা — প্রতিক্রিয়াটি ঠিক কোন ফিল্ড ধারণ করা উচিত তা ঘোষণা করে, FastAPI অন্য সবকিছু ফিল্টার করে (যেমন পাসওয়ার্ড হ্যাশ, অভ্যন্তরীণ ফ্ল্যাগ, বা টোকেন) এমনকি যদি আপনার কোড একটি সম্পূর্ণ ডেটাবেস অবজেক্ট ফেরত দেয়, একটি সাধারণ এবং গুরুতর দুর্বলতা দূর করে।

এর বাইরে, এটি আপনার প্রতিক্রিয়াগুলি একটি ঘোষিত স্কিমার বিরুদ্ধে যাচাই করে (বাগ ধরে যেখানে আপনি ভুল আকৃতি ফেরত দেন), সঠিক সিরিয়ালাইজেশন নিশ্চিত করে এবং স্বয়ংক্রিয়ভাবে তৈরি API ডকুমেন্টে প্রতিক্রিয়া নথিভুক্ত করে।

আলাদা ইনপুট এবং আউটপুট মডেল ব্যবহার করার প্যাটার্ন (`response_model` দ্বারা নিয়ন্ত্রিত যা উন্মোচিত হয়) নিরাপদ, সুসংজ্ঞায়িত API এর জন্য একটি সেরা অনুশীলন, এটি ডেটা ফেরত দেয় এমন যে কোনো endpoint এর জন্য গুরুত্বপূর্ণ জ্ঞান করে তোলে।