FastAPI 学习之路（十一）请求体 - 嵌套模型

还是之前的例子，我们现在书有这样的一个属性，在哪里出售。我们需要增加这样的一个字段，而且书的可以销售的地方是多个的，那么我们应该如何实现呢。

from fastapi import FastAPI, Body
from typing import Optional
from pydantic import BaseModel, Field

app = FastAPI()


class Item(BaseModel):
    name: str
    description: Optional[str] = Field(None, title="这里可以写描述", max_length=300)
    price: float = Field(..., ge=0, description="价格必须大于0")
    tax: Optional[float] = None
    sellarea: list = []


@app.put("/items/{itemid}")
def update_items(itemid: int, item: Item = Body(..., embed=True)):
    result = {"itemid": itemid, "item": item}
    return result

embed:决定了请求体的格式，是否需要item这个key，如果为true，则需要，格式如下图中所示，如果为false则不需要，请求体就是一个对象 

我们看下我们最后的效果

这样满足了我们的需求，但是我们期望要设置出售的地区，必须传递每一个地区str类型，那么如何来实现呢。

from fastapi import FastAPI, Body
from typing import Optional, List
from pydantic import BaseModel, Field

app = FastAPI()


class Item(BaseModel):
    name: str
    description: Optional[str] = Field(None, title="这里可以写描述", max_length=300)
    price: float = Field(..., ge=0, description="价格必须大于0")
    tax: Optional[float] = None
    sellarea: List[str] = []


@app.put("/items/{itemid}")
def update_items(itemid: int, item: Item = Body(..., embed=True)):
    result = {"itemid": itemid, "item": item}
    return result

其实实现是很简单的，就是之前的list使用typing 模块中导入 List，这样我们再去定义类型就可以，我们可以看下，加入我们在传递的list中的每一项都是str类型。

那么当我们传递的有一项是list类型

这个时候就报错了。不符合预期了。

当然也可以是Set、dict、tuple都可以。我们可以点进去看typing的源码。

       假如我们现在有一个字段，但是它还是需要一个模型，比如我们有一个图片的。它里面需要有url和name。那么我们应该怎么实现呢?

from fastapi import FastAPI, Body
from typing import Optional, List, Dict, Set, Tuple
from pydantic import BaseModel, Field

app = FastAPI()


class Image(BaseModel):
    name: str
    url: str


class Item(BaseModel):
    name: str
    description: Optional[str] = Field(None, title="这里可以写描述", max_length=300)
    price: float = Field(..., ge=0, description="价格必须大于0")
    tax: Optional[float] = None
    sellarea: List[str] = []
    image: Optional[Image] = None


@app.put("/items/{itemid}")
def update_items(itemid: int, item: Item = Body(..., embed=True)):
    result = {"itemid": itemid, "item": item}
    return result

我们看下最后的结果。

这样我们就实现了模型的嵌套，那么我们其实可能还是希望url是一个http的url，那么我们如何实现呢。

from fastapi import FastAPI, Body
from typing import Optional, List, Dict, Set, Tuple
from pydantic import BaseModel, Field, HttpUrl

app = FastAPI()


class Image(BaseModel):
    name: str
    url: HttpUrl


class Item(BaseModel):
    name: str
    description: Optional[str] = Field(None, title="这里可以写描述", max_length=300)
    price: float = Field(..., ge=0, description="价格必须大于0")
    tax: Optional[float] = None
    sellarea: List[str] = []
    image: Optional[Image] = None


@app.put("/items/{itemid}")
def update_items(itemid: int, item: Item = Body(..., embed=True)):
    result = {"itemid": itemid, "item": item}
    return result

最后结果： 

当然我们还可以做一些其他的。比如List之类的校验。