如何在 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_paramsquery_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 中使用逗号分割列表类型查询参数?的详细内容,更多请关注【创想鸟】其它相关文章!

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至253000106@qq.com举报,一经查实,本站将立刻删除。

发布者:PHP中文网,转转请注明出处:https://www.chuangxiangniao.com/p/2180541.html

(0)
上一篇 2025年2月25日 14:33:30
下一篇 2025年2月18日 00:12:57

AD推荐 黄金广告位招租... 更多推荐

相关推荐

发表回复

登录后才能评论