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

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

问题：FastAPI默认参数解析

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

解决方案：两种方法

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

方法一： (简易方案)

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

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

此方法简洁易懂，只需修改参数类型并添加一行解析代码。 务必在参数描述中清晰地说明参数格式要求。

方法二：自定义参数解析器 (高级方案)

对于更复杂的需求或更严格的验证，可以考虑自定义参数解析器。这需要对FastAPI的请求处理流程有更深入的理解，本文不做详细展开。 自定义解析器能够提供更强大的参数校验和处理能力，但实现复杂度也更高。

总结

通过以上两种方法，您可以轻松地将多个可选参数以逗号分隔的形式传递给FastAPI接口，提升API的易用性和可读性，避免冗余的URL参数。 选择哪种方法取决于您的具体需求和技术水平。 对于大多数情况，方法一已经足够高效和便捷。

以上就是FastAPI中如何处理逗号分隔的Query参数？的详细内容，更多请关注php中文网其它相关文章！