FastAPI 学习之路(二十一)请求体 - 更新数据
系列文章:
FastAPI 学习之路(一)fastapi--高性能web开发框架
FastAPI 学习之路(十二)接口几个额外信息和额外数据类型
FastAPI 学习之路(十三)Cookie 参数,Header参数
我们都知道,去创建请求体,更新数据我们用PUT请求,我们去试着更新下数据。
我们有一组数据,我们要更新描述。
from typing import List, Optional from fastapi import FastAPI from fastapi.encoders import jsonable_encoder from pydantic import BaseModel app = FastAPI() class Item(BaseModel): name: Optional[str] = None description: Optional[str] = None price: Optional[float] = None tax: float = 10.5 tags: List[str] = [] items = { "one": {"name": "苹果", "price": 50.2} } @app.put("/items/", response_model=Item) def update_item(name: str, item: Item): update_item_encoded = jsonable_encoder(item) items[name] = update_item_encoded return update_item_encoded @app.get("/items/{item_id}", response_model=Item) def read_item(item_id: str): return items[item_id]
我们去获取下
我们去更新下数据
我们去更新一个不存在的数据
更新部分数据时,可以在 Pydantic 模型的 .dict() 中使用 exclude_unset 参数。
比如,item.dict(exclude_unset=True)。我们去看我们实际的例子
from typing import List, Optional from fastapi import FastAPI from fastapi.encoders import jsonable_encoder from pydantic import BaseModel app = FastAPI() class Item(BaseModel): name: Optional[str] = None description: Optional[str] = None price: Optional[float] = None tax: float = 10.5 tags: List[str] = [] items = { "one": {"name": "苹果", "price": 50.2} } @app.put("/items/", response_model=Item) def update_item(name: str, item: Item): stored_item_data = items[name] stored_item_model = Item(**stored_item_data) update_data = item.dict(exclude_unset=True) updated_item = stored_item_model.copy(update=update_data) items[name] = jsonable_encoder(updated_item) return updated_item @app.get("/items/{item_id}", response_model=Item) def read_item(item_id: str): return items[item_id]
我们去看下去后的效果
更新部分数据小结
简而言之,更新部分数据做法:
-
使用 PUT 也可以使用PATCH;
-
提取存储的数据;
-
把数据放入 Pydantic 模型;
-
生成不含输入模型默认值的 dict (使用 exclude_unset 参数);
-
只更新用户设置过的值,不用模型中的默认值覆盖已存储过的值。
-
为已存储的模型创建副本,用接收的数据更新其属性 (使用 update 参数)。
-
把模型副本转换为可存入数据库的形式(比如,使用 jsonable_encoder)。
-
这种方式与 Pydantic 模型的 .dict() 方法类似,但能确保把值转换为适配 JSON 的数据类型,例如, 把 datetime 转换为 str 。
-
把数据保存至数据库;
-
返回更新后的模型。
文章首发在公众号,欢迎关注。