FastAPI 查询参数处理：巧妙转换空字符串为 None
在使用 FastAPI 构建 API 接口时，处理查询参数 (query params) 至关重要。前端传递空字符串作为查询参数时，FastAPI 默认将其解析为空字符串，这可能导致类型校验失败，引发 422 错误。本文介绍一种优雅的方法，将 FastAPI 的查询参数中的空字符串转换为 None 值，避免此类问题。
假设我们有一个 API 接口，用于获取待审核列表，其查询参数包括时间范围和分数范围：
from fastapi import FastAPI, Depends, Query
from datetime import datetime
from typing import Optional
app = FastAPI()
@app.get("/api/in_process/", summary="获取待审核列表")
async def list_await_review(
confirm_start: Optional[datetime] = Query(default=None),
confirm_end: Optional[datetime] = Query(default=None),
created_start: Optional[datetime] = Query(default=None),
created_end: Optional[datetime] = Query(default=None),
score_min: Optional[int] = Query(default=None),
score_max: Optional[int] = Query(default=None),
):
# 处理查询逻辑
print(f"confirm_start: {confirm_start}")
print(f"confirm_end: {confirm_end}")
# ...其他参数
return {"message": "success"}
如果前端传递的 URL 参数类似 /api/in_process/?confirm_start=&confirm_end=&created_start=&created_end=&score_min=&score_max=，则 confirm_start、confirm_end 等参数将被解析为空字符串，而不是预期的 None。这将导致类型错误，因为 datetime 和 int 类型无法接收空字符串。
为了解决这个问题，我们可以利用 FastAPI 的 Query 参数的 default 属性和类型提示：
from fastapi import FastAPI, Depends, Query
from datetime import datetime
from typing import Optional
app = FastAPI()
@app.get("/api/in_process/", summary="获取待审核列表")
async def list_await_review(
confirm_start: Optional[datetime] = Query(default=None),
confirm_end: Optional[datetime] = Query(default=None),
created_start: Optional[datetime] = Query(default=None),
created_end: Optional[datetime] = Query(default=None),
score_min: Optional[int] = Query(default=None),
score_max: Optional[int] = Query(default=None),
):
# 处理查询逻辑
print(f"confirm_start: {confirm_start}")
print(f"confirm_end: {confirm_end}")
# ...其他参数
return {"message": "success"}
通过设置 default=None 并使用 Optional 类型提示，FastAPI 会自动将空字符串解析为 None 值。 这样，即使前端传递了空字符串，后端也能正确地将参数解析为 None，并进行后续处理，避免了 422 错误。 无需创建额外的依赖项函数。
这种方法简洁有效，充分利用了 FastAPI 内置的功能，推荐使用。
以上就是FastAPI中如何优雅地将空字符串查询参数转换为None？的详细内容，更多请关注知识资源分享宝库其它相关文章！
发表评论:
◎欢迎参与讨论，请在这里发表您的看法、交流您的观点。