FastAPI: 从视图名称（路由名称）中检索URL

在本文中，我们将介绍如何使用FastAPI从视图名称（路由名称）中检索URL。FastAPI是一个现代、快速（高性能）的Web框架，用于构建API（应用程序编程接口）。它基于Python类型提示和异步支持，可以帮助开发人员快速构建可靠的API。

阅读更多：FastAPI 教程

背景

在开发Web应用程序时，我们通常需要定义多个路由，并给每个路由指定一个名称。这些路由用于暴露不同的功能和端点。有时，我们需要根据路由的名称获取其URL。这在构建链接或重定向到其他路由时非常有用。

FastAPI使用Router对象来管理路由。每个路由都有一个唯一的名称，可以使用这个名称来检索与路由相关联的URL。

获取URL from 视图名称（route name）

为了从视图名称中获取URL，我们首先需要导入FastAPI和Router类。然后，我们创建一个名为app的FastAPI应用程序对象，并将其传递给Router类的构造函数，以创建一个路由对象。

from fastapi import FastAPI
from fastapi.routing import APIRouter

app = FastAPI()
router = APIRouter()

接下来，我们可以使用router对象的add_route方法来添加具体的路由。此方法接受路由的名称、URL模式和处理函数作为参数。

@router.get("/users", name="get_users")
async def get_users():
    return {"message": "List of users"}

@router.get("/users/{user_id}", name="get_user")
async def get_user(user_id: int):
    return {"message": f"User details for id {user_id}"}

app.include_router(router)

现在，我们已经定义了两个路由：一个用于获取所有用户的列表，另一个用于获取特定用户的详细信息。每个路由都分配了一个名称，分别是get_users和get_user。

要检索与特定路由名称关联的URL，我们可以使用app.url_path_for函数。此函数接受路由名称作为参数，并返回与该名称关联的URL。

url = app.url_path_for("get_users")
print(url)  # 输出：/users

url = app.url_path_for("get_user", user_id=1)
print(url)  # 输出：/users/1

在上面的示例中，我们首先使用app.url_path_for函数检索了与get_users路由名称关联的URL，并将其打印出来。输出将是/users。接下来，我们使用了带有user_id参数的get_user路由名称来检索与该名称关联的URL，并将其打印出来。

总结

本文介绍了如何使用FastAPI从视图名称中检索URL。我们使用FastAPI的Router类来创建路由对象，并使用add_route方法为每个路由添加名称和URL模式。然后，我们使用app对象的url_path_for函数来检索特定路由名称关联的URL。

FastAPI提供了一个简单直观的方法来处理路由和URL，使我们能够轻松地构建可靠的API。通过有效地利用FastAPI的功能，我们可以更高效地开发Web应用程序。快乐编码！