API Connect Testeur

L'outil API Connect Tester teste les API et génère des cas de test, des suites de tests, etc.

L'outil effectue des opérations qui sont prises en charge par l'outil API Test and Monitor (ATM). Il teste les API pour s'assurer qu'elles fonctionnent comme prévu. Il s'agit de vérifier que les points de terminaison de l'API affichent les réponses correctes pour différentes entrées et différents scénarios, en créant des assertions de test.

Détails de l'outil
  • Le test de l'API est accessible sous l'onglet Tests de l'API dans le gestionnaire de l'API.
  • Cet outil utilise la fonction Smart Generation pour générer des cas de test.
Les opérations suivantes sont prises en charge par l'outil API Connect Tester :

Générer des cas de test

L'opération Generate test case crée une suite de tests à partir de l'API fournie ou du fichier de spécification OpenAPI. L'API peut être un projet ou être publié dans un catalogue spécifique. Chaque cas de test de la suite correspond à un point final différent. S'il existe une suite de tests pour l'API donnée ou le fichier de spécification OpenAPI, elle est supprimée et une nouvelle suite est créée. Vous pouvez contrôler le nombre de cas de test qui sont listés en utilisant les paramètres limit et offset.

Cette opération permet d'afficher une liste de cas de test sous forme de liens, qui vous dirigent vers les cas de test correspondants dans le gestionnaire d'API.
Remarque :
  • Si le nom du catalogue n'est pas spécifié, la suite de tests est créée pour un projet d'API portant le nom donné (s'il est disponible). Pour générer des scénarios de test pour une API publiée, indiquez le nom du catalogue.
  • Si la spécification OpenAPI d'une API est mise à jour après la création d'une suite de tests, la suite de tests existante doit être supprimée. Une nouvelle suite de tests doit être créée sur la base de la spécification API mise à jour.
Tableau 1. Paramètres
Paramètre Descriptif Valeur par défaut Obligatoire
api_name Le nom de l'API pour laquelle des cas de test doivent être créés. Aucun Facultatif
api_file Le nom de la spécification de l'API ouverte pour laquelle le cas de test doit être exécuté. Aucun Facultatif
catalog Le nom du catalogue dans lequel l'utilisateur a publié l'API. Aucun Facultatif
version La version spécifique de l'API qui a été publiée ou la version spécifiée dans l'API. Aucun Facultatif
limit Nombre maximum de cas de test, qui se trouve dans la réponse. Prend une valeur entière. 15 Facultatif
Offset Passez ce nombre de cas de test et récupérez les cas de test restants. Prend une valeur entière. 0 Facultatif
Exemples d'invites
  • Generate test case for Swagger-Petstore api
  • Generate test case for Swagger-Petstore api in sandbox
  • Generate test for Swagger-Petstore:1.0.0 api
  • Generate test for Swagger-Petstore api with version 1.0.0 in sandbox
  • Generate test case for Swagger-Petstore api with limit 5 offset 15
  • Generate test case for @bookshop.yaml
Prochaine action proposée
Run test case for the test suite {testsuite_name}

Exécuter les cas de test

Le scénario d'exécution exécute les scénarios de test de la suite de tests donnée ou créée pour une API. Pendant l'exécution, des appels à l'API sont effectués et les assertions sont validées. L'API peut être un projet ou être publié dans un catalogue spécifique. Vous pouvez contrôler le nombre de cas de test qui sont listés en utilisant les paramètres limit et offset. Cette opération ne peut être effectuée qu'après l'opération Générer un scénario de test.

Au cours de cette opération, chaque scénario de test est vérifié pour un serveur valide URL pour effectuer des appels API. Si le serveur URL est manquant, comme dans les API provisoires, le scénario de test ne s'exécutera pas. L'utilisateur est invité à mettre à jour le serveur URL dans l'éditeur grâce à un lien cliquable vers le cas de test. Si le cas de test a un serveur valide URL, un lien vous dirige vers l'onglet Rapport des cas de test dans le gestionnaire d'API, où vous pouvez examiner les résultats du test.
Tableau 2. Paramètres
Paramètre Descriptif Valeur par défaut
api_name Nom de l'API pour laquelle les cas de test doivent être exécutés. Aucun
api_file Le nom de la spécification de l'API ouverte pour laquelle le cas de test doit être exécuté. Aucun
test_name Nom du cas de test qui doit être exécuté. Aucun
testsuite_name Nom de la suite de tests pour laquelle les cas de test doivent être exécutés. Aucun
catalog Le nom du catalogue que l'utilisateur a publié sur l'API. Aucun
version La version spécifique de l'API qui a été publiée ou la version spécifiée dans l'API. Aucun
limit Nombre maximum de cas de test, qui est indiqué dans la réponse. Prend une valeur entière. 15
Offset Passez ce nombre de cas de test et récupérez les cas de test restants. Prend une valeur entière. 0
Exemples d'invites
  • run test for AA_TEST_SUITE_Swagger_Petstore_1.0.0
  • run test for Swagger-Petstore api
  • run test for Swagger-Petstore api in sandbox
  • run test for Swagger-Petstore:1.0.0 api
  • run test for Swagger-Petstore api with version 1.0.0 in sandbox
  • run test for AA_TEST_CASE_get/200 in AA_TEST_SUITE_Swagger_Petstore_1.0.0
  • run test for AA_TEST_CASE_get/200 in AA_TEST_SUITE_Swagger-Petstore-1.0.0 test suite
  • run test for Swagger-Petstore api with limit 5 offset 15
Prochaine action proposée
Get test status for the {api_name} api
Get test status for the test suite {testsuite_name}

API de test

L'opération Test API génère des cas de test et les exécute pour l'API donnée ou le fichier de spécification OpenAPI. L'API peut être un projet ou être publiée dans un catalogue spécifique. Vous pouvez contrôler le nombre de cas de test qui sont listés en utilisant les paramètres limit et offset.

L'opération présente ces cas de test sous forme de liens cliquables, qui vous dirigent vers l'onglet Rapport des cas de test dans le gestionnaire de l'API, où vous pouvez examiner les résultats du test.

Tableau 3. Paramètres
Paramètre Descriptif Valeur par défaut
api_name Nom de l'API pour laquelle des cas de test doivent être créés et exécutés. Aucun
api_file Nom de la spécification de l'api ouverte pour laquelle le cas de test doit être créé et exécuté. Aucun
catalog Le nom du catalogue dans lequel l'utilisateur a publié l'API. Aucun
version La version spécifique de l'API qui a été publiée ou la version spécifiée dans l'API. Aucun
limit Nombre maximum de cas de test qui seront affichés dans la réponse. Prend une valeur entière. 15
offset Passez ce nombre de cas de test et récupérez les cas de test restants. Prend une valeur entière. 0
Exemples d'invites
  • test api Swagger-Petstore api
  • test api Swagger-Petstore api in sandbox
  • test api Swagger-Petstore:1.0.0 api
  • test api Swagger-Petstore api with version 1.0.0 in sandbox
  • test api for Swagger-Petstore api with limit 5 offset 15
  • test api for @bookshop.yaml
Prochaine action proposée
Get test status for the {api_name} api
 Get test status for the test suite {testsuite_name}

Liste des suites de tests

L'opération list test suite permet d'obtenir une liste de toutes les suites de tests présentes dans l'organisation du fournisseur.

Exemple d'invite :
list test suites

Liste des cas de test

L'opération list test cases permet d'afficher la liste des cas de test présents pour la suite de tests ou l'API donnée. L'API peut être un projet ou être publié dans un catalogue spécifique. Vous pouvez contrôler le nombre de cas de test qui sont listés en utilisant les paramètres limit et offset.
Tableau 4. Paramètres
Paramètre Descriptif Valeur par défaut
api_name Nom de l'API pour lister les cas de test générés sous cette API. Aucun
catalog Le nom du catalogue dans lequel l'utilisateur a publié l'API. Aucun
testsuite_ name Nom de la suite de tests pour lister les cas de test qu'elle contient. Aucun
limit Nombre maximum de cas de test qui seront affichés dans la réponse. Prend une valeur entière. 15
offset Passez ce nombre de cas de test et récupérez les cas de test restants. Prend une valeur entière. 0
Exemples d'invites
  • list test cases in AA_TEST_SUITE_Swagger_Petstore_1.0.0
  • list test cases in Swagger-Petstore api
  • list test cases in Swagger-Petstore api in sandbox
  • list test cases in Swagger-Petstore api with limit 5 offset 15

Supprimer une suite de tests

L'opération delete test suite supprime une suite de tests, ainsi que tous les cas de test créés dans cette suite de tests.
Tableau 5. Paramètres
Paramètre Descriptif Obligatoire
testsuite_name Nom de la suite de tests à supprimer. Oui
Exemple de demande
delete test AA_TEST_CASE_get/200 in AA_TEST_SUITE_Swagger_Petstore_1.0.0

Supprimer un cas de test

L'opération delete test case permet de supprimer un cas de test spécifique au sein d'une suite de tests.
Tableau 6. Paramètres
Paramètre Descriptif Obligatoire
test_name Nom du cas de test à supprimer. Oui
testsuite_name Le nom de la suite de tests dans laquelle se trouve le cas de test à supprimer. Oui
Exemple de demande
delete test AA_TEST_CASE_get/200 in AA_TEST_SUITE_Swagger_Petstore_1.0.0

Publier les cas de test

Après avoir configuré et vérifié votre test, vous pouvez le publier. Cette opération publie un cas de test spécifique dans une suite de tests si un nom est fourni, ou tous les cas de test de la suite si aucun nom de suite de tests n'est spécifié.
Tableau 7. Paramètres
Paramètre Descriptif Valeur par défaut Obligatoire
test_name Nom du cas de test qui doit être publié. Aucun Oui
testsuite_name Le nom de la suite de tests dans laquelle est présenté le cas de test qui doit être publié. Aucun Oui
Exemples d'invites
  • publish test in test suite AA_TEST_SUITE_Swagger_Petstore_1.0.0
  • publish test AA_TEST_CASE_get/200 in test suite AA_TEST_SUITE_Swagger_Petstore_1.0.0

Obtenir le statut des cas de test

L'opération Get status fournit l'état d'exécution des cas de test pour l'API ou la suite de tests spécifiée, qu'il s'agisse d'un projet ou d'une publication dans un catalogue spécifique. Le nombre de cas de test peut être contrôlé à l'aide des paramètres de limite et de décalage.

Cette opération fournit un résumé consolidé de l'état des tests et de l'état des cas individuels. Pour chaque cas de test exécuté, il affiche le nombre d'assertions réussies et échouées, ainsi qu'un lien vers l'onglet Rapport des cas de test dans le gestionnaire d'API. Si un scénario de test n'a pas été exécuté, son statut est affiché sur Not run yet pour le scénario de test en question.
Tableau 8. Paramètres
Paramètre Descriptif Valeur par défaut
api_name Le nom de l'API pour laquelle le statut des cas de test doit être récupéré. Aucun
test_name Nom du cas de test pour lequel l'état doit être recherché. Aucun
catalog Le nom du catalogue dans lequel l'utilisateur a publié l'API. Aucun
testsuite_ name Nom de la suite de tests pour laquelle le statut doit être récupéré. Aucun
limit Le nombre maximum de cas de test qui seront affichés dans la réponse. Prend une valeur entière. 15
offset Passez ce nombre de cas de test et récupérez les cas de test restants. Prend une valeur entière. 0
version La version spécifique de l'API qui a été publiée ou la version spécifiée dans l'API. Aucun
Exemples d'invites
  • get test status for Swagger-Petstore api
  • get test status for Swagger-Petstore api in sandbox
  • get test status for Swagger-Petstore:1.0.0 api
  • get test status for Swagger-Petstore api with version 1.0.0 in sandbox
  • get test status for test suite AA_TEST_SUITE_Swagger-Petstore-1.0.0
  • get test status for AA_TEST_CASE_get/200 in test suite AA_TEST_SUITE_Swagger-Petstore-1.0.0

Créer un webhook

L'opération create webhook permet de créer un webhook pour une suite de tests spécifique, ce qui permet de créer plusieurs webhooks par suite. Vous pouvez créer des webhooks en fournissant un nom, une description et le nom de la suite de tests. L'opération montre le site URL du webhook créé, ainsi que des indications sur la manière de générer la clé et le secret nécessaires pour accéder au webhook.
Accès au crochet

Pour utiliser le crochet API, vous devez générer une clé API et un secret.

Pour générer une clé et un secret API, procédez comme suit :
  1. Allez dans la suite de tests > Paramètres.
  2. Sélectionnez les crochets et les clés de l'API.
  3. Dans la section Clés, cliquez sur Ajouter.
Tableau 9. Paramètres
Paramètre Descriptif Valeur par défaut Obligatoire
testsuite_name Nom de la suite de tests pour laquelle le crochet doit être créé. Aucun Oui
name Le crochet doit être créé avec ce nom. Aucun Oui
des_hooks Description du crochet. "" Oui
Exemples d'invites
  • create hook with name test-hook for test suite AA_TEST_SUITE_Swagger-Petstore-1.0.0
  • create hook with name test-hook with description 'For testing purpose' for the test suite AA_TEST_SUITE_Swagger-Petstore-1.0.0

Liste des webhooks

Cette opération permet de dresser la liste de tous les webhooks créés pour une suite de tests donnée.
Tableau 10. Paramètres
Paramètre Descriptif Obligatoire
testsuite_name Le nom de la suite de tests pour laquelle le crochet doit être listé. Oui
Exemple de demande
list hooks for test suite AA_TEST_SUITE_Swagger_Petstore_1.0.0

Supprimer des webhooks

Cette opération supprime un webhook spécifique avec le nom donné de la suite de tests spécifiée.
Tableau 11. Paramètres
Paramètre Descriptif Obligatoire
name Nom du crochet qui doit être supprimé. Oui
testsuite_name Le nom de la suite de tests dans laquelle se trouve le crochet à supprimer. Oui
Exemple de demande
delete hook test-hook in test suite AA_TEST_SUITE_Swagger-Petstore-1.0.0