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

在本文中，我们将介绍FastAPI中如何通过视图名称（路由名称）检索URL。FastAPI是一个现代、快速（高性能）的Web框架，适用于构建API。它基于星号参数声明，并支持自动交互式文档。

背景

在FastAPI中，我们可以使用装饰器@app.route()为视图函数指定一个唯一的名称，即路由名称。这样做的一个好处是，我们可以通过路由名称来构建URL，而不仅仅是通过手动编写URL字符串。这种方式具有很多优点，例如减少代码中的硬编码、提高可维护性和安全性等。

使用`url_for()`函数

要从视图名称（路由名称）中检索URL，我们可以使用FastAPI的url_for()函数。url_for()函数根据给定的路由名称和可选的参数来生成URL。

下面是一个简单的示例，展示了如何使用url_for()函数从视图名称中获取URL：

from fastapi import FastAPI, url_for

app = FastAPI()

@app.get("/hello", name="hello_endpoint")
def hello():
    return {"message": "Hello, World!"}

@app.get("/greet/{name}", name="greet_endpoint")
def greet(name: str):
    return {"message": f"Hello, {name}!"}

@app.get("/")
def main():
    return {"urls": {
        "hello": url_for("hello_endpoint"),
        "greet": url_for("greet_endpoint", name="Alice")
    }}

在上面的示例中，我们创建了三个视图函数hello()、greet()和main()，分别对应着三个不同的路由。

hello()函数的路由为/hello，并且我们为它指定了一个名称hello_endpoint；
greet()函数的路由为/greet/{name}，其中{name}是一个路径参数，它接受一个字符串类型的参数，并通过字符串插值的方式在返回结果中使用该参数，我们也为这个路由指定了一个名称greet_endpoint；
main()函数的路由为/，这是一个根路由。

在main()函数中，我们使用url_for()函数来检索hello()和greet()函数的URL。通过使用url_for()函数，我们可以根据路由名称自动生成URL，并将生成的URL作为结果返回。在上述示例中，我们还使用了一个路径参数name，并通过url_for()函数将其传递给greet_endpoint。

在浏览器中运行FastAPI应用程序并访问根路由，我们将得到一个JSON响应，其中包含由url_for()函数生成的hello()和greet()函数的URL。例如：

{
    "urls": {
        "hello": "/hello",
        "greet": "/greet/Alice"
    }
}

如您所见，我们通过路由名称生成了URL，而无需手动编写URL字符串。

总结

在本文中，我们介绍了FastAPI中如何通过视图名称（路由名称）检索URL。我们使用了@app.route()装饰器为视图函数指定唯一的名称，并使用url_for()函数根据路由名称自动生成URL。这种方式使得URL的生成更加简单、可维护性更强，并且减少了代码中的硬编码。希望本文对您理解并使用FastAPI提供的URL检索功能有所帮助。