FastAPI 入门教程 FastAPI教程额外数据类型

2024-02-25 开发教程 FastAPI 入门教程匿名 5℃

到目前为止，您一直在使用常见的数据类型，如:

int
float
str
bool

但是您也可以使用更复杂的数据类型。

您仍然会拥有现在已经看到的相同的特性:

很棒的编辑器支持。
传入请求的数据转换。
响应数据转换。
数据验证。
自动补全和文档。

其他数据类型

下面是一些你可以使用的其他数据类型:

UUID:一种标准的 "通用唯一标识符" ，在许多数据库和系统中用作ID。在请求和响应中将以 str 表示。
datetime.datetime:一个 Python datetime.datetime.在请求和响应中将表示为 ISO 8601 格式的 str ，比如: 2008-09-15T15:53:00+05:00.
datetime.date:Python datetime.date.在请求和响应中将表示为 ISO 8601 格式的 str ，比如: 2008-09-15.
datetime.time:一个 Python datetime.time.在请求和响应中将表示为 ISO 8601 格式的 str ，比如: 14:23:55.003.
datetime.timedelta:一个 Python datetime.timedelta.在请求和响应中将表示为 float 代表总秒数。Pydantic 也允许将其表示为 "ISO 8601 时间差异编码", 查看文档了解更多信息。
frozenset:在请求和响应中，作为 set 对待：在请求中，列表将被读取，消除重复，并将其转换为一个 set。在响应中 set 将被转换为 list 。产生的模式将指定那些 set 的值是唯一的 (使用 JSON 模式的 uniqueItems)。
bytes:标准的 Python bytes。在请求和相应中被当作 str 处理。生成的模式将指定这个 str 是 binary "格式"。
Decimal:标准的 Python Decimal。在请求和相应中被当做 float 一样处理。
您可以在这里检查所有有效的pydantic数据类型: Pydantic data types.

例子

下面是一个路径操作的示例，其中的参数使用了上面的一些类型。

from datetime import datetime, time, timedelta
from typing import Optional
from uuid import UUID
from fastapi import Body, FastAPI
app = FastAPI()
@app.put("/items/{item_id}")
async def read_items(
    item_id: UUID,
    start_datetime: Optional[datetime] = Body(None),
    end_datetime: Optional[datetime] = Body(None),
    repeat_at: Optional[time] = Body(None),
    process_after: Optional[timedelta] = Body(None),
):
    start_process = start_datetime + process_after
    duration = end_datetime - start_process
    return {
        "item_id": item_id,
        "start_datetime": start_datetime,
        "end_datetime": end_datetime,
        "repeat_at": repeat_at,
        "process_after": process_after,
        "start_process": start_process,
        "duration": duration,
    }

注意，函数内的参数有原生的数据类型，你可以，例如，执行正常的日期操作，如:

from datetime import datetime, time, timedelta
from typing import Optional
from uuid import UUID
from fastapi import Body, FastAPI
app = FastAPI()
@app.put("/items/{item_id}")
async def read_items(
    item_id: UUID,
    start_datetime: Optional[datetime] = Body(None),
    end_datetime: Optional[datetime] = Body(None),
    repeat_at: Optional[time] = Body(None),
    process_after: Optional[timedelta] = Body(None),
):
    start_process = start_datetime + process_after
    duration = end_datetime - start_process
    return {
        "item_id": item_id,
        "start_datetime": start_datetime,
        "end_datetime": end_datetime,
        "repeat_at": repeat_at,
        "process_after": process_after,
        "start_process": start_process,
        "duration": duration,
    }

上一节： FastAPI教程模式的额外信息 - 例子

下一节： FastAPI教程 Cookie 参数

"FastAPI 入门教程"的目录

FastAPI 入门教程 FastAPI教程 额外数据类型

其他数据类型

例子

FastAPI 入门教程 FastAPI教程额外数据类型