FastAPI如何处理逗号分隔的列表参数？

本文介绍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学习网公众号！