FastAPI中如何处理逗号分隔的Query参数？

FastAPI优雅处理逗号分隔的Query参数

在构建FastAPI API时，经常需要处理多个可选查询参数。例如，筛选列表接口可能允许用户基于多个条件进行筛选，这些条件可以是多选的。本文介绍如何高效处理以逗号分隔形式传递的FastAPI Query参数，避免使用多个同名键值对的冗余方式。

问题：FastAPI默认参数解析

FastAPI默认将相同名称的多个Query参数解析为列表，例如，source=manual&source=vdna。 如果期望以逗号分隔的形式传递参数，例如source=manual,vdna，则需要自定义处理。

解决方案：两种方法

为了实现逗号分隔的Query参数，我们提供两种方案：

方法一：字符串解析 (简易方案)

将Query参数类型定义为Optional[str]，并在函数内部手动解析逗号分隔的字符串：

from typing import Optionalfrom fastapi import Query# ...source: Optional[str] = Query(None, description="用逗号`,`分割多个参数，例如：`Manual,vDNA,text-match`")# ...parsed_source = source.split(",") if source else []# ...

登录后复制