学习fastapi框架中的response_model用法

最新推荐文章于 2025-04-05 20:20:15 发布

DokcelyNg

最新推荐文章于 2025-04-05 20:20:15 发布

阅读量1.1k

点赞数

分类专栏： fastapi 文章标签： python 后端

本文链接：https://blog.csdn.net/Lmingtian_huigenghao/article/details/121423414

版权

fastapi 专栏收录该内容

1 篇文章

订阅专栏

本文介绍如何使用FastAPI框架的response_model特性来自定义接口返回的数据类型和字段，包括定义UserList类及其实现，以及如何通过postman进行接口测试。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

学习fastapi框架中的response_model用法

接口函数如下图：

@router.get('/user_info',response_model=UserList)
async def user_info(db : Session = Depends(get_db)):
    # try:
    #     print(1+'1')
    user_info= db.query(User).all()
    # user_info= db.query(User).first()
    user=[
        {
            "id": 1,
            "name": "Python"
        },
        {
            "id": None,
            "name": None
        }]
    # return user_info
    return {"user_info":user_info,"user":user}

然后需要创建一个公用的py文件定义一个UserList类

UserList类如下图

class UserBase(BaseModel):
    id : int
    email: str
    # hashed_password : str

    class Config:
        orm_mode = True

class UserBase1(BaseModel):
    id: Optional[int] = None
    name: Optional[str] = None
    # hashed_password : str

    class Config:
        orm_mode = True  # 为Pydantic开启验证

class UserList(BaseModel):
    user_info:List[UserBase]
    user: List[UserBase1]

User模型如下图

class User(Base):
    __tablename__ = "users"
    id = Column(Integer, primary_key=True, index=True)
    email = Column(String(32), unique=False, index=True)
    hashed_password = Column(String(32))
    is_active = Column(Boolean, default=True)

    
    def to_dict(self):
        model_dict = dict(self.__dict__)
        del model_dict['_sa_instance_state']
        return model_dict


    # 多个对象
    def dobule_to_dict(self):
        result = {}
        for key in self.__mapper__.c.keys():
            if getattr(self, key) is not None:
                result[key] = str(getattr(self, key))
            else:
                result[key] = getattr(self, key)
        return result

def to_json(all_vendors):
    if isinstance(all_vendors[0],Iterable):
        v = [[i.dobule_to_dict() for i in ven  if i != None] for ven in all_vendors]
    else:
        v = [ven.dobule_to_dict() for ven in all_vendors]
    return v

然后通过postman测试接口如下

{
    "user_info": [
        {
            "id": 1,
            "email": "123@qq.com"
        },
        {
            "id": 10,
            "email": "1"
        },
        {
            "id": 11,
            "email": "0@qq.com"
        },
        {
            "id": 12,
            "email": "1@qq.com"
        },
        {
            "id": 14,
            "email": "3@qq.com"
        },
        {
            "id": 15,
            "email": "4@qq.com"
        },
        {
            "id": 16,
            "email": "5@qq.com"
        },
        {
            "id": 17,
            "email": "6@qq.com"
        },
        {
            "id": 18,
            "email": "7@qq.com"
        },
        {
            "id": 19,
            "email": "8@qq.com"
        },
        {
            "id": 20,
            "email": "9@qq.com"
        },
        {
            "id": 356,
            "email": "456@qq.com"
        },
        {
            "id": 357,
            "email": "456@qq.com"
        },
        {
            "id": 358,
            "email": "456@qq.com"
        },
        {
            "id": 359,
            "email": "456@qq.com"
        },
        {
            "id": 360,
            "email": "456@qq.com"
        }
    ],
    "user": [
        {
            "id": 1,
            "name": "Python"
        },
        {
            "id": null,
            "name": null
        }
    ]
}