如何在 FastAPI 中使用逗号分割列表类型查询参数?

如何在 fastapi 中使用逗号分割列表类型查询参数?

fastapi 中,可以对列表类型使用逗号分割,而不是同名键值对。

例如,在原本的查询参数中,source 被定义为 list[source] 类型,并使用 query 进行声明:

source: list[source] = query(default=none)

这会导致传递多个 source 查询参数时,生成多个同名键值对:

?source=manual&source=vdna

为了使用逗号分割的方式,可以将 source 定义为 string 类型,并自定义解析函数:

from typing import optional

# ...
source: optional[str] = query(none, description="请用`,`分割多个参数,如`manual,vdna,text-match`")
# ...

    parsed_source = source.split(",") if source else []
# ...

在处理查询参数时,可以调用 parsed_source 来获取已分割的源列表:

query_params = req.query_params
query_params["source"] = parsed_source
# ...

这样,source 查询参数将以逗号分割的形式传递:

?source=Manual,vDNA

另一种方法是使用自定义依赖项或全局配置进行列表解析,例如:
https://github.com/tiangolo/fastapi/issues/406
https://github.com/tiangolo/fastapi/issues/50

同时,fastapi 最新版本建议使用 annotated 替代 query 来声明参数类型,因为它提供了更多特性:
https://fastapi.tiangolo.com/tutorial/query-params-str-valida...

以上就是如何在 FastAPI 中使用逗号分割列表类型查询参数?的详细内容,更多请关注硕下网其它相关文章!