[FastAPI] 모델

 

🐰 FastAPI 공식문서를 보면서 개인적으로 정리한 글 입니다.

 

응답 모델

FastAPI는 response_model을 사용하여 응답을 위한 모델을 선언할 수 있다.

• @app.get()
• @app.post()
• @app.put()
• @app.delete()
• Etc

 

response_model을 사용하면 다음과 같은 이점을 얻는다.

• 출력 데이터를 타입 선언으로 변환
• 데이터 검증
• OpenAPI 경로 작동의 응답에 JSON 스키마 추가
• 자동 생성 문서 시스템에 사용
• 해당 모델의 출력 데이터 제한

from typing import Any, Union
from fastapi import FastAPI
from pydantic import BaseModel, EmailStr

app = FastAPI()

# SignIn model


class UserIn(BaseModel):
    usename: str
    password: str  # 실제 패스워드는 절대 평문작성 X
    email: EmailStr
    full_name: Union[str, None] = None

# User Info Output


class UserOut(BaseModel):
    username: str
    email: EmailStr
    full_name: Union[str, None] = None

# reponse_model에 UseOut 모델로 선언했기 때문에
# 비밀번호를 포함하지 않은 값을 응답함.


@app.post('/user/', response_model=UserOut)
async def create_user(user: UserIn) -> Any:
    return user

 

이처럼 response_model에 모델을 지정하면 보여주고 싶은 응답값만 필터링해서 보여줄 수 있다.

 

추가로 response_model_exclude_unset을 사용하여 응답 모델에서 unset상태(값이 할당되지 않은 상태)의 필드를 제외하여 출력할 수 있다. 이 기능을 사용하면 응답값이 엄청 긴 경우 필요없는 데이터를 제외할 수 있다.

from typing import List, Union

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()


class Item(BaseModel):
    name: str
    description: Union[str, None] = None
    price: float
    tax: float = 10.5
    tags: List[str] = []


items = {
    "foo": {"name": "Foo", "price": 50.2},
    "bar": {"name": "Bar", "description": "The bartenders", "price": 62, "tax": 20.2},
    "baz": {"name": "Baz", "description": None, "price": 50.2, "tax": 10.5, "tags": []},
}


@app.get("/items/{item_id}", response_model=Item, response_model_exclude_unset=True)
async def read_item(item_id: str):
    return items[item_id]

 

/items/foo를 하면 요청으로 {"name":"Foo", "price":50.2}가 가게되고 response_model_exclude_uset=True 덕분에 기본값이 설정된 나머지 값들을 제외한 응답을 한다.

 

 

Multiple 모델

여러개의 모델을 사용하여 보안성을 높일 수 있다.

회원가입 과정을 예시로 살펴보자.

from typing import Union, Any
from hashlib import sha256
from fastapi import FastAPI
from pydantic import BaseModel, EmailStr

app = FastAPI()


class UserIn(BaseModel):
    id: str
    pw: str
    email: EmailStr
    fullName: Union[str, None] = None


class UserOut(BaseModel):
    id: str
    email: EmailStr
    fullName: Union[str, None] = None


class UserDB(BaseModel):
    id: str
    hashPW: Any
    email: EmailStr
    fullName: Union[str, None] = None


def toHash(password: str) -> Any:
    return sha256(password.encode())


def saveUser(user: UserIn) -> UserDB:
    hashPW = toHash(user.pw)
    fakeDB = UserDB(**user.model_dump(), hashPW=hashPW)
    print("Save User in DB")
    return fakeDB


@app.post("/user/", response_model=UserOut)
def signIN(user: UserIn) -> UserOut:
    result: UserDB = saveUser(user)
    return result