რის დანიშვულებაა 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
```

## თანამედროვე ალტერნატივა: return type annotation

```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 ფილტრავს ყველაფერი სხვა (მაგ. პაროლის ჰეშები, შიდა დროშები ან token-ები) თუნდაც თქვენი კოდი მთელი ბაზის ობიექტი დაუბრუნოს, აღმოფხვრის მეორე და სერიოზული დაუცველობას.

ამას გარდა, ის ვალიდაციას ახდენს რესპონსზე გამოცხადებული სქემის საფუძველზე (დაჭერს ბაგებს სადაც არასწორი ფორმა დაბრუნებულია), უზრუნველყოფს სწორი სერიალიზაციას და დოკუმენტირებს რესპონსს ავტომატურად გენერირებულ API დოკუმენტაციაში.

ცალკე input და output მოდელის გამოყენების სქემა (საც `response_model` აკონტროლებს რა არის ხილული) საუკეთესო ის განმარტება უსაფრთხო, კარგად განსაზღვრული API-ებისთვის, რაც ამ ცოდნას მნიშვნელოვანს ხდის ნებისმიერი ენდპოინტისთვის, რომელიც მონაცემებს დაბრუნებს.