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‌ల కోసం సర్వోత్తమ అభ్యాసం, ఇది ఏదైనా ఎండ్‌పాయింట్ కోసం డేటాను రిటర్న్ చేస్తుందని ఈ జ్ఞానం ముఖ్యమైనది.