FastAPI如何处理逗号分隔的列表参数?
时间:2025-03-28 11:55:25 350浏览 收藏
本文介绍FastAPI如何处理逗号分隔的列表查询参数,例如`/list?source=manual,vdna`。FastAPI默认将相同名称参数解析为列表,但对于逗号分隔字符串,需要手动处理。文章提供了两种方法:一是将参数类型改为`Optional[str]`,然后使用`split(',')`函数进行解析;二是自定义解析过程,利用FastAPI的依赖注入机制实现更复杂的逻辑。选择哪种方法取决于实际需求和对FastAPI的熟悉程度,简单场景推荐方法一,复杂场景则选择方法二。
FastAPI 列表参数的逗号分隔处理方法详解
在使用FastAPI构建API时,经常需要处理列表类型的查询参数。FastAPI默认将相同名称的查询参数解析为列表,例如?source=manual&source=vdna
会被解析为source=['manual', 'vdna']
。但有时我们需要用逗号分隔的字符串传递列表参数,例如?source=manual,vdna
。本文介绍两种解决方法。
问题根源:原始代码中,source
参数定义为list[source]
类型,导致FastAPI将重复参数解析为列表,而非逗号分隔的字符串。
方法一:字符串参数及手动解析
最直接的方法是将source
参数类型改为Optional[str]
,并在函数内部手动解析逗号分隔的字符串。此方法简单易懂,无需额外依赖。
代码示例:
@review.get('/list', summary='获取待审核列表') def list_await_review( # ... other parameters ... source: Optional[str] = Query(None, description="请用`,`分割多个参数,如`Manual,vDNA,text-match`"), # ... other parameters ... ): parsed_source = source.split(",") if source else [] # ...后续代码使用parsed_source...
此方法将source
解析为字符串,然后使用split(",")
方法将其分割成列表。若source
为空,则parsed_source
为空列表。
方法二:自定义解析过程 (高级方法)
更灵活的方法是自定义解析过程,例如创建自定义依赖项处理逗号分隔字符串。此方法能处理更复杂的解析逻辑,但需要编写更多代码,并需要更深入理解FastAPI的依赖注入机制。 官方文档推荐使用Annotated
增强参数校验和类型提示,在处理复杂参数时更有优势,但实现细节超出了本文范围。
选择哪种方法取决于你的需求和FastAPI熟练程度。对于简单的逗号分隔列表参数,方法一足够高效简洁;而对于更复杂的场景,方法二提供了更大的灵活性。
本篇关于《FastAPI如何处理逗号分隔的列表参数?》的介绍就到此结束啦,但是学无止境,想要了解学习更多关于文章的相关知识,请关注golang学习网公众号!
-
501 收藏
-
501 收藏
-
501 收藏
-
501 收藏
-
501 收藏
-
101 收藏
-
373 收藏
-
398 收藏
-
378 收藏
-
484 收藏
-
431 收藏
-
115 收藏
-
310 收藏
-
124 收藏
-
315 收藏
-
263 收藏
-
403 收藏
-
- 前端进阶之JavaScript设计模式
- 设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
- 立即学习 542次学习
-
- GO语言核心编程课程
- 本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
- 立即学习 508次学习
-
- 简单聊聊mysql8与网络通信
- 如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
- 立即学习 497次学习
-
- JavaScript正则表达式基础与实战
- 在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
- 立即学习 487次学习
-
- 从零制作响应式网站—Grid布局
- 本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
- 立即学习 484次学习