response_model ਕਿਸ ਲਈ ਹੈ?

Question

Accepted Answer

**`response_model`** ਪੈਰਾਮੀਟਰ ਇੱਕ ਐਂਡਪੋਇੰਟ ਦੇ ਜਵਾਬ ਦੀ ਸ਼ਕਲ ਦਾ ਐਲਾਨ ਕਰਦਾ ਹੈ। FastAPI ਇਸ ਨੂੰ ਵਾਪਸ ਕੀਤੇ ਡੇਟਾ ਨੂੰ **ਪ੍ਰਮਾਣਿਤ, ਫਿਲਟਰ ਅਤੇ ਸੀਰੀਅਲਾਈਜ** ਕਰਨ ਲਈ ਵਰਤਦਾ ਹੈ — ਅਤੇ API ਡਾਕਸ ਵਿੱਚ ਜਵਾਬ ਨੂੰ ਡਾਕਮੈਂਟ ਕਰਦਾ ਹੈ। ਇਸ ਦਾ ਸਭ ਤੋਂ ਮਹੱਤਵਪੂਰਨ ਕੰਮ: ਯਕੀਨੀ ਬਣਾਉਣਾ ਕਿ ਤੁਸੀਂ ਸਿਰਫ ਮੰਤਵ ਅਨੁਸਾਰ ਖੇਤਰ ਖੁਲਾਸਾ ਕਰਦੇ ਹੋ (ਜਿਵੇਂ ਕਦੇ ਪਾਸਵਰਡ ਲੀਕ ਨਹੀਂ ਕਰਦੇ)।

## ਸਮੱਸਿਆ: ਸੰਵੇਦਨਸ਼ੀਲ ਖੇਤਰ ਲੀਕ ਕਰਨਾ

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

## ਹੱਲ: ਵੱਖਰਾ ਜਵਾਬ ਮਾਡਲ

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

`response_model=UserOut` ਨਾਲ, FastAPI ਜੋ ਕੁਝ ਵੀ ਤੁਸੀਂ ਵਾਪਸ ਕਰਦੇ ਹੋ ਉਸ ਨੂੰ ਲੈਂਦਾ ਹੈ ਅਤੇ **ਸਿਰਫ `UserOut` ਵਿੱਚ ਘੋਸ਼ਿਤ ਖੇਤਰਾਂ ਤੱਕ ਇਸ ਨੂੰ ਫਿਲਟਰ ਕਰਦਾ ਹੈ** — ਇਸ ਲਈ ਪਾਸਵਰਡ (ਅਤੇ ਕੋਈ ਹੋਰ ਵਾਧੂ ਖੇਤਰ) ਜਵਾਬ ਤੋਂ ਹਟਾ ਦਿੱਤਾ ਜਾਂਦਾ ਹੈ, ਭਾਵੇਂ ਤੁਸੀਂ ਪੂਰੀ ਆਬਜੈਕਟ ਵਾਪਸ ਕੀਤੀ ਸੀ।

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

## ਆਧੁਨਿਕ ਵਿਕਲਪ: ਰਿਟਰਨ ਟਾਈਪ ਐਨੋਟੇਸ਼ਨ

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

## ਇਹ ਮਹੱਤਵਪੂਰਨ ਕਿਉਂ ਹੈ

`response_model` **ਸੁਰੱਖਿਆ** ਅਤੇ ਸਾਫ਼ API ਡਿਜ਼ਾਈਨ ਦੋਵਾਂ ਲਈ ਮਹੱਤਵਪੂਰਨ ਹੈ।

ਇਸ ਦੀ ਸਭ ਤੋਂ ਗਿਣਤੀ ਭੂਮਿਕਾ ਅਚਾਨਕ ਡੇਟਾ ਲੀਕ ਨੂੰ ਰੋਕਣਾ ਹੈ — ਬਿਲਕੁਲ ਘੋਸ਼ਿਤ ਕਰਨ ਦਾ ਤਰੀਕਾ ਕਿ ਜਵਾਬ ਵਿੱਚ ਕਿਹੜੇ ਖੇਤਰ ਹੋਣੇ ਚਾਹੀਦੇ ਹਨ, FastAPI ਸਭ ਕੁਝ ਹੋਰ (ਜਿਵੇਂ ਪਾਸਵਰਡ ਹੈਸ, ਅੰਦਰੂਨੀ ਫਲੈਗ, ਜਾਂ ਟੋਕਨ) ਫਿਲਟਰ ਕਰਦਾ ਹੈ ਭਾਵੇਂ ਤੁਹਾਡਾ ਕੋਡ ਇੱਕ ਪੂਰਾ ਡੇਟਾਬੇਸ ਆਬਜੈਕਟ ਵਾਪਸ ਕਰਦਾ ਹੈ, ਇੱਕ ਆਮ ਅਤੇ ਗੰਭੀਰ ਕਮਜ਼ੋਰੀ ਨੂੰ ਖਤਮ ਕਰਦਾ ਹੈ।

ਇਸ ਤੋਂ ਬਿਨਾਂ, ਇਹ ਤੁਹਾਡੇ ਜਵਾਬਾਂ ਨੂੰ ਇੱਕ ਘੋਸ਼ਿਤ ਸਕੀਮ ਦੇ ਵਿਰੁੱਧ ਪ੍ਰਮਾਣਿਤ ਕਰਦਾ ਹੈ (ਬੱਗ ਫੜਨਾ ਜਿੱਥੇ ਤੁਸੀਂ ਗਲਤ ਸ਼ਕਲ ਵਾਪਸ ਕਰਦੇ ਹੋ), ਸਹੀ ਸੀਰੀਅਲਾਈਜੇਸ਼ਨ ਯਕੀਨੀ ਬਣਾਉਂਦਾ ਹੈ, ਅਤੇ ਸਵੈਚਾਲਿਤ ਤੌਰ 'ਤੇ ਉਤਪੰਨ API ਡਾਕਸ ਵਿੱਚ ਜਵਾਬ ਨੂੰ ਡਾਕਮੈਂਟ ਕਰਦਾ ਹੈ।

ਵੱਖ-ਵੱਖ ਇਨਪੁਟ ਅਤੇ ਆਊਟਪੁਟ ਮਾਡਲ ਵਰਤਣ ਦਾ ਪੈਟਰਨ (ਜਿਥੇ `response_model` ਨਿਯੰਤਰਣ ਕਰਦਾ ਹੈ ਕਿ ਕੀ ਲਾਹਾਸਾ ਕੀਤਾ ਗਿਆ ਹੈ) ਸੁਰਖਿਅਤ, ਚੰਗੀ-ਪਰਿਭਾਸ਼ਿਤ APIs ਲਈ ਸਰਵੋਤਮ ਅਭਿਆਸ ਹੈ, ਜਿਸ ਨਾਲ ਇਹ ਮਹੱਤਵਪੂਰਨ ਜਾਣਕਾਰੀ ਕਿਸੇ ਵੀ ਐਂਡਪੋਇੰਟ ਲਈ ਹੈ ਜੋ ਡੇਟਾ ਵਾਪਸ ਕਰਦਾ ਹੈ।