Comment gérer les paramètres de requête de liste séparés par les virgules dans FastAPI?

Explication détaillée de la méthode de traitement séparée des virgules des paramètres de liste FastAPI

Lors de la construction d'API à l'aide de FastAPI, il est souvent nécessaire de traiter les paramètres de requête de type liste. Fastapi analyse les paramètres de requête avec le même nom dans une liste par défaut. Par exemple , ?source=manual&source=vdna sera analysé en tant que source=['manual', 'vdna'] . Mais parfois, nous devons transmettre des paramètres de liste avec des chaînes séparées par des virgules, telles que ?source=manual,vdna . Cet article présente deux solutions.

La racine du problème: dans le code d'origine, source a été défini comme list[source] , ce qui a provoqué des paramètres en double de FastAPI dans des listes au lieu des chaînes séparées par des virgules.

Méthode 1: paramètres de chaîne et analyse manuelle

Le moyen le plus direct consiste à modifier le type de paramètre source en des chaînes de Optional[str] et à analyser manuellement les virages à l'intérieur de la fonction. Cette méthode est simple et facile à comprendre sans dépendances supplémentaires.

Exemple de code:

 @ examen.get ('/ list', résumé = 'Get List à réviser')
def list_await_review (
    # ... d'autres paramètres ...
    Source: Facultatif [Str] = Query (None, Description = "Veuillez utiliser`, `pour diviser plusieurs paramètres, tels que` manuelle, VDNA, Text-match` ",
    # ... d'autres paramètres ...
):
    parsed_source = source.split (",") si source else []
    # ... Le code suivant utilise PARSED_SOURCE ...

Cette méthode analyse source dans une chaîne puis la divise dans une liste à l'aide de split(",") . Si source est vide, parsed_source est une liste vide.

Méthode 2: processus d'analyse personnalisé (méthode avancée)

Une approche plus flexible consiste à personnaliser le processus d'analyse, comme la création de dépendances personnalisées pour gérer les chaînes séparées par les virgules. Cette approche peut gérer une logique d'analyse plus complexe, mais nécessite plus d'écriture de code et une compréhension plus approfondie du mécanisme d'injection de dépendance de Fastapi. Le document officiel recommande d'utiliser des invites de type de somme de contrôle des paramètres améliorées Annotated , ce qui est plus avantageux lorsqu'il s'agit de paramètres complexes, mais les détails de mise en œuvre dépassent le cadre de cet article.

La méthode à choisir dépend de vos besoins et de vos compétences FastAPI. Pour les paramètres simples de la liste séparés par des virgules, la méthode 1 est suffisamment efficace et concise; Pour des scénarios plus complexes, la méthode 2 offre une plus grande flexibilité.

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!