FastAPI中OpenAPI参数如何实现多选下拉框？

核心解决方案：使用带enum的List类型查询参数 #

FastAPI支持直接通过Query参数结合List和enum实现多选下拉框，你之前的问题主要是类型声明和参数配置有误，以及误用了路径参数处理多选场景。

解决步骤与修正代码 #

1. 修正类型声明：将ids的类型改为Optional[List[str]]，并通过Query指定enum选项，FastAPI会自动在OpenAPI文档（Swagger UI/Redoc）中生成多选下拉框。
2. 移除不合适的路径参数：路径参数（如/{ids}）不适合处理多选场景，OpenAPI对路径参数的数组类型不会渲染下拉框，改用查询参数即可。
3. 简化参数处理逻辑：FastAPI会自动将多选的查询参数解析为列表，无需手动处理字符串分割。

修正后的代码：

from typing import Optional, List
from fastapi import FastAPI, Query

app = FastAPI()

@app.get("/schedules")
async def GetScedules(
    ids: Optional[List[str]] = Query(
        None, 
        enum=[str(id) for id in appconfig['projectids']],
        description="选择一个或多个项目ID"
    ),
    active: Optional[str] = Query(
        None, 
        enum=["active", "notactive"],
        description="选择状态"
    )
):
    """列出按项目ID排序的GitLab定时任务"""
    # 直接使用ids即可，FastAPI已将多选参数解析为列表
    # 若未选择任何项，ids为None
    print(ids)  # 示例：选中多个时输出 ["id1", "id2"]
    # 后续业务逻辑...

关键说明 #

• 多选下拉框的生成：当你使用List[str]结合enum作为Query参数时，Swagger UI会自动渲染为可多选的下拉框（按住Ctrl/Command可多选）。
• 关于原问题的解释：
  • 你之前设置Optional[List]报错是因为缺少具体的元素类型（应该是Optional[List[str]]），FastAPI需要明确的类型信息来解析参数和生成OpenAPI文档。
  • 路径参数{[ids]}不符合HTTP路径规范，且OpenAPI对路径参数的数组类型不会生成下拉控件，查询参数才是处理多选筛选的标准方式。

额外优化 #

如果需要兼容旧请求格式（通过逗号分隔的字符串传递多选值），可以添加自定义依赖项，但上述代码已经覆盖了OpenAPI文档中的多选交互需求。

内容的提问来源于stack exchange，提问作者MortenB