Python FastApi系列教程（第13课）：APIRouter详解与实践

        如果你正在开发一个应用程序或 Web API，很少会将所有的内容都放在一个文件中。FastAPI 提供了一个方便的工具，可以在保持所有灵活性的同时构建你的应用程序。假设你的文件结构如下：

.
├── app                  # 「app」是一个 Python 包
│   ├── __init__.py      # 这个文件使「app」成为一个 Python 包
│   ├── main.py          # 「main」模块，例如 import app.main
│   ├── dependencies.py  # 「dependencies」模块，例如 import app.dependencies
│   └── routers          # 「routers」是一个「Python 子包」
│   │   ├── __init__.py  # 使「routers」成为一个「Python 子包」
│   │   ├── items.py     # 「items」子模块，例如 import app.routers.items
│   │   └── users.py     # 「users」子模块，例如 import app.routers.users
│   └── internal         # 「internal」是一个「Python 子包」
│       ├── __init__.py  # 使「internal」成为一个「Python 子包」
│       └── admin.py     # 「admin」子模块，例如 import app.internal.admin

1 APIRouter

        假设专门用于处理用户逻辑的文件是位于 /app/routers/users.py 的子模块。你希望将与用户相关的路径操作与其他代码分开，以使其井井有条。但它仍然是同一 FastAPI 应用程序/web API 的一部分（它是同一「Python 包」的一部分）。你可以使用 APIRouter 为该模块创建路径操作。你可以导入它并通过与 FastAPI 类相同的方式创建一个「实例」：

from fastapi import APIRouter

router = APIRouter()

        然后你可以使用它来声明路径操作。使用方式与 FastAPI 类相同：

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


@router.get("/users/me", tags=["users"])
async def read_user_me():
    return {"username": "fakecurrentuser"}


@router.get("/users/{username}", tags=["users"])
async def read_user(username: str):
    return {"username": username}

        你可以将 APIRouter 视为一个「迷你 FastAPI」类。所有相同的选项都得到支持。我们将在主 FastAPI 应用中包含该 APIRouter。

2 依赖项

        我们将需要一些在应用程序的好几个地方所使用的依赖项。因此，我们将它们放在它们自己的 dependencies 模块（app/dependencies.py）中。现在我们将使用一个简单的依赖项来读取一个自定义的 X-Token 请求首部：

from fastapi import Header, HTTPException


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

3 APIRouter其他使用

        假设你在位于 app/routers/items.py 的模块中还有专门用于处理应用程序中「项目」的端点。你具有以下路径操作：

        我们知道此模块中的所有路径操作都有相同的：

        因此，我们可以将其添加到 APIRouter 中，而不是将其添加到每个路径操作中。

from fastapi import APIRouter, Depends, HTTPException

from ..dependencies import get_token_header

router = APIRouter(
    prefix="/items",
    tags=["items"],
    dependencies=[Depends(get_token_header)],
    responses={404: {"description": "Not found"}},
)


fake_items_db = {"plumbus": {"name": "Plumbus"}, "gun": {"name": "Portal Gun"}}


@router.get("/")
async def read_items():
    return fake_items_db


@router.get("/{item_id}")
async def read_item(item_id: str):
    if item_id not in fake_items_db:
        raise HTTPException(status_code=404, detail="Item not found")
    return {"name": fake_items_db[item_id]["name"], "item_id": item_id}

        如我们所愿

3.1 导入依赖项

        这些代码位于 app.routers.items 模块，app/routers/items.py 文件中。我们需要从 app.dependencies 模块即 app/dependencies.py 文件中获取依赖函数。因此，我们通过 .. 对依赖项使用了相对导入：

from ..dependencies import get_token_header

        一个单点 .，例如：

from .dependencies import get_token_header

        表示：

        但是该文件并不存在，我们的依赖项位于 app/dependencies.py 文件中。两个点 ..，例如：

from ..dependencies import get_token_header

        表示：

        同样，如果我们使用了三个点 ...，例如：

from ...dependencies import get_token_header

        那将意味着：

        这将引用 app/ 的往上一级，带有其自己的 __init __.py 等文件的某个包。但是我们并没有这个包。因此，这将在我们的示例中引发错误。

3.2 添加一些自定义的 tags、responses 和 dependencies

        我们不打算在每个路径操作中添加前缀 /items 或 tags =["items"]，因为我们将它们添加到了 APIRouter 中。但是我们仍然可以添加更多将会应用于特定的路径操作的 tags，以及一些特定于该路径操作的额外 responses：

from fastapi import APIRouter, Depends, HTTPException

from ..dependencies import get_token_header

router = APIRouter(
    prefix="/items",
    tags=["items"],
    dependencies=[Depends(get_token_header)],
    responses={404: {"description": "Not found"}},
)

@router.put(
    "/{item_id}",
    tags=["custom"],
    responses={403: {"description": "Operation forbidden"}},
)
async def update_item(item_id: str):
    if item_id != "plumbus":
        raise HTTPException(
            status_code=403, detail="You can only update the item: plumbus"
        )
    return {"item_id": item_id, "name": "The great Plumbus"}

        最后的这个路径操作将包含标签的组合：["items"，"custom"]。并且在文档中也会有两个响应，一个用于 404，一个用于 403。

4 FastAPI 主体

        现在，让我们来看看位于 app/main.py 的模块。在这里你导入并使用 FastAPI 类。这将是你的应用程序中将所有内容联结在一起的主文件。并且由于你的大部分逻辑现在都存在于其自己的特定模块中，因此主文件的内容将非常简单。

        你可以像平常一样导入并创建一个 FastAPI 类。我们甚至可以声明全局依赖项，它会和每个 APIRouter 的依赖项组合在一起。

from fastapi import Depends, FastAPI

from .dependencies import get_query_token, get_token_header
from .internal import admin
from .routers import items, users

app = FastAPI(dependencies=[Depends(get_query_token)])

        由于文件 app/routers/users.py 和 app/routers/items.py 是同一 Python 包 app 一个部分的子模块，因此我们可以使用单个点 . 通过「相对导入」来导入它们。第二个版本是「绝对导入」：

from app.routers import items, users

4.1 避免名称冲突

        我们将直接导入 items 子模块，而不是仅导入其 router 变量。这是因为我们在 users 子模块中也有另一个名为 router 的变量。如果我们一个接一个地导入，例如：

from .routers.items import router
from .routers.users import router

        来自 users 的 router 将覆盖来自 items 中的 router，我们将无法同时使用它们。因此，为了能够在同一个文件中使用它们，我们直接导入子模块：

from .routers import items, users

        现在，让我们来包含来自 users 和 items 子模块的 router。

app.include_router(users.router)
app.include_router(items.router)

        使用 app.include_router()，我们可以将每个 APIRouter 添加到主 FastAPI 应用程序中。它将包含来自该路由器的所有路由作为其一部分。实际上，它将在内部为声明在 APIRouter 中的每个路径操作创建一个路径操作。所以，在幕后，它实际上会像所有的东西都是同一个应用程序一样工作。

4.2 包含一个有自定义 prefix、tags、responses 和 dependencies 的 APIRouter

        现在，假设你的组织为你提供了 app/internal/admin.py 文件。它包含一个带有一些由你的组织在多个项目之间共享的管理员路径操作的 APIRouter。对于此示例，它将非常简单。但是假设由于它是与组织中的其他项目所共享的，因此我们无法对其进行修改，以及直接在 APIRouter 中添加 prefix、dependencies、tags 等：

router = APIRouter()

        但是我们仍然希望在包含 APIRouter 时设置一个自定义的 prefix，以便其所有路径操作以 /admin 开头，我们希望使用本项目已经有的 dependencies 保护它，并且我们希望它包含自定义的 tags 和 responses。

        我们可以通过将这些参数传递给 app.include_router() 来完成所有的声明，而不必修改原始的 APIRouter：

app.include_router(
    admin.router,
    prefix="/admin",
    tags=["admin"],
    dependencies=[Depends(get_token_header)],
    responses={418: {"description": "I'm a teapot"}},
)

        这样，原始的 APIRouter 将保持不变，因此我们仍然可以与组织中的其他项目共享相同的 app/internal/admin.py 文件。结果是在我们的应用程序中，来自 admin 模块的每个路径操作都将具有：

        但这只会影响我们应用中的 APIRouter，而不会影响使用它的任何其他代码。因此，举例来说，其他项目能够以不同的身份认证方法使用相同的 APIRouter。我们还可以直接将路径操作添加到 FastAPI 应用中。这里我们这样做只是为了表明我们可以做到：

@app.get("/")
async def root():
    return {"message": "Hello Bigger Applications!"}

5 查看自动化的 API 文档

        现在，使用 app.main 模块和 app 变量运行 uvicorn。然后打开位于 http://127.0.0.1:8000/docs 的文档。你将看到使用了正确路径（和前缀）和正确标签的自动化 API 文档，包括了来自所有子模块的路径：

6 多次使用不同的 prefix 包含同一个路由器

        你也可以在同一路由器上使用不同的前缀来多次使用 .include_router()。在有些场景这可能有用，例如以不同的前缀公开同一个的 API，比方说 /api/v1 和 /api/latest。这是一个你可能并不真正需要的高级用法，但万一你有需要了就能够用上。

7 在另一个 APIRouter 中包含一个 APIRouter

        与在 FastAPI 应用程序中包含 APIRouter 的方式相同，你也可以在另一个 APIRouter 中包含 APIRouter，通过：

router.include_router(other_router)

        请确保在你将 router 包含到 FastAPI 应用程序之前进行此操作，以便 other_router 中的路径操作也能被包含进来。

作者：游王子og