FastAPI 中如何将逗号分隔的字符串解析为列表？

fastapi 中如何使用逗号分割 list，而不是同名键值对？

fastapi 通常将 query 参数解析为列表，当同名参数多次出现时。然而，在某些情况下，你可能更喜欢使用逗号分隔，生成单个字符串值。

解决方案：

有两种方法可以做到这一点：

1. 使用字符串参数

将 query 参数声明为字符串类型并自行解析：

source: optional[str] = query(none, description="请用`,`分割多个参数，如`manual,vdna,text-match`")

在你的代码中，解析后的值将存储在 parsed_source 变量中：

parsed_source = source.split(",") if source else []

2. 创建自定义依赖项

编写自己的依赖项以解析和验证 comma 分隔列表：

from fastapi import depends, httpexception
from fastapi.params import depends

async def split_comma_separated_list(csv_string: str) -> list[str]:
    """助手函数，将逗号分隔的字符串转换为列表。"""
    parsed_list = csv_string.split(",")
    for item in parsed_list:
        if not item:
            raise httpexception(status_code=400, detail="无效的参数")
    return parsed_list

async def get_comma_separated_list(request: request,
                                   csv_string: str = depends(split_comma_separated_list)) -> list[str]:
    """获取逗号分隔列表的依赖项。"""
    return csv_string

在你的路由函数中，使用 get_comma_separated_list 依赖项：

@router.get("/my-route")
async def my_route(csv_list: list[str] = Depends(get_comma_separated_list)):
    # `csv_list` 是一个包含逗号分隔条目的字符串的列表
    return csv_list