Për çfarë është response_model?

Question

Accepted Answer

Parametri **`response_model`** deklaron formën e përgjigjes të një endpoint-i. FastAPI e përdor atë për të **validuar, filtruar dhe serializuar** të dhënat e kthyera — dhe për të dokumentuar përgjigjen në dokumentet API. Detyra e tij më e rëndësishme: sigurimi që të ekspozoni vetëm fushat e synuara (p.sh. mos të nxjerr kurrë një fjalëkalim).

## Problemi: nxjerrja e fushave të ndjeshme

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

## Zgjidhja: një model përgjigjeje i veçantë

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

Me `response_model=UserOut`, FastAPI merr atë që ktheni dhe e **filtron poshtë** vetëm në fushat e deklaruara në `UserOut` — kështu që fjalëkalimi (dhe çdo fushë tjetër shtesë) hiqet nga përgjigja, edhe pse kthyet objektin e plotë.

## Ç'bën 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
```

## Alternativë moderne: shënimi i llojit të kthimit

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

## Pse është e rëndësishme

`response_model` është i rëndësishëm për **sigurinë** dhe dizajnin e pastër të API-t.

Roli i tij më kritik është parandalimi i nxjerrjeve aksidentale të të dhënave — duke deklaruar saktësisht cilat fusha duhet të përmbajë përgjigja, FastAPI filtron gjithçka tjetër (si hash-et e fjalëkalimeve, flamujt e brendshëm ose token-at) edhe nëse kodi juaj kthen një objekt të plotë të bazës së të dhënave, duke eleminuar një ranësirë të zakonshme dhe të serioze.

Për më tepër, ai validon përgjigjet tuaja kundrejt një skeme të deklaruar (gjen gabime ku ktheni formën e gabuar), siguron serializimin e saktë dhe dokumenton përgjigjen në dokumentet API-t të gjeneruara automatikisht.

Motivishtja e përdorimit të modeleve të hyrjeve dhe daljeve të veçanta (me `response_model` për të kontrolluar atë që ekspozohet) është një praktikë më e mirë për API-t e sigurta, të përcaktuara mirë, duke e bërë këtë njohuri të rëndësishme për çdo endpoint që kthen të dhëna.