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

DDD
发布: 2024-11-14 21:16:14
原创
519人浏览过

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

最佳 Windows 性能的顶级免费优化软件
最佳 Windows 性能的顶级免费优化软件

每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。

下载
来源:php中文网
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
最新问题
开源免费商场系统广告
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板
关于我们 免责申明 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送
PHP中文网APP
随时随地碎片化学习
PHP中文网抖音号
发现有趣的

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号