fastapi教程翻译(二十三)：JSON compatible

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

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

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

一、使用 jsonable_encoder

假设您有一个数据库fake_db，该数据库仅接收JSON兼容数据。

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

因此，必须将一个datetime对象转换为一个包含[ISO格式]（https://en.wikipedia.org/wiki/ISO_8601）数据的str对象。

同样，该数据库将不会接收Pydantic模型（带有属性的对象），而只会接收dict。

您可以为此使用 jsonable_encoder。

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

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

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来转换数据。 但这在许多其他情况下很有用。