response_model को उद्देश्य के हो?

Question

Accepted Answer

**`response_model`** प्यारामिटरले एन्डपोइन्टको प्रतिक्रियाको आकार घोषणा गर्छ। 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 को लागि सर्वश्रेष्ठ अभ्यास हो, यो डेटा फर्काउने कुनै पनि एन्डपोइन्टको लागि महत्त्वपूर्ण ज्ञान बनाउँछ।