文章专题学习下载问答编程词典手游最近更新

简体中文(ZH-CN) English(EN) 繁体中文(ZH-TW) 日本語(JA) 한국어(KO) Melayu(MS) Français(FR) Deutsch(DE)

首页 > 后端开发 > Python教程 > 正文

如何在 FastAPI 中使用相同路径参数定义多个 API 端点？

Patricia Arquette

发布： 2024-10-30 17:08:02

原创

408 人浏览过

How to Define Multiple API Endpoints with the Same Path Parameter in FastAPI?

在 FastAPI 中定义具有相同路径参数的多个 API 端点

在 FastAPI 中，定义具有相同路径参数但不同的多个 API 端点路径并不简单。由于端点评估的顺序很重要，无论请求的具体路径如何，首先定义的端点都将始终被触发。

问题

考虑以下路由器文件其中定义了三个端点，每个端点具有不同的路径，但共享“project_id”路径参数：

</p><h1>GET API Endpoint 1</h1><p>@router.get("/project/{project_id}/{employee_id}")<br>async def method_one(project_id: str,organization_id: str, session: AsyncSession = Depends(get_db)):</p> <div class="code" style="position:relative; padding:0px; margin:0px;"><div class="code" style="position:relative; padding:0px; margin:0px;"><pre class="brush:php;toolbar:false"># ...

登录后复制

GET API 端点 2

@router.get("/project/details/{project_id}")
async def method_two(project_id: str, session: AsyncSession = Depends(get_db) )):

# ...

登录后复制

GET API 端点 3

@router.get("/project/metadata/{project_id}")
async def method_two(project_id: str, session) : AsyncSession = Depends(get_db)):

# ...

登录后复制

此代码表现出意外行为，其中 API 端点 2 和 3 调用端点 1 中定义的控制器方法 (method_one ()).

原因

在 FastAPI 中，端点评估是按顺序发生的。因此，首先评估端点 1（“/project/{project_id}/{employee_id}”）。当向端点 2 或端点 3 发出后续请求时，FastAPI 会将路径的“/project/{project_id}”部分解释为端点 1 的 project_id 参数。这会导致调用端点 1 的控制器方法。

解决方案

要解决此问题，应颠倒端点定义的顺序，以便在包含附加路径的端点之前定义具有相同路径参数的端点参数：

</p><h1>GET API 端点 2</h1><p>@router.get("/project/details/{project_id} ")</p><div class="code" style="position:relative; padding:0px; margin:0px;"><div class="code" style="position:relative; padding:0px; margin:0px;"><pre class="brush:php;toolbar:false"># ...

登录后复制