python - FastAPI：从视图名称（路由名称）中检索 URL

Question

假设我有以下观点，

from fastapi import FastAPI

app = FastAPI()


@app.get('/hello/')
def hello_world():
    return {"msg": "Hello World"}


@app.get('/hello/{number}/')
def hello_world_number(number: int):
    return {"msg": "Hello World Number", "number": number}

我一直在 Flask 和 Django 中使用这些函数

• 烧瓶：url_for(...)
• 姜戈：reverse(...)

那么，我怎样才能以类似的方式获取/构建 和 的 URL hello_world？hello_world_number

标签： pythonpython-3.xfastapi

Answer 1

我们得到了Router.url_path_for(...)位于starlette包内的方法

方法一：使用FastAPI实例

FastAPI当您能够在当前上下文中访问实例时，此方法很有用。（感谢@Yagizcan Degirmenci）

from fastapi import FastAPI

app = FastAPI()


@app.get('/hello/')
def hello_world():
    return {"msg": "Hello World"}


@app.get('/hello/{number}/')
def hello_world_number(number: int):
    return {"msg": "Hello World Number", "number": number}


print(app.url_path_for('hello_world'))
print(app.url_path_for('hello_world_number', number=1}))
print(app.url_path_for('hello_world_number', number=2}))

# Results

/hello/
/hello/1/
/hello/2/

退税

• 如果我们使用APIRouter,router.url_path_for('hello_world')可能不起作用，因为router它不是FastAPI类的实例。也就是说，我们必须有FastAPI实例来解析 URL

方法二：Request实例

Request当您通常可以在视图中访问实例（传入请求）时，此方法很有用。

from fastapi import FastAPI, Request

app = FastAPI()


@app.get('/hello/')
def hello_world():
    return {"msg": "Hello World"}


@app.get('/hello/{number}/')
def hello_world_number(number: int):
    return {"msg": "Hello World Number", "number": number}


@app.get('/')
def named_url_reveres(request: Request):
    return {
        "URL for 'hello_world'": request.url_for("hello_world"),
        "URL for 'hello_world_number' with number '1'": request.url_for("hello_world_number", number=1),
        "URL for 'hello_world_number' with number '2''": request.url_for("hello_world_number", number=2})
    }

# Result Response

{
    "URL for 'hello_world'": "http://0.0.0.0:6022/hello/",
    "URL for 'hello_world_number' with number '1'": "http://0.0.0.0:6022/hello/1/",
    "URL for 'hello_world_number' with number '2''": "http://0.0.0.0:6022/hello/2/"
}

退税

• 我们必须request在每个（或必需的）视图中包含该参数以解析 URL，这可能会给开发人员带来丑陋的感觉。