HoRain云--FastAPI参数识别全解析

@app.get("/items/{item_id}") async def get_item(item_id: int = Path(..., ge=1)): # 必须用 ... 标记为必需 return {"item_id": item_id}

• 关键特性：
  • 自动类型转换：URL 中的item_id会按注解类型（如int）自动转换。
  • 路径校验优先：若ge=1校验失败，直接返回 422 错误，不会进入业务逻辑。

• 无默认值 →必填参数（缺失时报 422 错误）。
• 有默认值 →可选参数（如skip: int = 0）。

@app.get("/items") async def list_items( q: str, # 必填查询参数（无默认值） skip: int = 0, # 可选参数，默认 0 limit: int = Query(10, le=100) # 显式校验：最大值 100 ): return {"q": q, "skip": skip, "limit": limit}

• 关键特性：
  • 列表参数：用List[str] = Query([])接收重复键（如?tags=1&tags=2）。
  • 正则校验：q: str = Query(..., regex="^[a-z]+$")限制输入格式。

• 仅支持 POST/PUT/PATCH 方法（GET 无请求体）。
• 同一接口只能有一个请求体参数（多模型需嵌套）。

class Item(BaseModel): name: str price: float = Field(..., gt=0) # 自定义校验：价格必须 >0 @app.post("/items") async def create_item(item: Item): # 自动解析 JSON 请求体 return {"total": item.price * 1.1} # 已通过类型校验

• 关键特性：
  • 字段级校验：通过Field或@validator实现复杂规则（如邮箱格式）。
  • 嵌套模型：支持模型内包含其他BaseModel（如address: AddressModel）。

• 路径参数 → 从 URL 路径提取。
• 查询参数 → 从?后的键值对提取。
• 请求体参数 → 从 JSON 正文提取。

@app.put("/items/{item_id}") async def update_item( item_id: int, # 路径参数 q: str = None, # 查询参数 item: Item # 请求体参数（Pydantic 模型） ): return {"item_id": item_id, "q": q, "item": item}

• 请求示例：
  • URL：/items/42?q=update
  • Body：{"name": "Foo", "price": 50.0}

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

• 注意：不能与纯 JSON 请求体混用（文件上传同理）。

@app.post("/upload") async def upload(file: UploadFile = File(..., content_type="image/jpeg")): return {"filename": file.filename, "size": len(await file.read())}

• 关键特性：
  • 流式处理：大文件需用file.file.read(chunk_size)避免内存溢出。
  • 内容校验：通过content_type限制文件类型。

@app.get("/") async def read( user_agent: str = Header(None), session_id: str = Cookie(None) ): return {"user_agent": user_agent, "session_id": session_id}

async def func(item_id: int, q: str, item: Item) # 正确 async def func(item: Item, item_id: int, q: str) # 同样正确

async def func(*, item_id: int = Path(...), q: str): ... # 允许 item_id 在 q 之后

{ "detail": [ { "loc": ["body", "price"], "msg": "Input should be a valid number, unable to parse string as a number", "type": "float_parsing", "input": "invalid" } ] }