response_model हे कशासाठी आहे?

Question

Accepted Answer

**`response_model`** पॅरामीटर एक endpoint च्या प्रतिक्रियेचा आकार जाहीर करते. FastAPI हे **सत्यापन, फिल्टर करण्यासाठी आणि सीरिअलाइज करण्यासाठी** परत केलेला डेटा वापरते — आणि API docs मध्ये प्रतिक्रिया दस्तऐवज करण्यासाठी. याचे सर्वात महत्वाचे काम: केवळ हेतू असलेले फील्ड उघड करणे सुनिश्चित करणे (उदा. पासवर्ड कधीही लीक होऊ नये).

## समस्या: संवेदनशील फील्ड लीक होणे

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

## आधुनिक पर्याय: परत आने प्रकार annotation

```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 इतर सर्व काही फिल्टर करते (जसे पासवर्ड हॅशेस, अंतर्गत फ्लॅग किंवा token) जरी तुमचा कोड संपूर्ण डेटाबेस ऑब्जेक्ट परत केला तरी, एक सामान्य आणि गंभीर असुरक्षितता दूर करते.

याच्या बाहेर, हे घोषित स्कीमाविरुद्ध तुमच्या प्रतिक्रियांचे सत्यापन करते (जेथे तुम्ही चुकीचे आकार परत करता तेथे बग पकडणे), योग्य सीरिअलाइজेशन सुनिश्चित करते, आणि स्वयंचलित-निर्मित API docs मध्ये प्रतिक्रिया दस्तऐवज करते.

वेगळ्या input आणि output models वापरण्याचे नमुना (`response_model` नियंत्रण करते काय उघड होते) सुरक्षित, सुस्पष्टपणे परिभाषित APIs साठी सर्वोत्तम सराव आहे, हे ज्ञान कोणत्याही endpoint साठी महत्वाचे बनवते जे डेटा परत करते.