Assertions
Assertions de la vérification API
Que sont les assertions ?
Une assertion est une condition que la réponse de votre API doit remplir. Vous ajoutez une ou plusieurs assertions à une vérification et, lorsque l'une d'elles n'est pas remplie, la vérification est marquée comme échouée et une alerte se déclenche.
Types d'assertions
- Status code : compare le code de statut HTTP de la réponse à un nombre, par exemple Equals
200ou Less than400. - Response time : compare le temps de réponse total, en millisecondes, à un nombre, par exemple Less than
800. - Body : vérifie que le corps de la réponse contient (Contains) ou ne contient pas (Does not contain) un texte. La correspondance est une sous-chaîne littérale qui respecte la casse ; les expressions régulières ne sont pas prises en charge, et une valeur vide échoue toujours.
Pour le code de statut et le temps de réponse, vous pouvez choisir Equals, Not equals, Equals or Greater than, Equals or Less than, Greater than ou Less than.
Comment ajouter une assertion
- Dans le formulaire de la vérification, repérez la section Assertions et cliquez sur Ajouter une Assertion.
- Choisissez le type (Status code, Response time ou Body).
- Choisissez la comparaison et saisissez la Valeur.
- Enregistrez la vérification.
Assertions échouées et détails de la vérification
Lorsqu'une assertion échoue, la page de détails de la vérification indique laquelle a échoué, pour que vous voyiez pourquoi la vérification a été marquée comme échouée.
Interaction avec les limites de temps de réponse
Si une vérification est plus lente que sa limite de temps de réponse, elle est marquée comme dégradée. Si elle a en plus une assertion qui échoue, la vérification est marquée comme échouée.
Cas d'utilisation pratiques
- Performance : une assertion Response time avec Less than fixe un plafond strict pour votre API.
- Détection d'erreurs : une assertion Status code détecte les erreurs inattendues.
- Contenu : une assertion Body confirme que la réponse contient toujours la valeur attendue, par exemple un nom de champ ou un mot-clé.
Les vérifications multi-étapes prennent en charge les mêmes assertions à chaque étape, voir Vérifications API multi-étapes.