Assertions
Assertions de la vérification API
Que sont les assertions ?
Les assertions sont des conditions que vous définissez pour valider le code de statut et le temps de réponse de votre requête API. Elles aident à garantir que votre API se comporte comme prévu dans diverses conditions. Lorsqu'une ou plusieurs assertions échouent, une alerte est déclenchée, vous permettant de prendre des mesures immédiates.
Types d'assertions
Vous pouvez définir les types d'assertions suivants pour vos vérifications API :
- Temps de réponse : Définissez une valeur et vérifiez par rapport à cette valeur. Si le temps de réponse dépasse la valeur spécifiée, l'assertion échoue, provoquant l'échec du test.
- Code de statut : Spécifiez le code de statut attendu de la réponse API. Si le code de réponse est différent de la valeur attendue, l'assertion échoue, provoquant l'échec de la vérification API.
Assertions échouées et détails de la vérification
Lorsqu'une assertion échoue, les détails de l'échec seront visibles sur la page de détails de la vérification. Cela inclut des informations sur quelle assertion a échoué et pourquoi, vous aidant à identifier et résoudre rapidement les problèmes.
Interaction avec les limites de réponse
Si une vérification a une limite de temps de réponse et est marquée comme dégradée mais possède également une assertion échouée, la vérification sera marquée comme échouée. Cela garantit que tous les problèmes critiques sont capturés et traités rapidement.
Comment définir les assertions
- Accéder aux paramètres d'assertions : Naviguez vers les paramètres d'assertions de votre vérification API.
- Ajouter des assertions : Spécifiez le type d'assertion que vous souhaitez ajouter (Temps de réponse, Code de statut).
- Définir les critères : Définissez les critères de l'assertion (par exemple, code de statut attendu, temps de réponse maximum).
- Enregistrer les paramètres : Assurez-vous d'enregistrer vos paramètres pour appliquer les assertions.
Cas d'utilisation pratiques
- Surveillance de la performance : Utilisez les assertions de temps de réponse pour vous assurer que votre API respecte les critères de performance.
- Détection d'erreurs : Utilisez les assertions de code de statut pour détecter les erreurs ou échecs inattendus dans votre API.
En utilisant les assertions, vous pouvez vous assurer que vos API fonctionnent comme prévu et fournissent les données correctes, aidant à maintenir la fiabilité et la performance de vos services.