FastAPI查询参数为空字符串的优雅解决方案

本文介绍FastAPI优雅处理空字符串查询参数的方法。在使用FastAPI构建API时，前端传递空字符串作为查询参数可能导致类型转换错误。文章通过一个实际案例，演示了如何利用自定义依赖项`empty_to_none`将空字符串转换为`None`，从而避免因空字符串导致的422错误，提升代码健壮性和可维护性。 该方法有效地解决了FastAPI在处理空字符串查询参数时可能出现的类型错误问题，适用于各种数据类型参数。

FastAPI巧妙应对空字符串查询参数

在使用FastAPI构建API时，经常会遇到前端传递空字符串作为查询参数的情况。如果后端没有妥善处理，可能会导致类型转换错误，例如将空字符串转换为日期或整数时引发422错误。本文介绍一种优雅的方案，将FastAPI的空字符串查询参数转换为None，从而避免此类问题。

我们以一个实际例子说明，该例子展示一个获取待审核列表的API接口，其查询参数包含多个日期和整数类型：

@review.get('/api/in_process/', summary='获取待审核列表')
def list_await_review(
    confirm_start: datetime | None = Query(default=None),
    confirm_end: datetime | None = Query(default=None),
    created_start: datetime | None = Query(default=None),
    created_end: datetime | None = Query(default=None),
    score_min: int | None = Query(default=None),
    score_max: int | None = Query(default=None),
):
    pass

当前端传递类似/api/in_process/?confirm_start=&confirm_end=&created_start=&created_end=&score_min=&score_max=这样的URL时，confirm_start、confirm_end等参数会被FastAPI解析为空字符串""，而不是None，从而引发类型错误。

为了解决这个问题，我们可以创建一个自定义的FastAPI依赖项来处理空字符串。以下代码展示了实现方法：

from typing import Optional
from fastapi import FastAPI, Depends, Query
from datetime import datetime

app = FastAPI()

def empty_to_none(value: Optional[str]):
    return None if value == "" else value

@app.get("/api/in_process/")
async def list_await_review(
    confirm_start: Optional[datetime] = Depends(lambda: empty_to_none(Query(None))),
    confirm_end: Optional[datetime] = Depends(lambda: empty_to_none(Query(None))),
    created_start: Optional[datetime] = Depends(lambda: empty_to_none(Query(None))),
    created_end: Optional[datetime] = Depends(lambda: empty_to_none(Query(None))),
    score_min: Optional[int] = Depends(lambda: empty_to_none(Query(None))),
    score_max: Optional[int] = Depends(lambda: empty_to_none(Query(None))),
):
    # 处理查询逻辑
    pass

在这个例子中，empty_to_none函数将空字符串转换为None，并作为依赖项注入到list_await_review函数中。这样，即使前端传递空字符串，FastAPI也会将其正确解析为None，避免类型错误。 这种方法有效地处理了FastAPI中查询参数的空字符串问题，提高了代码的健壮性和可维护性。

今天关于《FastAPI查询参数为空字符串的优雅解决方案》的内容就介绍到这里了，是不是学起来一目了然！想要了解更多关于的内容请关注golang学习网公众号！