Création d'un test d'API REST

Créez un test d'API REST pour tester les temps de réponse et la disponibilité de votre application Web à l'aide des méthodes HTTP suivantes : GET, POST, PUT et DELETE.

Pourquoi et quand exécuter cette tâche

Utilisez les tests d'API REST pour surveiller la disponibilité et les performances de votre application Web et des autres URL en réponse aux appels REST.

Procédure

Pour créer une API REST, procédez comme suit :

  1. Si vous affichez la page Récapitulatif d'Availability Monitoring pour votre application, cliquez sur Ajouter un nouveau test.
    Page Récapitulatif d'Availability Monitoring pour votre application.
    Si le tableau de bord d'Availability Monitoring est affiché, cliquez sur Ajouter un nouveau test dans le panneau Tests synthétiques.

    Bouton Ajouter un nouveau test sur le panneau Tests synthétiques.

  2. Cliquez sur Action unique sur la page Configuration de la surveillance puis sur API REST sur la page Action unique.
  3. Entrez un nom significatif pour votre test dans la zone Nom. Ajoutez une description de l'objectif du test dans la zone Description.
  4. Dans la section relative à la demande, sélectionnez le type de méthode dans la liste Méthode et entrez une valeur dans la zone URL correspondant à l'URL que vous voulez tester avec cette méthode.
    Vous pouvez choisir GET, PUT, POST ou DELETE. Si vous choisissez la méthode PUT ou POST, vous pouvez entrer le contenu du corps à tester dans la zone Corps de demande (facultatif).

    Par exemple, le test d'API REST suivant utilise la méthode POST pour demander que votre application Web accepte des données en plus de tester la disponibilité et les performances de cette application Web.

    Exemple de test d'API REST utilisant la méthode de demande POST.

  5. Facultatif : Configurez votre test pour y inclure un en-tête particulier et une valeur. Entrez un nom d'en-tête et une valeur d'en-tête dans les zones En-tête.

    Si l'application Web à tester requiert un nom de connexion et un mot de passe d'utilisateur, entrez "Authorization" dans la zone relative au nom d'en-tête. Entrez le mot Basic, un espace et la valeur codée en base64 de username:password dans la zone relative à la valeur d'en-tête.

    Par exemple, si votre nom d'utilisateur est Aladdin et que votre mot de passe est OpenSesame, entrez le mot Basic, un espace et la valeur codée en base64 de Aladdin:OpenSesame dans la zone relative à la valeur d'en-tête.

    Zones d'en-tête illustrant les données d'identification de l'autorisation de test en base64.

  6. Configurez les seuils d'alerte (Avertissement et Critique) pour votre test dans la section Validation de réponse. Editez le contenu des zones Valeur et Unité pour chaque ligne.
    Les temps de réponse qui dépassent les seuils Avertissement et Critique que vous avez définis déclenchent des alertes.

    Section Validation de réponse avec les seuils Avertissement et Critique par défaut.

  7. Facultatif : Cliquez sur Ajouter une condition pour définir et ajouter des conditions de validation de réponses personnalisées.
    Les conditions de validation de réponses personnalisées sont évaluées globalement pour générer une alerte. Vous pouvez définir et ajouter jusqu'à six conditions personnalisées pour votre test.
    Important :

    Dans Availability Monitoring, chaque test peut générer un total de trois alertes au maximum. Votre test signale l'alerte de plus haute gravité jusqu'à ce que toutes les conditions causant les alertes soient résolues. Pour plus d'informations, voir Génération d'alertes dans Availability Monitoring.

    Vous pouvez valider les données suivantes :
    Header response code
    Sélectionnez Header response code pour effectuer un test pour un code de réponse HTTP ou pour une plage de codes de réponses HTTP.
    Header property
    Sélectionnez Header property pour effectuer un test pour une valeur et une propriété particulière de zone d'en-tête HTTP.
    Body JSON
    Sélectionnez Body JSON pour tester une propriété particulière d'un corps JSON.

    Pour chaque condition, entrez une propriété à tester dans la zone Cible, et une valeur à tester dans la zone Valeur. Sélectionnez un opérateur dans le menu déroulant Opération. Finalement, choisissez une valeur Gravité de l'alerte, Avertissement ou Critique, pour votre condition.

    Important :

    Les valeurs numériques que vous entrez dans la zone Valeur sont traitées en tant que nombres, par défaut, et non comme des chaînes. Pour entrer une Valeur pour une condition de validation de réponse, utilisez des guillemets afin de faire la distinction entre une chaîne et un nombre. Pour effectuer un test pour la chaîne 123, par exemple, entrez "123" dans la zone Valeur. Pour procédez à une vérification pour le nombre 400, entrez 400 sans les guillemets.

    Conditions de validation de réponse personnalisées pour le code de réponse d'en-tête, la propriété d'en-tête et le corps JSON.

  8. Cliquez sur Vérifier pour créer votre test d'API REST et déterminer si votre demande de test est valide.

    Availability Monitoring détermine la validité du test à l'aide de la méthode HTTP sélectionnée et des en-têtes de demande que vous avez définis pour le test. La validation de la réponse n'a pas lieu pendant la vérification du test.

    Votre test validé est affiché dans la table Eléments vérifiés. Vous pouvez ajouter d'autres URL en répétant les étapes 3 à 8.

  9. Pour configurer vos paramètres de test, cliquez sur Suivant.

    Un récapitulatif de la configuration de test est affiché. Le message suivant est affiché pour les paramètres par défaut :

    Test will occur: Every 15 minutes from 3 public locations and no private locations simultaneously to determine if test exceeds the specified threshold.

  10. Dans le panneau Paramètres, cliquez sur Editer pour afficher les paramètres actuels de votre test.
    Vous pouvez mettre à jour les paramètres suivants :
    • Intervalle définit la fréquence d'exécution du test.
    • Testing frequency détermine si votre test s'exécute à partir de tous les emplacements simultanément ou d'un emplacement différent pour chaque intervalle. Sélectionnez Simultanée pour exécuter votre test depuis tous les emplacements simultanément, ou Echelonnée pour l'exécuter depuis un emplacement différent à chaque intervalle.
    • Locations détermine les emplacements où le test s'exécute.
  11. Sélectionnez vos emplacements dans la liste des emplacements publics. Pour sélectionner un emplacement privé à partir duquel vous exécuterez votre test, vous devez au préalable installer et configurer un point de présence privé sur la machine à partir de laquelle vous souhaitez exécuter votre test. Pour plus d'informations, voir Installation et configuration d'emplacements de points de présence privés.
  12. Cliquez sur Sauvegarder pour terminer la configuration de votre test, puis cliquez sur Terminer.
    Le tableau de bord d'Availability Monitoring s'affiche. Après une minute, le tableau de bord affiche les informations et les données de votre nouveau test.