FastAPI开发文档教程-JSON兼容编码器

admin 2026-01-10 10:55:22 编程 来源:ZONE.CI 全球网 0 阅读模式
  • 使用jsonable_encoder

    在某些情况下,您可能需要将数据类型(如Pydantic模型)转换为与JSON兼容的数据类型(如dictlist等)。

    比如,如果您需要将其存储在数据库中。

    对于这种要求, 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
    2. from fastapi import FastAPI
    3. from fastapi.encoders import jsonable_encoder from pydantic import BaseModel
    4. fake_db = {}
    5. class Item(BaseModel):
    6. title: str
    7. timestamp: datetime
    8. description: str | None = None
    9. app = FastAPI()
    10. @app.put("/items/{id}")
    11. def update_item(id: str, item: Item):
    12. json_compatible_item_data = jsonable_encoder(item) fake_db[id] = json_compatible_item_data
    1. from datetime import datetime
    2. from typing import Union
    3. from fastapi import FastAPI
    4. from fastapi.encoders import jsonable_encoder from pydantic import BaseModel
    5. fake_db = {}
    6. class Item(BaseModel):
    7. title: str
    8. timestamp: datetime
    9. description: Union[str, None] = None
    10. app = FastAPI()
    11. @app.put("/items/{id}")
    12. def update_item(id: str, item: Item):
    13. 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兼容。

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

    FastAPI开发文档教程-JSON兼容编码器 编程

    FastAPI开发文档教程-JSON兼容编码器

    使用jsonable_encoder在某些情况下,您可能需要将数据类型(如Pydantic模型)转换为与JSON兼容的数据类型(如dict、list等)。 比如,如果您需要将其存储在数据库中。 对于这
    FastAPI开发文档教程-路径操作配置 编程

    FastAPI开发文档教程-路径操作配置

    status_code 状态码弃用路径操作小结路径操作装饰器_支持多种配置参数。注意:以下参数应直接传递给路径操作装饰器,不能传递给路径操作函数。status_code 状态码status_code
    FastAPI开发文档教程-请求文件 编程

    FastAPI开发文档教程-请求文件

    导入 File定义 File 参数含 UploadFile 的文件参数UploadFile什么是 「表单数据」可选文件上传带有额外元数据的 UploadFile多文件上传带有额外元数据的多文件上传小结
    评论:0   参与:  0