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+

  1. from datetime import datetime
  3. from fastapi import FastAPI
  4. from fastapi.encoders import jsonable_encoder
  5. from pydantic import BaseModel
  7. fake_db = {}
  10. class Item(BaseModel):
  11.     title: str
  12.     timestamp: datetime
  13.     description: str | None = None
  16. app = FastAPI()
  19. @app.put("/items/{id}")
  20. def update_item(id: str, item: Item):
  21.     json_compatible_item_data = jsonable_encoder(item)
  22.     fake_db[id] = json_compatible_item_data
  1. from datetime import datetime
  2. from typing import Union
  4. from fastapi import FastAPI
  5. from fastapi.encoders import jsonable_encoder
  6. from pydantic import BaseModel
  8. fake_db = {}
  11. class Item(BaseModel):
  12.     title: str
  13.     timestamp: datetime
  14.     description: Union[str, None] = None
  17. app = FastAPI()
  20. @app.put("/items/{id}")
  21. def update_item(id: str, item: Item):
  22.     json_compatible_item_data = jsonable_encoder(item)
  23.     fake_db[id] = json_compatible_item_data

在这个例子中，它将Pydantic模型转换为dict，并将datetime转换为str。

调用它的结果后就可以使用Python标准编码中的json.dumps()。

这个操作不会返回一个包含JSON格式（作为字符串）数据的庞大的str。它将返回一个Python标准数据结构（例如dict），其值和子值都与JSON兼容。

Note

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