Comment définir plusieurs points de terminaison d'API avec différents chemins et le même paramètre de chemin dans FastAPI ?

Définition de plusieurs points de terminaison d'API avec des chemins différents et le même paramètre de chemin dans FastAPI

Dans FastAPI, déclarer plusieurs points de terminaison d'API avec des chemins différents mais le même paramètre de chemin peut conduire à comportement de correspondance d'itinéraire inattendu.

Considérons l'exemple suivant :

<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>

Dans ce scénario, lorsque les points de terminaison de l'API 2 et 3 sont appelés, ils exécutent la méthode du contrôleur définie dans le point de terminaison 1, à savoir method_one (). Cela est dû à la façon dont FastAPI évalue les points de terminaison dans l'ordre.

Solution

Pour garantir une correspondance d'itinéraire appropriée, vous devez déclarer les points de terminaison dans l'ordre de leur spécificité de chemin. Étant donné que les points de terminaison sont évalués de manière séquentielle, les points de terminaison avec des chemins plus spécifiques doivent être déclarés en premier.

Dans l'exemple ci-dessus, le point de terminaison de /project/{project_id}/{employee_id} est plus spécifique que le point de terminaison de /project/. détails/{project_id}. Par conséquent, l'ordre de déclaration correct est :

<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>

En suivant cet ordre, lorsque les points de terminaison 2 et 3 sont appelés, les méthodes correspondantes method_two() et method_trois() seront exécutées comme prévu.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!