如何为FastAPI查询参数实现自定义验证逻辑？

我来给你一个简洁且高效的解决方案，能让你摆脱重复调用验证函数的麻烦——利用Pydantic的Annotated和AfterValidator特性，把路径验证逻辑封装成可复用的类型，自动对指定参数进行校验，校验不通过时直接拦截请求，不会进入处理器方法。

具体实现步骤 #

1. 导入所需模块 #

首先确保你导入了FastAPI、Pydantic相关的验证工具，以及pathlib的Path：

from fastapi import FastAPI, HTTPException, Response
from pathlib import Path
from pydantic import AfterValidator, Annotated
import requests

2. 定义验证函数 #

把你之前的_raise_if_non_relative_path稍作调整，确保它返回验证后的Path对象（符合Pydantic验证器的要求）：

def validate_relative_path(path: Path) -> Path:
    if path.is_absolute():
        raise HTTPException(
            status_code=409,
            detail=f"Absolute paths are not allowed, {path} is absolute."
        )
    return path

3. 创建带验证的类型别名 #

用Annotated把Path类型和验证器绑定，生成一个可复用的RelativePath类型：

RelativePath = Annotated[Path, AfterValidator(validate_relative_path)]

4. 在接口中使用自定义类型 #

现在你可以直接在所有需要验证相对路径的接口参数中使用RelativePath，不需要再手动调用验证函数：

app = FastAPI()

@app.get("/new")
def new_file(where: RelativePath):
    # 执行文件保存操作
    return Response(status_code=requests.codes.ok)

@app.get("/delete")
def delete_file(where: RelativePath):
    # 执行文件删除操作
    return Response(status_code=requests.codes.ok)

为什么这个方案可行？ #

这个方案完美适配你的需求，原因如下：

• 自动拦截无效请求：当传入的路径被解析为Path对象后，AfterValidator会自动触发验证逻辑，如果是绝对路径，直接抛出HTTPException，FastAPI会立即返回错误响应，不会进入处理器方法。
• 复用性强：RelativePath类型可以在所有需要相对路径验证的接口中重复使用，避免了代码重复。
• 精准作用：只有使用了RelativePath类型的参数才会触发验证，不会影响其他不涉及路径参数的接口，比中间件方案更高效。

对你之前尝试方案的补充说明 #

你之前试的几个方案确实存在各自的局限：

• fastapi.Query：仅支持基础的字符串验证，正则匹配绝对路径的方式不够通用（比如不同系统的绝对路径格式不同），自定义验证函数的方式更灵活可靠。
• 子类化Path：FastAPI在处理Path类型参数时，会自动将字符串转换为系统对应的Path子类（比如Linux下的PosixPath、Windows下的WindowsPath），自定义的子类会被忽略，所以这个方案无法生效。
• @app.middleware：中间件会拦截所有请求，不管接口是否需要路径参数，确实会造成不必要的性能开销，不够精准。
• 自定义BaseModel类：Pydantic的BaseModel默认会被解析为请求体（JSON格式），而查询参数是URL的一部分，所以这个方案不适用于查询参数场景。

内容的提问来源于stack exchange，提问作者Sam De Meyer