[PYTHON/PYDANTIC] BaseModel 클래스 : Config 서브 클래스를 사용해 문서화시 예제 코드 설정하기

■ BaseModel 클래스에서 Config 서브 클래스를 사용해 문서화시 예제 코드를 설정하는 방법을 보여준다.

▶ 예제 코드 (PY)


from pydantic import BaseModel

class TodoItem(BaseModel):
    id   : int
    item : str

    class Config:
        json_schema_extra = {
            "example" : {
                "id"   : 1,
                "item" : "Example Schema!"
            }
        }

from pydantic import BaseModel

class TodoItem(BaseModel):

id : int

item : str

class Config:

json_schema_extra = {

"example" : {

"id" : 1,

"item" : "Example Schema!"

}