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

问题

GET API Endpoint 1

GET API 端点 2

原因

获取 API 端点 1

首页

后端开发

Python教程

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

Patricia Arquette

Oct 30, 2024 pm 05:08 PM

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

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

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

问题

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

</p><h1 id="GET-API-Endpoint">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 id="GET-API-端点">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"># ...

登录后复制

获取 API 端点 3

@router.get("/project/metadata/{project_id}")

# ...

登录后复制

获取 API 端点 1

@router.get("/project/{project_id}/{employee_id}")

# ...

登录后复制

通过进行此修改，FastAPI将首先评估端点 2 和 3，确保在向这些端点发出请求时执行适当的控制器方法。

以上是如何在 FastAPI 中使用相同路径参数定义多个 API 端点？的详细内容。更多信息请关注PHP中文网其他相关文章！

本站声明

本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系admin@php.cn

热AI工具

热工具

热门话题

Java教程

1668

CakePHP 教程

1426

Laravel 教程

1328

PHP教程

1273

C# 教程

1255

显示更多

Related knowledge

Python：游戏，Guis等 Apr 13, 2025 am 12:14 AM

Python在游戏和GUI开发中表现出色。1)游戏开发使用Pygame，提供绘图、音频等功能，适合创建2D游戏。2)GUI开发可选择Tkinter或PyQt，Tkinter简单易用，PyQt功能丰富，适合专业开发。

Python与C：学习曲线和易用性 Apr 19, 2025 am 12:20 AM

Python更易学且易用，C 则更强大但复杂。1.Python语法简洁，适合初学者，动态类型和自动内存管理使其易用，但可能导致运行时错误。2.C 提供低级控制和高级特性，适合高性能应用，但学习门槛高，需手动管理内存和类型安全。

Python和时间：充分利用您的学习时间 Apr 14, 2025 am 12:02 AM

要在有限的时间内最大化学习Python的效率，可以使用Python的datetime、time和schedule模块。1.datetime模块用于记录和规划学习时间。2.time模块帮助设置学习和休息时间。3.schedule模块自动化安排每周学习任务。

Python vs.C：探索性能和效率 Apr 18, 2025 am 12:20 AM

Python在开发效率上优于C ，但C 在执行性能上更高。1.Python的简洁语法和丰富库提高开发效率。2.C 的编译型特性和硬件控制提升执行性能。选择时需根据项目需求权衡开发速度与执行效率。

Python标准库的哪一部分是：列表或数组？ Apr 27, 2025 am 12:03 AM

pythonlistsarepartofthestAndArdLibrary，herilearRaysarenot.listsarebuilt-In，多功能，和Rused ForStoringCollections，而EasaraySaraySaraySaraysaraySaraySaraysaraySaraysarrayModuleandleandleandlesscommonlyusedDduetolimitedFunctionalityFunctionalityFunctionality。