Catégorie REST

  • Rversion finale: Washingtondc
  • Mis à jour 1 févr. 2024
  • 17 minutes de lecture

    • Vérifiez la fonctionnalité des appels REST.

    Envoyer une demande REST : Entrante : Explorateur d'API REST

    Cette étape de test commence avec l’explorateur d’API REST. Utilisez l’explorateur d’API REST pour créer et spécifier la méthode HTTP, le chemin, les paramètres de requête, les en-têtes de demande et le corps d’une demande REST, puis envoyez la demande REST à l’instance en cours.

    Lorsque vous avez testé la demande, le bouton Créer une étape de test automatisée apparaît. Cliquez sur Créer une étape de test automatisée pour créer l’étape de test. Ce bouton n’apparaît qu’après l’envoi de la demande. Vous ne pouvez pas créer d’étape de test lorsque la charge utile de la demande est supérieure à la propriété de taille maximale de la charge utile de la demande.

    Cette étape de test crée le même enregistrement de test que l’étape de test Envoyer une demande REST - Entrante . Une fois l’étape de test créée, vous ne pouvez pas revenir en arrière et utiliser l’explorateur d’API REST pour mettre à jour le test. Tous les changements doivent être apportés dans le formulaire Envoyer une demande REST - Étape de test entrante .

    Aucune validation de réponse HTTP n’est effectuée dans le cadre de cette étape. L’étape échoue si la taille de la charge utile de la réponse est trop importante, si les paramètres de la demande ne sont pas valides ou si la demande n’a pas pu être envoyée. Utilisez les étapes de déclaration pour valider la réponse.

    Vous ne pouvez pas utiliser cette étape pour envoyer une demande à une autre instance ou à l'adresse distance d'une tierce partie.

    Ces entrées sont destinées à l’explorateur d’API REST. Les champs que vous voyez dépendent de l’API sélectionnée. Pour plus d’informations sur l’utilisation des API REST sur votre instance, consultez API REST.

    Tableau 1. Entrées
    Champ Description
    Espace de noms Espace de noms pour la demande. Sélectionnez-le dans la liste.
    Nom d'API API à utiliser. Sélectionnez-le dans la liste.
    Version de l'API Version d’API à utiliser. Sélectionnez la version disponible sur votre instance dans la liste.
    Paramètres de chemin d'accès La partie du chemin d’accès après le nom de l’API. Les paramètres de chemin d’accès sont généralement des paires nom-valeur où les valeurs autorisées se trouvent dans une liste.
    Paramètres de requête Paires nom-valeur des paramètres de requête ajoutés à l’URI après le chemin d’accès.

    L’explorateur d’API REST code l’URI, il n’est donc pas nécessaire d’encoder les paramètres et les valeurs de requête.
    En-têtes de demandes Paires nom-valeur contenues dans l’en-tête de la demande. L’en-tête d’authentification est défini sur Envoyer en tant que moi pour utiliser les informations d’identification de l’utilisateur actuel. Pour utiliser l’étape de test en production, vous devrez peut-être modifier le champ Authentification de base dans l’étape de test Envoyer REST - Entrant.

    Ne codez pas le nom ou la valeur.
    Corps de la demande Le contenu de la demande. Certaines demandes n’ont pas de corps.

    Envoyer une demande REST : Entrante

    Créez une étape de test pour envoyer une demande REST à l’instance actuelle. Spécifiez la méthode HTTP, le chemin, les paramètres de requête, les en-têtes de demande et le corps d’une demande REST.

    Aucune validation de réponse HTTP n’est effectuée dans le cadre de cette étape. L’étape échoue si la taille de la charge utile de la réponse est trop importante, si les paramètres de la demande ne sont pas valides ou si la demande n’a pas pu être envoyée. Utilisez les étapes de déclaration pour valider la réponse.

    Vous ne pouvez pas utiliser cette étape pour envoyer une demande à une autre instance ou à l'adresse distance d'une tierce partie.

    Pour plus d’informations sur l’utilisation des API REST, consultez les API REST.

    Tableau 2. Entrées
    Champ Description
    Ordre d’exécution Nombre entier spécifiant l’ordre dans lequel le test exécute cette étape.

    Au fur et à mesure que vous créez des étapes, le système affecte automatiquement à chaque étape une valeur incrémentielle. Cette valeur permet au test d’exécuter les étapes dans l’ordre dans lequel vous les avez créées. Vous pouvez modifier cet ordre par défaut en modifiant les valeurs d’ordre d’exécution .
    Actif Option permettant d’activer cette étape de test en vue de son utilisation.
    Application Périmètre de l’application dans lequel le système exécute cette étape.
    Test Nom en lecture seule du test auquel vous ajoutez l’étape.
    Configuration de l'étape Nom en lecture seule de l’étape.
    Description Description de l’étape de test. Cette valeur de champ est automatiquement définie en fonction des valeurs de champ de l’étape de test. Ce champ apparaît une fois l’étape de test envoyée.
    Notes Notes sur l’étape de test.
    Authentification de base Si vous utilisez une API publique, vous n’avez pas besoin de fournir d’informations d’identification d’authentification.

    Si vous utilisez une API non publique, vous devez fournir les informations d’authentification de base lors du test. Si vous laissez ce champ vide, vous risquez de recevoir des résultats inattendus. Par exemple, le code d’état de la réponse peut être 401 Non autorisé au lieu de 200 OK.

    Vous devez créer ou sélectionner un profil d’authentification de base à affecter aux étapes de test afin d’éviter les problèmes d’authentification lors de l’exécution du test.

    Les utilisateurs doivent disposer du rôle web_service_admin pour exploiter pleinement les étapes de test REST. Sans ce rôle, les utilisateurs ne peuvent pas afficher ni définir les profils d’authentification de base nécessaires pour les points de terminaison qui nécessitent une authentification. Sans ce rôle, les utilisateurs peuvent toujours tirer parti des étapes de test REST pour les API publiques et l’accès non authentifié aux API non publiques. Pour un accès complet à l’étape de test REST, le rôle atf_ws_designer est disponible et contient le rôle web_service_admin ainsi que le rôle atf_test_designer.
    Méthode Méthode HTTP à utiliser :
    • GET
    • POST
    • PUT
    • DELETE
    • CORRECTIF
    Chemin Chemin d’accès à utiliser. Ce champ accepte uniquement la partie de l’URI située après le nom de l’instance. Si vous utilisez https://<nom d’instance>, une erreur s’affiche.
    Paramètres de requêtes Interrogez les noms et les valeurs des paramètres. Ne codez pas les noms ou les valeurs des paramètres.
    En-têtes Noms et valeurs des en-têtes. Ne codez pas les noms ou les valeurs des en-têtes.
    Corps Le corps de la demande.

    Code d'état de la déclaration

    Vérifiez que le code d’état de la réponse HTTP a la relation spécifiée avec la valeur spécifiée. Vous spécifiez une valeur numérique du code d’état et de la relation.

    Les étapes de déclaration doivent immédiatement suivre une étape Envoyer une demande REST - Entrante . Vous pouvez avoir plusieurs étapes de déclaration REST à la suite d’une étape Envoyer une demande REST - Entrante , mais les étapes de déclaration ne peuvent pas être séparées des étapes d’envoi de la demande REST - Entrante d’autres catégories de tests.

    Tableau 3. Entrées
    Champ Description
    Ordre d’exécution Nombre entier spécifiant l’ordre dans lequel le test exécute cette étape.

    Au fur et à mesure que vous créez des étapes, le système affecte automatiquement à chaque étape une valeur incrémentielle. Cette valeur permet au test d’exécuter les étapes dans l’ordre dans lequel vous les avez créées. Vous pouvez modifier cet ordre par défaut en modifiant les valeurs d’ordre d’exécution .
    Actif Option permettant d’activer cette étape de test en vue de son utilisation.
    Application Périmètre de l’application dans lequel le système exécute cette étape.
    Test Nom en lecture seule du test auquel vous ajoutez l’étape.
    Configuration de l'étape Nom en lecture seule de l’étape.
    Description Description de l’étape de test. Cette valeur de champ est automatiquement définie en fonction des valeurs de champ de l’étape de test. Ce champ apparaît une fois l’étape de test envoyée.
    Notes Notes sur l’étape de test.
    Opération Comparaison à effectuer entre les valeurs :
    • est
    • n’est pas
    • inférieur à
    • supérieur à
    • inférieur ou égal à
    • supérieur ou égal à
    Code d'état Code d’état à tester par rapport au code de réponse.

    Nom du code d'état de la déclaration

    Vérifiez que le nom du code d’état de la réponse HTTP a la relation spécifiée avec la valeur spécifiée. Spécifiez une valeur du nom du code d’état et la relation.

    Les étapes de déclaration doivent immédiatement suivre une étape Envoyer une demande REST - Entrante . Vous pouvez avoir plusieurs étapes de déclaration REST à la suite d’une étape Envoyer une demande REST - Entrante , mais les étapes de déclaration ne peuvent pas être séparées des étapes d’envoi de la demande REST - Entrante d’autres catégories de tests.

    Tableau 4. Entrées
    Champ Description
    Ordre d’exécution Nombre entier spécifiant l’ordre dans lequel le test exécute cette étape.

    Au fur et à mesure que vous créez des étapes, le système affecte automatiquement à chaque étape une valeur incrémentielle. Cette valeur permet au test d’exécuter les étapes dans l’ordre dans lequel vous les avez créées. Vous pouvez modifier cet ordre par défaut en modifiant les valeurs d’ordre d’exécution .
    Actif Option permettant d’activer cette étape de test en vue de son utilisation.
    Application Périmètre de l’application dans lequel le système exécute cette étape.
    Test Nom en lecture seule du test auquel vous ajoutez l’étape.
    Configuration de l'étape Nom en lecture seule de l’étape.
    Description Description de l’étape de test. Cette valeur de champ est automatiquement définie en fonction des valeurs de champ de l’étape de test. Ce champ apparaît une fois l’étape de test envoyée.
    Notes Notes sur l’étape de test.
    Opération Comparaison à effectuer entre les valeurs :
    • Contient
    • ne contient pas
    • est
    • n’est pas
    Nom du code d'état Nom du code d’état à tester.

    Délai de réponse à la déclaration

    Vérifiez que le délai de réponse HTTP a la relation spécifiée avec la valeur spécifiée. Spécifiez une valeur du délai de réponse et de la relation.

    Les étapes de déclaration doivent immédiatement suivre une étape Envoyer une demande REST - Entrante . Vous pouvez avoir plusieurs étapes de déclaration REST à la suite d’une étape Envoyer une demande REST - Entrante , mais les étapes de déclaration ne peuvent pas être séparées des étapes d’envoi de la demande REST - Entrante d’autres catégories de tests.

    Tableau 5. Entrées
    Champ Description
    Ordre d’exécution Nombre entier spécifiant l’ordre dans lequel le test exécute cette étape.

    Au fur et à mesure que vous créez des étapes, le système affecte automatiquement à chaque étape une valeur incrémentielle. Cette valeur permet au test d’exécuter les étapes dans l’ordre dans lequel vous les avez créées. Vous pouvez modifier cet ordre par défaut en modifiant les valeurs d’ordre d’exécution .
    Actif Option permettant d’activer cette étape de test en vue de son utilisation.
    Application Périmètre de l’application dans lequel le système exécute cette étape.
    Test Nom en lecture seule du test auquel vous ajoutez l’étape.
    Configuration de l'étape Nom en lecture seule de l’étape.
    Description Description de l’étape de test. Cette valeur de champ est automatiquement définie en fonction des valeurs de champ de l’étape de test. Ce champ apparaît une fois l’étape de test envoyée.
    Notes Notes sur l’étape de test.
    Opération Comparaison à effectuer entre le délai de réponse saisi et le délai de réponse réel :
    • inférieur à
    • supérieur à
    Délai de réponse (ms) Temps, en millisecondes, à comparer au délai de réponse réel.

    en-tête de la réponse à la déclaration

    Vérifiez que l’en-tête de réponse HTTP existe ou que l’en-tête a la relation spécifiée avec la valeur spécifiée.

    Les étapes de déclaration doivent immédiatement suivre une étape Envoyer une demande REST - Entrante . Vous pouvez avoir plusieurs étapes de déclaration REST à la suite d’une étape Envoyer une demande REST - Entrante , mais les étapes de déclaration ne peuvent pas être séparées des étapes d’envoi de la demande REST - Entrante d’autres catégories de tests.

    Tableau 6. Entrées
    Champ Description
    Ordre d’exécution Nombre entier spécifiant l’ordre dans lequel le test exécute cette étape.

    Au fur et à mesure que vous créez des étapes, le système affecte automatiquement à chaque étape une valeur incrémentielle. Cette valeur permet au test d’exécuter les étapes dans l’ordre dans lequel vous les avez créées. Vous pouvez modifier cet ordre par défaut en modifiant les valeurs d’ordre d’exécution .
    Actif Option permettant d’activer cette étape de test en vue de son utilisation.
    Application Périmètre de l’application dans lequel le système exécute cette étape.
    Test Nom en lecture seule du test auquel vous ajoutez l’étape.
    Configuration de l'étape Nom en lecture seule de l’étape.
    Description Description de l’étape de test. Cette valeur de champ est automatiquement définie en fonction des valeurs de champ de l’étape de test. Ce champ apparaît une fois l’étape de test envoyée.
    Notes Notes sur l’étape de test.
    En-tête Nom de l’en-tête.
    Opération Comparaison à effectuer entre les valeurs :
    • Contient
    • ne contient pas
    • est
    • n’est pas
    • n’est pas vide
    Valeur Valeur de l’élément à utiliser dans le test. Non affiché si l’opération n’est pas vide.

    La charge utile JSON de la réponse à la déclaration est valide

    Vérifiez que la charge utile de la réponse est au format JSON valide.

    Les étapes de déclaration doivent immédiatement suivre une étape Envoyer une demande REST - Entrante . Vous pouvez avoir plusieurs étapes de déclaration REST à la suite d’une étape Envoyer une demande REST - Entrante , mais les étapes de déclaration ne peuvent pas être séparées des étapes d’envoi de la demande REST - Entrante d’autres catégories de tests.

    Tableau 7. Entrées
    Champ Description
    Ordre d’exécution Nombre entier spécifiant l’ordre dans lequel le test exécute cette étape.

    Au fur et à mesure que vous créez des étapes, le système affecte automatiquement à chaque étape une valeur incrémentielle. Cette valeur permet au test d’exécuter les étapes dans l’ordre dans lequel vous les avez créées. Vous pouvez modifier cet ordre par défaut en modifiant les valeurs d’ordre d’exécution .
    Actif Option permettant d’activer cette étape de test en vue de son utilisation.
    Application Périmètre de l’application dans lequel le système exécute cette étape.
    Test Nom en lecture seule du test auquel vous ajoutez l’étape.
    Configuration de l'étape Nom en lecture seule de l’étape.
    Description Description de l’étape de test. Cette valeur de champ est automatiquement définie en fonction des valeurs de champ de l’étape de test. Ce champ apparaît une fois l’étape de test envoyée.
    Notes Notes sur l’étape de test.

    La charge utile XML de la réponse à la déclaration est correcte

    Vérifiez que la charge utile de la réponse est un XML correct.

    Les étapes de déclaration doivent immédiatement suivre une étape Envoyer une demande REST - Entrante . Vous pouvez avoir plusieurs étapes de déclaration REST à la suite d’une étape Envoyer une demande REST - Entrante , mais les étapes de déclaration ne peuvent pas être séparées des étapes d’envoi de la demande REST - Entrante d’autres catégories de tests.

    Tableau 8. Entrées
    Champ Description
    Ordre d’exécution Nombre entier spécifiant l’ordre dans lequel le test exécute cette étape.

    Au fur et à mesure que vous créez des étapes, le système affecte automatiquement à chaque étape une valeur incrémentielle. Cette valeur permet au test d’exécuter les étapes dans l’ordre dans lequel vous les avez créées. Vous pouvez modifier cet ordre par défaut en modifiant les valeurs d’ordre d’exécution .
    Actif Option permettant d’activer cette étape de test en vue de son utilisation.
    Application Périmètre de l’application dans lequel le système exécute cette étape.
    Test Nom en lecture seule du test auquel vous ajoutez l’étape.
    Configuration de l'étape Nom en lecture seule de l’étape.
    Description Description de l’étape de test. Cette valeur de champ est automatiquement définie en fonction des valeurs de champ de l’étape de test. Ce champ apparaît une fois l’étape de test envoyée.
    Notes Notes sur l’étape de test.

    Élément de charge utile XML de déclaration

    Vérifiez que l’élément de charge utile de la réponse XML existe ou a la relation spécifiée avec la valeur spécifiée.

    Les étapes de déclaration doivent immédiatement suivre une étape Envoyer une demande REST - Entrante . Vous pouvez avoir plusieurs étapes de déclaration REST à la suite d’une étape Envoyer une demande REST - Entrante , mais les étapes de déclaration ne peuvent pas être séparées des étapes d’envoi de la demande REST - Entrante d’autres catégories de tests.

    Tableau 9. Entrées
    Champ Description
    Ordre d’exécution Nombre entier spécifiant l’ordre dans lequel le test exécute cette étape.

    Au fur et à mesure que vous créez des étapes, le système affecte automatiquement à chaque étape une valeur incrémentielle. Cette valeur permet au test d’exécuter les étapes dans l’ordre dans lequel vous les avez créées. Vous pouvez modifier cet ordre par défaut en modifiant les valeurs d’ordre d’exécution .
    Actif Option permettant d’activer cette étape de test en vue de son utilisation.
    Application Périmètre de l’application dans lequel le système exécute cette étape.
    Test Nom en lecture seule du test auquel vous ajoutez l’étape.
    Configuration de l'étape Nom en lecture seule de l’étape.
    Description Description de l’étape de test. Cette valeur de champ est automatiquement définie en fonction des valeurs de champ de l’étape de test. Ce champ apparaît une fois l’étape de test envoyée.
    Notes Notes sur l’étape de test.
    Chemin d'accès de l'élément Chemin XML vers l’élément à évaluer. Par exemple, /result/short_description pour
    {
  "result": {
    "number": "INC0020001",
    "short_description": "test"
  }
}
    Opération Comparaison à effectuer entre les valeurs :
    • Contient
    • ne contient pas
    • est
    • n’est pas
    • n’est pas vide
    Valeur Valeur de l’élément à utiliser dans le test. Non affiché si l’opération n’est pas vide.

    Élément de charge utile de la réponse JSON à la déclaration

    Vérifiez que l’élément de charge utile de la réponse JSON existe ou qu’il a la relation spécifiée avec la valeur spécifiée.

    Les étapes de déclaration doivent immédiatement suivre une étape Envoyer une demande REST - Entrante . Vous pouvez avoir plusieurs étapes de déclaration REST à la suite d’une étape Envoyer une demande REST - Entrante , mais les étapes de déclaration ne peuvent pas être séparées des étapes d’envoi de la demande REST - Entrante d’autres catégories de tests.

    Tableau 10. Entrées
    Champ Description
    Ordre d’exécution Nombre entier spécifiant l’ordre dans lequel le test exécute cette étape.

    Au fur et à mesure que vous créez des étapes, le système affecte automatiquement à chaque étape une valeur incrémentielle. Cette valeur permet au test d’exécuter les étapes dans l’ordre dans lequel vous les avez créées. Vous pouvez modifier cet ordre par défaut en modifiant les valeurs d’ordre d’exécution .
    Actif Option permettant d’activer cette étape de test en vue de son utilisation.
    Application Périmètre de l’application dans lequel le système exécute cette étape.
    Test Nom en lecture seule du test auquel vous ajoutez l’étape.
    Configuration de l'étape Nom en lecture seule de l’étape.
    Description Description de l’étape de test. Cette valeur de champ est automatiquement définie en fonction des valeurs de champ de l’étape de test. Ce champ apparaît une fois l’étape de test envoyée.
    Notes Notes sur l’étape de test.
    Chemin d'accès de l'élément Chemin d’accès SNC à l’élément à évaluer. Par exemple, /result/short_description pour
    {
  "result": {
    "number": "INC0020001",
    "short_description": "test"
  }
}
    Pour plus d’informations, reportez-vous à la section Importation de fichiers JSON .
    Opération Comparaison à effectuer entre les valeurs :
    • Contient
    • ne contient pas
    • est
    • n’est pas
    • n’est pas vide
    Valeur Valeur de l’élément à utiliser dans le test. Non affiché si l’opération n’est pas vide.

    Charge utile de la réponse à la déclaration

    Vérifiez que la charge utile de la réponse HTTP a la relation spécifiée avec la valeur spécifiée. Spécifiez la valeur et la relation.

    Les étapes de déclaration doivent immédiatement suivre une étape Envoyer une demande REST - Entrante . Vous pouvez avoir plusieurs étapes de déclaration REST à la suite d’une étape Envoyer une demande REST - Entrante , mais les étapes de déclaration ne peuvent pas être séparées des étapes d’envoi de la demande REST - Entrante d’autres catégories de tests.

    Remarque :
    L’ensemble de la charge utile est utilisée pour rechercher une correspondance. Une charge utile importante peut affecter les performances.
    Tableau 11. Entrées
    Champ Description
    Ordre d’exécution Nombre entier spécifiant l’ordre dans lequel le test exécute cette étape.

    Au fur et à mesure que vous créez des étapes, le système affecte automatiquement à chaque étape une valeur incrémentielle. Cette valeur permet au test d’exécuter les étapes dans l’ordre dans lequel vous les avez créées. Vous pouvez modifier cet ordre par défaut en modifiant les valeurs d’ordre d’exécution .
    Actif Option permettant d’activer cette étape de test en vue de son utilisation.
    Application Périmètre de l’application dans lequel le système exécute cette étape.
    Test Nom en lecture seule du test auquel vous ajoutez l’étape.
    Configuration de l'étape Nom en lecture seule de l’étape.
    Description Description de l’étape de test. Cette valeur de champ est automatiquement définie en fonction des valeurs de champ de l’étape de test. Ce champ apparaît une fois l’étape de test envoyée.
    Notes Notes sur l’étape de test.
    Opération Comparaison à effectuer entre les valeurs :
    • Contient
    • ne contient pas
    • est
    • n’est pas
    • n’est pas vide
    Corps de réponse Valeur du corps de réponse à utiliser dans le test.

    Doit contenir le nom et la valeur à comparer tels qu’ils apparaissent dans la charge utile de la réponse. Ne doit pas contenir d’accolades.

    Non affiché si l’opération n’est pas vide.
    Pour vérifier la description brève dans la charge utile de la réponse
    {"result":{"number":"INC0010040","short_description":"Test ATF Incident"}}
    le corps de la réponse doit contenir :
    "short_description":"Test ATF Incident"
    Ces formats sont incorrects et l’étape échoue.
    • {"short_description » :"Tester l’incident ATF"}
    • « {"short_description » :"Tester l’incident ATF"} »
    • short_description : tester l’incident ATF
    • short_description : « Tester l’incident ATF »