response_model ni nini?

Question

Accepted Answer

Kigezo **`response_model`** kinachonya sura ya jibu la mwisho. FastAPI inatumia ili **kuthibitisha, kuchuja na kusambaza** data inayorejezwa — na kuandika jibu katika hati za API. Kazi yake muhimu zaidi: kuhakikisha kwamba unafichua tu sehemu zilizokusudiwa (mfano, usitokeze kosa kwa asili).

## Tatizo: kutokwa kwa sehemu nyeti

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

## Suluhisho: mfano wa jibu tofauti

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

Na `response_model=UserOut`, FastAPI inachukua kile unachorejeeza na **kuchuja chini** hadi sehemu tu zilizoachibiwa katika `UserOut` — kwa hivyo nenosiri (na sehemu zingine za ziada) huondolewa kutoka jibu, hata kama ulirejeeza kitu kamili.

## Nini response_model inayofanya

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

## Mbadala ya kisasa: aini ya kurejeeza 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
```

## Kwa nini ni muhimu

`response_model` ni muhimu kwa **usalama** na muundo safi wa API.

Roli yake muhimu zaidi ni kuzuia kutokwa kwa data bila kukamatia — kwa kuchagua sawa sehemu gani jibu linapaswa kuwa na, FastAPI inaondoa kila kitu kingine (kama mfumo wa nenosiri, bendera za ndani au tokens) hata kama nambari yako inajezesha kitu kamili cha hifadhi ya data, kuondoa hatari ya kawaida na kali.

Zaidi ya yake, inathibitisha majibu yako kwa schema iliyochibiwa (kupata matatizo ambapo unarejeza sura isiyo sahihi), kuhakikisha mabadilisho sahihi, na kuandika jibu katika hati za API zilizotolewa kiajili.

Kipengele cha kutumia mifano tofauti ya kuingia na kutoka (na `response_model` ikikamatia kile kinachoonyeshwa) ni desturi nzuri kwa APIs salama, zilizofafanuliwa vizuri, kufanya ujumbe huu muhimu kwa mwisho wowote unayerejeeza data.