Pour vous familiariser avec les assertions, nous vous recommandons de lire notre article Gestion des réponses d’API dans les moniteurs multi-étapes où vous trouverez une vue d’ensemble des principales fonctionnalités du moniteur en lien avec les réponses.
Cet article vous indique comment fonctionnent les assertions et comment elles vous aident à vérifier les réponses d’API et à obtenir le comportement attendu.
Assertions
Chaque étape contient un onglet Réponse, où vous pouvez configurer les assertions.
Les assertions sont des conditions qui vous aident à vérifier les réponses d’API. Par exemple, elles vous permettent de vérifier si votre requête d’API a abouti, si la réponse contient un contenu spécifique ou si un comportement inattendu s’est produit. Vous pouvez facilement définir plusieurs validations pour vérifier que votre API répond correctement et renvoie les données attendues.
Dans l’exemple ci-dessous, une assertion vérifie si la valeur du prix du produit est supérieure à 100. Les assertions sont définies au moyen de quatre champs : source, propriété, comparaison et valeur cible.
Chaque champ correspond à une valeur spécifique qui détermine comment la réponse doit être évaluée. La disponibilité des champs peut varier selon la vérification effectuée sur la réponse.
Voici ci-dessous les champs d’assertion que vous pouvez définir selon vos besoins de surveillance.
Source de l’assertion
Ce champ vous permet de définir l’origine ou la source des données à vérifier. Les données peuvent provenir d’un corps de réponse en tant que JSON, d’un corps de réponse en tant que texte ou d’un attribut d’une réponse HTTP, comme un code de statut, ainsi que d’autres nombreux attributs. Pour en savoir plus, vous pouvez lire notre article sur les
sources d’assertion.
Propriété de l’assertion
Dans certains cas, les
sources d’assertion, telles que Corps de réponse en tant que JSON ou En-tête de réponse, nécessitent une vérification de contenu pour valider la réponse. Pour vérifier des données spécifiques dans la réponse, vous devez fournir la valeur de propriété qui correspond à la source de l’assertion. Dans l’exemple ci-dessous, Products[0].Price est la valeur de la propriété.
Comparaison de l’assertion
Ce champ vous permet de sélectionner l’élément de comparaison utilisé pour évaluer la relation avec la valeur cible de l’assertion. Par défaut, cet élément est défini sur est égal à, mais vous pouvez sélectionner d’autres
options de comparaison selon vos besoins.
Valeur cible de l’assertion
Imaginons que vous vouliez comparer le prix d’un produit figurant dans la réponse de l’API avec une valeur donnée, par exemple 10. Dans ce cas, 10 est la valeur cible de l’assertion qui vous servira pour la comparaison.
Ce champ vous permet donc de définir une valeur à utiliser pour la comparaison. Selon la source, la propriété et la comparaison sélectionnée pour l’assertion, cette valeur peut être alphabétique, numérique ou booléenne. Vous pouvez aussi utiliser une variable pour représenter une de ces valeurs.
Que se passe-t-il si une condition d’assertion n’est pas remplie ?
Toutes les assertions d’une étape sont exécutées dès que la requête HTTP a été effectuée et que la réponse a été traitée. En règle générale, chaque assertion est évaluée de façon indépendante, même si une assertion passée échoue. Il est donc possible que plusieurs assertions signalent un échec lors d’une étape.
Si une ou plusieurs assertions échouent, l’exécution du moniteur s’arrête immédiatement. Les étapes suivantes ne sont pas exécutées et la vérification du moniteur signale une erreur. Le code d’erreur et la description dépendent du type d’échec. Si plusieurs assertions échouent, le premier échec de la liste est considéré comme le plus important. Pour que votre moniteur continue d’exécuter toutes les étapes même en cas d’échec, vous pouvez suivre les instructions figurant dans l’article Gestion des erreurs dans les moniteurs d’API multi-étapes.
Dans certains cas, il peut être nécessaire de relancer l’exécution d’une assertion, par exemple lorsqu’un problème de durée peut causer un résultat faussement négatif. Vous pouvez configurer l’assertion pour qu’elle soit évaluée plusieurs fois. Pour en savoir plus, vous pouvez lire notre article Nombre maximal de tentatives.