FastAPI 中,​​如果参数出现在路由处理函数的参数列表中且未被声明为路径参数(即未在路径中使用 {param} 语法定义),则默认会被解释为查询参数

在 FastAPI 中,​​如果参数出现在路由处理函数的参数列表中且未被声明为路径参数(即未在路径中使用 {param} 语法定义),则默认会被解释为查询参数​​。这是 FastAPI 的核心设计特性之一,通过类型注解和参数位置自动推断参数类型。

具体规则与示例

  1. ​默认行为:自动识别为查询参数​
    当函数参数既不是路径参数,也未通过其他方式(如 BodyForm 等)显式声明时,FastAPI 会将其视为查询参数。例如:

    @app.get("/items/")
    async def read_items(skip: int = 0, limit: int = 10):
        return {"skip": skip, "limit": limit}

    skip 和 limit 是查询参数,用户需通过 URL 的查询字符串传递(如 /items/?skip=5&limit=20)。

  2. ​必选与可选查询参数​

    ​必选查询参数​​:未设置默认值的参数必须通过查询字符串传递,否则会返回 422 错误。
    @app.get("/items/{item_id}")
    async def read_item(item_id: str, q: str):  # q 是必选查询参数
        return {"item_id": item_id, "q": q}
    访问 /items/4 会报错,需提供 ?q=xxx
    • ​可选查询参数​​:设置默认值(如 None)后,参数变为可选。
      @app.get("/items/{item_id}")
      async def read_item(item_id: str, q: str = None):  # q 是可选查询参数
          return {"item_id": item_id, "q": q}
    • 类型转换与验证​
      FastAPI 会根据参数类型自动转换请求值(如将字符串 "123" 转为整数 123),并支持通过 Query 类添加验证逻辑:

      from fastapi import Query
      
      @app.get("/items/")
      async def read_items(min_price: float = Query(..., gt=0)):
          return {"min_price": min_price}

      此时 min_price 必须为大于 0 的浮点数,否则会触发验证错误。

  3. ​例外情况:其他参数类型​

    • ​请求体参数​​:使用 Body(...) 或 Pydantic 模型。
      from fastapi import Body
      
      @app.post("/items/")
      async def create_item(item: Item, description: str = Body(...)):
          return {"item": item, "description": description}

    • 表单参数​​:使用 Form(...)

      from fastapi import Form
      
      @app.post("/login/")
      async def login(username: str = Form(...), password: str = Form(...)):
          return {"username": username}

      这些参数​​不会被视为查询参数​​,即使未在路径中声明.

总结

  • ​路径参数​​:通过 URL 路径中的占位符(如 {item_id})定义。
  • ​查询参数​​:函数参数列表中未声明为路径参数的参数,默认视为查询参数。
  • ​其他参数​​:需通过 BodyForm 等显式声明,否则 FastAPI 会按查询参数处理。

通过这种机制,FastAPI 实现了简洁的参数解析与验证,同时保持高度灵活性。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值