Wie definiere ich mehrere API-Endpunkte mit unterschiedlichen Pfaden und demselben Pfadparameter in FastAPI?

Definieren mehrerer API-Endpunkte mit unterschiedlichen Pfaden und demselben Pfadparameter in FastAPI

In FastAPI kann die Deklaration mehrerer API-Endpunkte mit unterschiedlichen Pfaden, aber demselben Pfadparameter dazu führen unerwartetes Routenanpassungsverhalten.

Betrachten Sie das folgende Beispiel:

<code class="python"># GET API Endpoint 1
@router.get("/project/{project_id}/{employee_id}")
async def method_one(project_id: str, employee_id: str, ...):

    # ...

# GET API Endpoint 2
@router.get("/project/details/{project_id}")
async def method_two(project_id: str, ...):

    # ...

# GET API Endpoint 3
@router.get("/project/metadata/{project_id}")
async def method_three(project_id: str, ...):

    # ...</code>

Wenn in diesem Szenario die API-Endpunkte 2 und 3 aufgerufen werden, führen sie die in Endpunkt 1 definierte Controller-Methode aus, nämlich method_one (). Dies liegt daran, wie FastAPI Endpunkte nacheinander auswertet.

Lösung

Um eine ordnungsgemäße Routenübereinstimmung sicherzustellen, müssen Sie Endpunkte in der Reihenfolge ihrer Pfadspezifität deklarieren. Da Endpunkte nacheinander ausgewertet werden, sollten Endpunkte mit spezifischeren Pfaden zuerst deklariert werden.

Im obigen Beispiel ist der Endpunkt für /project/{project_id}/{employee_id} spezifischer als der Endpunkt für /project/ Details/{Projekt-ID}. Daher lautet die korrekte Deklarationsreihenfolge:

<code class="python"># GET API Endpoint 1
@router.get("/project/details/{project_id}")
async def method_two(project_id: str, ...):

    # ...

# GET API Endpoint 2
@router.get("/project/metadata/{project_id}")
async def method_three(project_id: str, ...):

    # ...

# GET API Endpoint 3
@router.get("/project/{project_id}/{employee_id}")
async def method_one(project_id: str, employee_id: str, ...):

    # ...</code>

Wenn Sie diese Reihenfolge befolgen, werden beim Aufruf der Endpunkte 2 und 3 die entsprechenden Methoden method_two() und method_ three() wie vorgesehen ausgeführt.

Das obige ist der detaillierte Inhalt vonWie definiere ich mehrere API-Endpunkte mit unterschiedlichen Pfaden und demselben Pfadparameter in FastAPI?. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!