FastAPI-22：Pydantic Model结合Union、List的使用场景

前言

有多个模型且请求、响应需要声明多个模型的时候，可以根据不同使用场景结合typing库里的Union、List来达到目的。

Union

作用

联合类型，详细教程。使用Union时，建议首先包含具体的类型，然后是不太具体的类型。

#!/usr/bin/env python
# -*- coding: utf-8 -*-
# @Time     : 2024/1/18 14:56 
# @Author   : 22759
# @Email    : lyt_sy@sina.com
# @Project  : FastApi-demo
# @File     : demo18
# @Software : PyCharm
from typing import Optional, Union, List, Dict

from fastapi import APIRouter
from pydantic import BaseModel, EmailStr

router = APIRouter()


class ItemBase(BaseModel):
    description: str
    type: str


class ItemCar(ItemBase):
    """给个默认值"""
    type: str = "car"


class ItemPlane(ItemBase):
    type: str = "plane"
    size: int


ITEM = {
    "item1": {
        "description": "All my friends drive a low rider",
        "type": "car"
    },
    "item2": {
        "description": "Music is my aeroplane, it's my aeroplane",
        "type": "plane",
        "size": 5,
    }
}


@router.get("/item/{item_id}", response_model=Union[ItemPlane, ItemCar])
async def read_item(item_id: str) -> Dict:
    return ITEM[item_id]

item_id = “item1”

请求结果

item_id = “item2”

请求结果

List

class Item(ItemBase):
    name: Optional[str]
    description: Optional[str]


NEW_ITEMS = [
    {'name': 'Foo', 'description': 'There comes my hero'},
    {'name': 'Red', 'description': "It's my aeroplane", 'size': 123},  # 多了个size字段
]


@router.post("/items/", response_model=List[Item])
async def read_item():
    return NEW_ITEMS

正确传参的响应结果

返回了一个数组，第二个值中的size不会返回。这是因为响应模型不包含size，所以最终返回的数据也不包含size。

内容不包含description

NEW_ITEMS = [
    {"name": "Foo", "description": "There comes my hero"},
    {"name": "Red", "description": "It's my aeroplane", "size": 123},  # 多了个size字段
    {"name": "Red", "size": 123},  # 不包含description字段
]