JSON 兼容编码器¶

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

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

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

使用 `jsonable_encoder`¶

假设您有一个数据库 fake_db，它只接收 JSON 兼容的数据。

例如，它不接收 datetime 对象，因为这些对象与 JSON 不兼容。

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

同样地，这个数据库不会接收 Pydantic 模型（一个带有属性的对象），只会接收 dict。

您可以使用 jsonable_encoder 来实现这一点。

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

Python 3.10+Python 3.8+

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

from datetime import datetime
from typing import Union

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

fake_db = {}


class Item(BaseModel):
    title: str
    timestamp: datetime
    description: Union[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 兼容的。

Note

jsonable_encoder 实际上被 FastAPI 内部用于转换数据。但在许多其他场景中也非常有用。

JSON 兼容编码器¶

使用 jsonable_encoder¶

使用 `jsonable_encoder`¶