【FastAPI基础】4、数据请求体

引言：

最近工作中有机会接触FastAPI这个框架，所以就把官方文档看了一遍，对框架的各个特性及使用方法做了总结，会逐步的发出来，希望对您有用。

如果您之前接触过python的其他框架，看起来会非常简单和顺畅，其实就是很简单。

【上一篇】：【FastAPI基础】3、查询参数
【下一篇】：
【FastAPI搭建好的产品框架源码，直接上手】：【FastAPI搭建好的产品架构】，直接上手

• 当你需要将数据从客户端（例如浏览器）发送给 API 时，你将其作为「请求体」发送。

• 请求体是客户端发送给 API 的数据。响应体是 API 发送给客户端的数据。

• 你的 API 几乎总是要发送响应体。但是客户端并不总是需要发送请求体。

• 我们使用 Pydantic 模型来声明请求体，并能够获得它们所具有的所有能力和优点。

  你不能使用 GET 操作（HTTP 方法）发送请求体。
  要发送数据，你必须使用下列方法之一：POST（较常见）、PUT、DELETE 或 PATCH。
  

1、创建数据模型

将你的数据模型声明为继承自 BaseModel 的类。使用标准的 Python 类型来声明所有属性：

from typing import Optional
from fastapi import FastAPI
from pydantic import BaseModel


class Item(BaseModel):
    name: str
    description: Optional[str] = None
    price: float
   tax: Optional[float] = None


app = FastAPI()


@app.post("/items/")
async def create_item(item: Item):
    return item

和声明查询参数时一样，当一个模型属性具有默认值时，它不是必需的。否则它是一个必需属性。将默认值设为 None 可使其成为可选属性。
例如，上面的模型声明了一个这样的 JSON「object」（或 Python dict）：
{

    "name": "Foo",
    "description": "An optional description",
    "price": 45.2,
    "tax": 3.5
}

…由于 description 和 tax 是可选的（它们的默认值为 None），下面的 JSON「object」也将是有效的：

{
    "name": "Foo",
    "price": 45.2
}

2、使用模型 ：在函数内部，你可以直接访问模型对象的所有属性：

from typing import Optional
from fastapi import FastAPI
from pydantic import BaseModel


class Item(BaseModel):
    name: str
    description: Optional[str] = None
    price: float
    tax: Optional[float] = None


app = FastAPI()


@app.post("/items/")
async def create_item(item: Item):
    item_dict = item.dict()
    if item.tax:
        price_with_tax = item.price + item.tax
        item_dict.update({"price_with_tax": price_with_tax})
    return item_dict

3、请求体 + 路径参数

你可以同时声明路径参数和请求体。FastAPI 将识别出与路径参数匹配的函数参数应从路径中获取，而声明为 Pydantic 模型的函数参数应从请求体中获取。

from typing import Optional
from fastapi import FastAPI
from pydantic import BaseModel


class Item(BaseModel):
    name: str
    description: Optional[str] = None
    price: float
   tax: Optional[float] = None


app = FastAPI()


@app.put("/items/{item_id}")
async def create_item(item_id: int, item: Item):
    return {"item_id": item_id, **item.dict()}

4、请求体 + 路径参数 + 查询参数

你还可以同时声明请求体、路径参数和查询参数。FastAPI 会识别它们中的每一个，并从正确的位置获取数据。

from typing import Optional
from fastapi import FastAPI
from pydantic import BaseModel


class Item(BaseModel):
    name: str
    description: Optional[str] = None
    price: float
    tax: Optional[float] = None


app = FastAPI()


@app.put("/items/{item_id}")
async def create_item(item_id: int, item: Item, q: Optional[str] = None):
    result = {"item_id": item_id, **item.dict()}
    if q:
        result.update({"q": q})
    return result

函数参数将依次按如下规则进行识别：

• 如果在路径中也声明了该参数，它将被用作路径参数。
• 如果参数属于单一类型（比如 int、float、str、bool等）它将被解释为查询参数。
• 如果参数的类型被声明为一个 Pydantic 模型，它将被解释为请求体。