JSON 兼容编码器¶

在某些情况下，你可能需要将数据类型（例如 Pydantic 模型）转换为 JSON 兼容的格式（例如 dict、list 等）。

例如，如果你需要将其存储在数据库中。

为此，FastAPI 提供了 jsonable_encoder() 函数。

使用 `jsonable_encoder`¶

设想你有一个只能接收 JSON 兼容数据的数据库 fake_db。

例如，它无法接收 datetime 对象，因为它们与 JSON 不兼容。

因此，datetime 对象必须转换为包含 ISO 格式数据的 str。

同样，该数据库也无法接收 Pydantic 模型（带有属性的对象），只能接收 dict。

你可以为此使用 jsonable_encoder。

它接收一个对象（如 Pydantic 模型），并返回一个 JSON 兼容的版本。

Python 3.10+

from datetime import datetime

from fastapi import FastAPI
from fastapi.encoders import jsonable_encoder
from pydantic import BaseModel

fake_db = {}


class Item(BaseModel):
    title: str
    timestamp: datetime
    description: str | None = None


app = FastAPI()


@app.put("/items/{id}")
def update_item(id: str, item: Item):
    json_compatible_item_data = jsonable_encoder(item)
    fake_db[id] = json_compatible_item_data

在此示例中，它会将 Pydantic 模型转换为 dict，将 datetime 转换为 str。

调用它的结果是可以被 Python 标准库 json.dumps() 编码的内容。

它不会返回一个包含 JSON 格式数据的大 str（即字符串）。它返回的是一个 Python 标准数据结构（例如 dict），其中所有的值和子值都是与 JSON 兼容的。

注意

FastAPI 在内部实际上就是使用 jsonable_encoder 来转换数据的。但它在许多其他场景中也非常有用。

JSON 兼容编码器¶

使用 jsonable_encoder¶

使用 `jsonable_encoder`¶