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

## நவீன மாற்று: திரும்பப் பெறும் வகை 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 மற்ற அனைத்தையும் (கடவுச்சொல் hash, உள் கொடி அல்லது tokens போன்றவை) வடிகட்டுகிறது, உங்கள் குறியீடு முழு தரவுத்தள பொருளை திரும்பித் தந்தாலும், ஒரு பொதுவான மற்றும் கடுமையான பாதுகாப்பு குறை நீக்க.

தவிர, இது உங்கள் பதிலை ஘ோஷணை செய்யப்பட்ட schema க்கு எதிராக சரிபார்க்கிறது (நீங்கள் தவறான வடிவத்தை திரும்பப் பெற்ற இடங்களில் பிழைகளைப் பிடித்து), சரியான serialization ஐ உறுதி செய்கிறது, மற்றும் தானாக உৎপন்ன API ஆவணங்களில் பதிலை ஆவணப்படுத்துகிறது.

நுழைவு மற்றும் வெளியேறும் மாதிரிகளை (என்ன வெளிப்படுத்தப்படும் என்பதை கட்டுப்படுத்த `response_model` உடன்) பயன்படுத்தும் முறை பாதுகாப்பான, நன்றாக வரையறுக்கப்பட்ட APIs க்கு சிறந்த நடைமுறையாகும், இது தரவை திரும்பப் பெறும் எந்த endpoint க்கும் இந்த ஞ்ஞாணம் முக்கியமாக்குகிறது.