FastAPI中处理动态Query Parameters的实现方法咨询

在FastAPI中处理任意数量的动态查询参数，有几种简洁的实现方式，以下是最常用的方案：

方案1：直接使用Request对象获取所有查询参数 #

这是最直接的方式，通过Request对象的query_params属性可以获取所有传入的查询参数，它是一个类似字典的ImmutableMultiDict结构，可直接转换为普通字典处理。

from fastapi import FastAPI, Request

app = FastAPI()

@app.get("/app")
async def handle_dynamic_query(request: Request):
    # 将查询参数转换为字典
    query_dict = dict(request.query_params)
    # 在这里编写你的业务逻辑，比如根据参数过滤数据等
    return {"received_query_params": query_dict}

补充说明 #

• 无论调用方传入多少个fieldn=valuen格式的参数，都能完整捕获
• 如果需要处理同一个参数名对应多个值的场景（比如field1=value1&field1=value2），可以用request.query_params.getlist("field1")获取值列表，示例如下：

  async def handle_dynamic_query(request: Request):
      query_dict = {}
      for key in request.query_params:
          values = request.query_params.getlist(key)
          query_dict[key] = values if len(values) > 1 else values[0]
      return {"received_query_params": query_dict}
  

方案2：用依赖项封装查询参数逻辑 #

如果多个路由都需要处理动态查询参数，可以将参数获取逻辑封装为依赖项，提高代码复用性。

from fastapi import FastAPI, Request, Depends

app = FastAPI()

def get_dynamic_query(request: Request):
    query_dict = dict(request.query_params)
    # 可在此统一添加参数校验、转换逻辑
    return query_dict

@app.get("/app")
async def handle_request(params: dict = Depends(get_dynamic_query)):
    return {"processed_params": params}

# 其他需要动态参数的路由也可以复用这个依赖
@app.get("/another-app")
async def another_handler(params: dict = Depends(get_dynamic_query)):
    return {"another_result": params}

方案3：结合固定参数与动态参数 #

如果你的接口既有固定必填参数，又允许任意数量的动态参数，可以使用**kwargs来接收动态部分：

from fastapi import FastAPI, Query

app = FastAPI()

@app.get("/app")
async def mix_fixed_and_dynamic(fixed_param: str = Query(..., description="固定必填参数"), **kwargs):
    return {
        "fixed_param": fixed_param,
        "dynamic_params": kwargs
    }

优缺点对比 #

内容的提问来源于stack exchange，提问作者angeloandrea.isola