Untuk apa `response_model`?

Question

Accepted Answer

Parameter **`response_model`** mendeklarasikan bentuk respons endpoint. FastAPI menggunakannya untuk **memvalidasi, memfilter, dan serialisasi** data yang dikembalikan — dan mendokumentasikan respons di docs API. Tugas paling pentingnya: memastikan Anda hanya mengekspos field yang dimaksud (misalnya jangan pernah membocorkan password).

## Masalah: membocorkan field sensitif

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

## Solusi: model respons terpisah

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

Dengan `response_model=UserOut`, FastAPI mengambil apa pun yang Anda kembalikan dan **menyaringnya** ke hanya field yang dideklarasikan di `UserOut` — sehingga password (dan field tambahan lainnya) dihilangkan dari respons, meskipun Anda mengembalikan objek lengkap.

## Apa yang dilakukan 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
```

## Alternatif modern: anotasi tipe kembalian

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

## Mengapa ini penting

`response_model` penting untuk **keamanan** dan desain API yang bersih.

Peran paling kritisnya adalah mencegah kebocoran data yang tidak disengaja — dengan mendeklarasikan dengan tepat field mana yang harus dimuat respons, FastAPI menyaring segalanya (seperti hash password, flag internal, atau token) bahkan jika kode Anda mengembalikan objek database lengkap, mengeliminasi kerentanan umum dan serius.

Selain itu, ia memvalidasi respons Anda terhadap skema yang dideklarasikan (menangkap bug di mana Anda mengembalikan bentuk yang salah), memastikan serialisasi yang benar, dan mendokumentasikan respons di docs API yang dibuat secara otomatis.

Pola penggunaan model masukan dan keluaran terpisah (dengan `response_model` mengendalikan apa yang diekspos) adalah best practice untuk API yang aman dan terdefinisi dengan baik, menjadikan pengetahuan ini penting untuk endpoint apa pun yang mengembalikan data.