Cad a bhíonn i response_model ann?

Question

Accepted Answer

Deir an paraiméadar **`response_model`** i gcríoch cad é an cruth a bhíonn ag fregra endpoint. Úsáideann FastAPI é chun **na sonraí a bhailítear a bhailíochtú, a scagadh agus a dhéanamh réidh** — agus an fhregra a dhocúmentiú sna docsanna API. An jab is tábhachtaí: a chinntiú nach bhfuil ach na réimsí a bhí beartaithe ann a nochtadh (mar shampla gan focal faire a scaoileadh go deo).

## An fhadhb: réimsí íogair a scaoileadh

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

## An réiteach: samhail fhreagartha ar leith

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

Le `response_model=UserOut`, glacann FastAPI le gach rud a thugann tú ar ais agus **scagann sé síos** go dtí na réimsí amháin a deirtear i `UserOut` — mar sin bainfear an focal faire (agus aon réimse breise eile) ón bhfregra, fiú má thug tú ar ais an réad iomlán.

## Cad a dhéanann 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
```

## Soghma nua-aimseartha: an nóta cineálacha ar an bhfillteach

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

## Cén fáth a bhfuil sé tábhachtach

Tá `response_model` tábhachtach do **dhíolúine** agus dearadh geal API.

Anuas ar gach rud eile, cuireann sé i bhfeidhm bailíochtú ar d'fhreagra i gcomhair scéim fhaisnéise (ag geal na fabhtanna áit a bhíonn tú ag foluain cruth mícheart), cinntíonn sé seirialú ceart, agus docsannaíonn sé an fhregra sna docsanna API a ghintear go huathoibríoch.

Is gearántas go bhfuil an patrún d'úsáid shamhlacha ionchuir agus aschuir ar leith (agus `response_model` ag smachtú ar cad a nochttar) ar bharr an réimse d'fhís API slán, rud a dhéanann an t-eolas seo tábhachtach d'aon endpoint a thugann sonraí ar ais.