如何在 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 中使用逗号分割列表类型查询参数？》文章吧，也可关注golang学习网公众号了解相关技术文章。