FastAPI 如何使用 include_router？

推荐答案

在 FastAPI 中，include_router 是一个用于将路由添加到应用程序中的方法。它允许你将定义在其他模块中的路由集成到主应用程序中。以下是一个简单的示例：

from fastapi import FastAPI
from .routers import users, items

app = FastAPI()

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

在这个示例中，users 和 items 是两个不同的模块，每个模块都定义了自己的路由。通过 include_router，我们将这些路由添加到主应用程序中。

本题详细解读

1. include_router 的作用

include_router 是 FastAPI 中用于将路由添加到应用程序的核心方法。它允许你将路由模块化，使得代码更易于维护和扩展。

2. 如何使用 include_router

假设你有两个模块 users.py 和 items.py，每个模块都定义了自己的路由：

# users.py
from fastapi import APIRouter

router = APIRouter()

@router.get("/users/")
def read_users():
    return [{"username": "user1"}, {"username": "user2"}]

# items.py
from fastapi import APIRouter

router = APIRouter()

@router.get("/items/")
def read_items():
    return [{"item_name": "item1"}, {"item_name": "item2"}]

在主应用程序中，你可以使用 include_router 将这些路由添加到应用程序中：

from fastapi import FastAPI
from .routers import users, items

app = FastAPI()

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

3. include_router 的参数

include_router 方法有几个常用的参数：

• prefix: 为路由添加前缀。例如，app.include_router(users.router, prefix="/api") 会将 /users/ 路由变为 /api/users/。
• tags: 为路由添加标签，方便在 API 文档中进行分类。
• dependencies: 为路由添加全局依赖项。

app.include_router(users.router, prefix="/api", tags=["users"])

4. 路由的模块化

通过 include_router，你可以将应用程序的路由分散到多个模块中，使得代码结构更加清晰。例如，你可以将用户相关的路由放在 users.py 中，将商品相关的路由放在 items.py 中，然后在主应用程序中统一导入。

5. 嵌套路由

你还可以使用 include_router 来实现嵌套路由。例如，你可以在一个路由中包含另一个路由：

# sub_routers.py
from fastapi import APIRouter

router = APIRouter()

@router.get("/sub/")
def read_sub():
    return {"message": "This is a sub-router"}

# main.py
from fastapi import FastAPI
from .routers import sub_routers

app = FastAPI()

app.include_router(sub_routers.router, prefix="/main")

在这个例子中，/main/sub/ 将会返回 {"message": "This is a sub-router"}。

6. 总结

include_router 是 FastAPI 中一个非常强大的工具，它允许你将路由模块化，并且可以灵活地添加前缀、标签和依赖项。通过合理使用 include_router，你可以构建出结构清晰、易于维护的 FastAPI 应用程序。