如何从 FastAPI 应用程序获取每条路线路径？

我是 FastAPI 和 Python 的新手。我需要获取根路径上的所有路由并将其显示给用户。但是，我找不到递归获取所有路径的方法。 API 的版本借助以下工具进行：VersionedFastAPI并且当前代码没有给出版本内部的路径；它只返回通用的。

FastAPI后端：

app = FastAPI()
router = APIRouter(
    tags=["utilities"]
)

@router.get("/")
def read_root(request: Request):
    url_list = [
        route.path
        for route in request.app.routes
    ]
    return { "endpoints": set(url_list) }

@app.get('/foo')
@version(1)
def foo():
    return "foo V1"

@app.get('/foo')
@version(2)
def foo():
    return "foo V2"

app = VersionedFastAPI(app, enable_latest=True, version_format='{major}', prefix_format='/v{major}')
app.add_middleware(
    CORSMiddleware,
    allow_origins=["*"],
    allow_credentials=True,
    allow_methods=["*"],
    allow_headers=["*"]
)

app.include_router(router)

获取下找到的路径列表的代码\ route

 url_list = [
            route.path
            for route in request.app.routes
        ]
        return { "endpoints": set(url_list) }

这仅返回：

["/v1/openapi.json","/v2/docs","/openapi.json","/v2/openapi.json","/v2","/","/redoc","/v1","/docs","/docs/oauth2-redirect","/v1/docs","/latest"]

However /foo缺少终点。任何有关这方面的线索都会有帮助。

在下面的示例中，请确保调用get_routes()在将 FastAPI 实例传递给之前VersionedFastAPI。此外，还有一个端点（即/greet），没有指定版本。因此，为了确保此类端点（如果碰巧存在于您的 API 中）将被分配一个版本，您在尝试获取端点的版本时需要定义一个默认值（也可能是最新版本）这行代码：version = getattr(route.endpoint, "_api_version", (2, 0))。通过访问 OpenAPI/Swagger UI 文档：http://127.0.0.1:8000/v1/docs http://127.0.0.1:8000/v1/docs and http://127.0.0.1:8000/v2/docs http://127.0.0.1:8000/v2/docs，你会注意到/greet出现在两个版本的 API 中；因此，可以通过使用/v1/greet or /v2/greet。这是因为它最初并没有给出任何特定的版本；但是，使用任一端点，请求都将被分派到相同的路径操作函数。

工作示例

from fastapi import FastAPI, APIRouter
from fastapi_versioning import VersionedFastAPI, version
import uvicorn


app = FastAPI()
router = APIRouter()
all_routes =[]


def get_routes():
    reserved_routes = ["/openapi.json", "/docs", "/docs/oauth2-redirect", "/redoc"]
    for route in app.routes:
        if route.path not in reserved_routes:
            if route.name is not None:
                version = getattr(route.endpoint, "_api_version", (2, 0))
                all_routes.append("/v" + str(version[0]) + route.path)


@router.get("/")
def index():
    return { "endpoints": all_routes }

 
@app.get("/foo")
@version(1)
def foo():
    return "foo v1"


@app.get("/foo")
@version(2)
def foo():
    return "foo v2"


@app.get("/items/{item_id}")
@version(2)
def get_item(item_id: int):
    return item_id
    

@app.get("/greet")
def greet_with_hi():
    return "Hi"


get_routes()
app = VersionedFastAPI(app, version_format='{major}',prefix_format='/v{major}')
app.include_router(router)


if __name__ == '__main__':
    uvicorn.run(app, host='127.0.0.1', port=8000)

输出（当访问http://127.0.0.1:8000/ http://127.0.0.1:8000/):

{"endpoints":["/v1/foo","/v2/foo","/v2/items/{item_id}","/v2/greet"]}

这个答案 https://stackoverflow.com/a/72239186/17865804对于检索原始路由路径也可能会有所帮助。