FastApi-使用嵌套模型给出JSON序列化错误

Question

我正在尝试在帖子通话中使用嵌套模型。目标是使用API​​在我的KeyCloak实例中创建用户，因此我按照我需要的模型创建了文档。

当我尝试使用我的API使用Postman创建用户时，FastAPI给我以下错误：

类型属性的对象不是JSON序列化

代码如下：

user.py

from pydantic import BaseModel


# TODO Error: Object of type Attributes is not JSON serializable.
class Attributes(BaseModel):
    locale: str
    phoneNumber: str

    class Config:
        orm_mode = True


class Credentials(BaseModel):
    value: str
    type: str

    class Config:
        orm_mode = True


class User(BaseModel):
    email: str
    username: str
    enabled: bool
    firstName: str
    lastName: str
    attributes: Attributes
    credentials: list[Credentials]

    class Config:
        orm_mode = True

create_user.py

def create_new_keycloak_user(user: User):
    admin = keycloak_service.connect_to_keycloak_as_admin()
    try:
        body = vars(user)
        print(body)
        new_user = admin.create_user(body)
        return new_user
    except Exception as err:
        raise HTTPException(status_code=400, detail=f"User creation failed: {err}")

routing.py

# I also have tried without response_model=User

@router.post("/create-user", response_model=User)
async def create_new_user(user: User):
    create_user.create_new_keycloak_user(user)
    return user

当我尝试创建用户时，我在后端收到的正文：

{'email': '[email protected]', 'username': 'mverdi', 'enabled': True, 'firstName': 'Jhon', 'lastName': 'Doe', 'attributes': Attributes(locale='ITA', phoneNumber='+391234567891'), 'credentials': [Credentials(value='superpassword01', type='password')]}

我认为它与此相关“畸形” JSON，如果您在上一个JSON中注意到

'attributes': Attributes(locale='ITA', phoneNumber='+391234567891'),

，显然不允许以适当的JSON格式这样的事情。但是，为什么我会收到这样的事情呢？

将FastApi与Python3.10和Pydantic一起使用

Answer 1

我解决了。问题在于文件create_user.py

我使用vars（）将我的用户变成dict的用户对象（与JSON不一样的东西） ）但是，我需要使用FastAPI Framework提供的适当的JSON编码器。

旧代码：

def create_new_keycloak_user(user: User):
    admin = keycloak_service.connect_to_keycloak_as_admin()
    try:
        body = vars(user)
        print(body)
        new_user = admin.create_user(body)
        return new_user
    except Exception as err:
        raise HTTPException(status_code=400, detail=f"User creation failed: {err}")

新代码：

def create_new_keycloak_user(user: User):
    admin = keycloak_service.connect_to_keycloak_as_admin()
    try:
        body = jsonable_encoder(user)
        admin.create_user(body)
    except Exception as err:
        raise HTTPException(status_code=400, detail=f"User creation failed: {err}")