全局依赖项

对于某些类型的应用程序，您可能希望将依赖项添加到整个应用程序中。

与您可以为路径操作装饰器添加 dependencies 的方式类似，您也可以将它们添加到 FastAPI 应用程序中。

在这种情况下，它们将被应用于应用程序中的所有路径操作。

Python 3.10+

from typing import Annotated

from fastapi import Depends, FastAPI, Header, HTTPException


async def verify_token(x_token: Annotated[str, Header()]):
    if x_token != "fake-super-secret-token":
        raise HTTPException(status_code=400, detail="X-Token header invalid")


async def verify_key(x_key: Annotated[str, Header()]):
    if x_key != "fake-super-secret-key":
        raise HTTPException(status_code=400, detail="X-Key header invalid")
    return x_key


app = FastAPI(dependencies=[Depends(verify_token), Depends(verify_key)])


@app.get("/items/")
async def read_items():
    return [{"item": "Portal Gun"}, {"item": "Plumbus"}]


@app.get("/users/")
async def read_users():
    return [{"username": "Rick"}, {"username": "Morty"}]

🤓 其他版本和变体

Python 3.10+ - 非 Annotated

提示

如果可能，请优先使用 Annotated 版本。

from fastapi import Depends, FastAPI, Header, HTTPException


async def verify_token(x_token: str = Header()):
    if x_token != "fake-super-secret-token":
        raise HTTPException(status_code=400, detail="X-Token header invalid")


async def verify_key(x_key: str = Header()):
    if x_key != "fake-super-secret-key":
        raise HTTPException(status_code=400, detail="X-Key header invalid")
    return x_key


app = FastAPI(dependencies=[Depends(verify_token), Depends(verify_key)])


@app.get("/items/")
async def read_items():
    return [{"item": "Portal Gun"}, {"item": "Plumbus"}]


@app.get("/users/")
async def read_users():
    return [{"username": "Rick"}, {"username": "Morty"}]

关于为路径操作装饰器添加 dependencies 一节中的所有概念仍然适用，但在这种情况下，它们适用于应用程序中的所有路径操作。

适用于一组路径操作的依赖项

稍后，当您阅读关于如何构建大型应用程序（大型应用程序 - 多个文件）的内容时（可能涉及多个文件），您将学习如何为一组路径操作声明单个 dependencies 参数。