Hvad er `response_model` til?

Question

Accepted Answer

Parameteren **`response_model`** erklærer formen på et endpoints svar. FastAPI bruger det til at **validere, filtrere og serialisere** de returnerede data — og til at dokumentere svaret i API-dokumentationen. Dets vigtigste opgave: sikre at du kun eksponerer de tilsigtede felter (f.eks. aldrig at lække en adgangskode).

## Problemet: lækage af følsomme felter

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

## Løsningen: en separat responsmodel

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

Med `response_model=UserOut` tager FastAPI det, du returnerer, og **filtrerer det ned** til kun de felter, der er erklæret i `UserOut` — så adgangskoden (og eventuelle andre ekstra felter) fjernes fra svaret, selvom du returnerede det fulde objekt.

## Hvad response_model gør

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

## Moderne alternativ: return type-annotationen

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

## Hvorfor det betyder noget

`response_model` er vigtig for både **sikkerhed** og rent API-design.

Dens vigtigste rolle er at forhindre utilsigtet datalækage — ved at erklære præcis hvilke felter svaret skal indeholde, filtrerer FastAPI alt andet ud (som password-hashes, interne flag eller tokens) selv hvis din kode returnerer et fuldt databaseobjekt, hvilket eliminerer en almindelig og alvorlig sårbarhed.

Ud over det validerer det dine svar mod et erklæret skema (som opdager fejl hvor du returnerer den forkerte form), sikrer korrekt serialisering og dokumenterer svaret i den autogenererede API-dokumentation.

Mønsteret med at bruge separate input- og output-modeller (med `response_model`, der kontrollerer hvad der eksponeres) er en best practice for sikre, veldefinerede API'er, hvilket gør denne vigtig viden for ethvert endpoint, der returnerer data.