在现代Web开发中，FastAPI 是一个被广泛使用的框架，其中处理API查询参数是一项常见任务。在某些情况下，我们可能需要接受以逗号分隔的查询参数列表。本文将分享一些优雅处理这一需求的技巧与示例。
1. 理解FastAPI中的查询参数
在FastAPI中，查询参数可以轻松通过函数参数接收。不同于其他框架，FastAPI支持自动数据验证和转换。这就使得处理逗号分隔的查询参数变得非常简单。
例如，假设我们有一个查询参数要求用户输入一串ID，我们可以使用Python的分割功能，将输入字符串转换为列表。以下是一个简单的示例：
from fastapi import FastAPI
app = FastAPI()
@app.get("/items/")
async def read_items(ids: str):
id_list = ids.split(",")
return {"ids": id_list}示例分析
在这个示例中，我们定义了一个名为 read_items 的路由，它接受一个字符串类型的查询参数 ids。使用 split() 方法可以很容易地将以逗号分隔的值转换为列表。
2. 验证和转换参数
为了确保传入的参数是有效的，我们可以结合使用 Pydantic 的模型来实现更高级的验证。通过定义一个 Pydantic 模型，我们可以为逗号分隔的参数设置自定义验证逻辑。
from pydantic import BaseModel, constr, ValidationError
class ItemModel(BaseModel):
ids: constr(regex=r'^[0-9]+(,[0-9]+)*$') # 只接受数字和逗号
@app.get("/validated-items/")
async def read_validated_items(model: ItemModel):
id_list = model.ids.split(",")
return {"ids": id_list}参数模型分析
在上述代码中，我们定义了一个名为 ItemModel 的Pydantic模型。使用正则表达式，可以确保用户输入仅包含数字和逗号，防止无效输入导致的错误。
3. 错误处理与用户反馈
为了提升用户体验，处理错误和提供友好的反馈也是非常重要的一部分。FastAPI会自动处理验证错误并返回相应的HTTP状态码和错误信息，但我们可以进一步自定义响应内容。
from fastapi.responses import JSONResponse
@app.exception_handler(ValidationError)
async def validation_exception_handler(request, exc):
return JSONResponse(
status_code=422,
content={"detail": exc.errors()}
)自定义错误处理
在这个自定义的错误处理器中，如果用户输入无效的查询参数，FastAPI将返回一个 422 状态码和详细的错误信息，以帮助用户了解问题所在。
总结
通过使用 FastAPI 的查询参数功能，我们能够优雅地处理逗号分隔的查询参数列表。结合 Pydantic 提供的验证与自定义错误处理，我们可以确保 API 的可靠性和用户体验。希望这些示例和技巧能够帮助您更好地利用 FastAPI 处理复杂的查询参数!
