简体中文(ZH-CN) English(EN) 繁体中文(ZH-TW) 日本語(JA) 한국어(KO) Melayu(MS) Français(FR) Deutsch(DE)
Home > Backend Development > Python Tutorial > body text

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

Patricia Arquette
Release： 2024-10-30 17:08:02
Original
410 people have browsed it

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

Defining Multiple API Endpoints with Same Path Parameter in FastAPI

In FastAPI, defining multiple API endpoints with the same path parameter but different paths is not straightforward. As the order of endpoint evaluation matters, the endpoint defined first will always be triggered, regardless of the request's specific path.

Problem

Consider the following router file where three endpoints are defined, each with a different path but sharing the "project_id" path parameter:

</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;"><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"># ...
Copy after login
Copy after login
Copy after login
Copy after login

GET API Endpoint 2

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

# ...
Copy after login
Copy after login
Copy after login
Copy after login

GET API Endpoint 3

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

# ...
Copy after login
Copy after login

This code exhibits unexpected behavior where API Endpoints 2 and 3 invoke the controller method defined in Endpoint 1 (method_one()).

Reason

In FastAPI, endpoint evaluation occurs sequentially. Therefore, Endpoint 1 ("/project/{project_id}/{employee_id}") is evaluated first. When a subsequent request is made to Endpoint 2 or Endpoint 3, FastAPI interprets the "/project/{project_id}" portion of the path as the project_id parameter for Endpoint 1. This results in the controller method for Endpoint 1 being invoked.

Solution

To resolve this issue, the order of endpoint definition should be reversed so that the endpoints with the same path parameter are defined before the endpoint that includes additional path parameters:

</p>
<h1>GET API Endpoint 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;"><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"># ...
Copy after login
Copy after login
Copy after login
Copy after login

GET API Endpoint 3

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

# ...
Copy after login
Copy after login
Copy after login
Copy after login

GET API Endpoint 1

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

# ...
Copy after login
Copy after login

By making this modification, FastAPI will evaluate Endpoints 2 and 3 first, ensuring that the appropriate controller methods are executed when requests are made to those endpoints.

The above is the detailed content of How to Define Multiple API Endpoints with the Same Path Parameter in FastAPI?. For more information, please follow other related articles on the PHP Chinese website!

source：php.cn
Previous article：Why does `list.__iadd__` modify both original and assigned lists, while `list.__add__` only modifies the assigned list? Next article：How can I efficiently parse fixed-width file lines in Python?
Statement of this Website
The content of this article is voluntarily contributed by netizens, and the copyright belongs to the original author. This site does not assume corresponding legal responsibility. If you find any content suspected of plagiarism or infringement, please contact admin@php.cn
Latest Articles by Author
Latest Issues
function_exists() cannot determine the custom function Function test () {return true;} if (function_exists ('test')) {echo "test is function...
From 2024-04-29 11:01:01
0
2
1710
How to display the mobile version of Google Chrome Hello teacher, how can I change Google Chrome into a mobile version?
From 2024-04-23 00:22:19
0
10
1872
The child window operates the parent window, but the output does not respond. The first two sentences are executable, but the last sentence cannot be implemented.
From 2024-04-19 15:37:47
0
1
1586
There is no output in the parent window document.onclick = function(){ window.opener.document.write('I am the output of the child ...
From 2024-04-18 23:52:34
0
1
1503
Where is the courseware about CSS mind mapping? Courseware
From 2024-04-16 10:10:18
0
0
1541
Related Topics
More>
Popular Recommendations
Popular Tutorials
More>
Related Tutorials
Popular Recommendations
Latest courses
Latest Downloads
More>
Web Effects
Website Source Code
Website Materials
Front End Template
About us Disclaimer Sitemap
php.cn：Public welfare online PHP training，Help PHP learners grow quickly！