FastAPI中使用逗号分割列表类型查询参数的方法

在FastAPI开发中，经常会遇到需要处理列表类型查询参数的情况。而使用逗号分割的方式来传递列表参数是一种常见且方便的做法。下面将详细介绍在FastAPI中如何实现这一功能。

我们需要导入必要的模块。在FastAPI中，主要使用FastAPI类来创建应用，以及Query函数来处理查询参数。示例代码如下：

from fastapi import FastAPI, Query
from typing import List

app = FastAPI()

接下来，定义一个路由处理函数，该函数接受一个逗号分割的列表类型查询参数。例如，我们创建一个获取用户兴趣爱好的接口：

@app.get("/hobbies")
async def get_hobbies(hobbies: List[str] = Query(None)):
    if hobbies:
        return {"hobbies": hobbies}
    else:
        return {"message": "No hobbies provided."}

在上述代码中，hobbies参数被定义为List[str]类型，表示它是一个字符串列表。Query(None)表示该参数是可选的，如果客户端没有提供该参数，默认值为None。

当客户端发起请求时，例如http://localhost:8000/hobbies?hobbies=reading,writing,running，FastAPI会自动将逗号分割的字符串解析为列表。在路由处理函数中，我们可以直接使用这个列表进行后续的业务逻辑处理。

如果需要对列表参数进行进一步的验证，例如限制列表的长度或者元素的取值范围，可以使用Query函数的其他参数。例如，限制爱好列表的长度不超过5个：

@app.get("/hobbies")
async def get_hobbies(hobbies: List[str] = Query(None, max_length=5)):
    if hobbies:
        return {"hobbies": hobbies}
    else:
        return {"message": "No hobbies provided."}

通过这种方式，我们可以方便地在FastAPI中处理逗号分割的列表类型查询参数，提高接口的灵活性和易用性。合理的参数验证也能增强接口的健壮性，确保接收到的数据符合预期。在实际开发中，根据具体业务需求，还可以对列表参数进行更多复杂的处理和验证。