`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 માટે શ્રેષ્ઠ પ્રથા છે, તે તમામ એન્ડપોઇન્ટ્સ માટે આ મહત્વપૂર્ણ જ્ઞાન બનાવે છે જે ડેટા પરત કરે છે.