Utilisation de l'interface CLI du kit d'outils pour exécuter des tests d'API

IBM® API Connect toolkit de développement fournit des commandes d'interface de ligne de commande pour les tests de comportement d'API automatisés.

A propos de cette tâche

Utilisez les commandes de l'interface de ligne de commande pour exécuter des tests d'API.
Remarque: pour exécuter une API à des fins de test, vous devez la rendre en ligne. Pour mettre l'API en ligne et publier automatiquement votre document d'API, réglez la bascule de publication automatique dans la page Préférences sur la position Activé. Pour plus d'informations, consultez la section « Activation d'une API ».

Procédure

  1. Installer la boîte à outils : Mise en place de la boîte à outils API Connect.
  2. Ouvrez Terminal.
  3. Créez un fichier YAML pour définir vos tests. Pour plus d'informations, consultez les commandes de développement et de gestion des API.
  4. Exécutez l'interface de ligne de commande avec la syntaxe suivante pour exécuter les tests:
    apic test yaml-files
    
    yaml-files indique l'emplacement du fichier YAML. Exemple : apic test test1.yaml
    • Pour exécuter des tests avec des vérifications de certificat désactivées, exécutez l'interface de ligne de commande à l'aide de l'indicateur --insecureSkipVerify . Pour cela, utilisez la syntaxe suivante:
      apic test yaml-files
       --insecureSkipVerify
      
      yaml-files est l'emplacement du fichier YAML. Par exemple, apic test test1.yaml.
    • Si le certificat de l'autorité de certification n'est pas disponible dans le magasin de clés du système, son emplacement peut être spécifié avec l'indicateur --certPath . Pour cela, exécutez l'interface de ligne de commande avec la syntaxe suivante:
      apic test yaml-files
       --certPath=location of certs folder
      
      yaml-files est l'emplacement du fichier YAML. Par exemple, apic test test1.yaml. location of certs folder indique l'emplacement du certificat de l'autorité de certification.
    • Pour exécuter des tests avec mTLS activé, exécutez l'interface de ligne de commande à l'aide de l'indicateur --mtls . Pour cela, utilisez la syntaxe suivante:
      api-test test yaml-files
       --mTLS --certPath=location of certs folder
      
      yaml-files est l'emplacement du fichier YAML. Par exemple, apic test test1.yaml.
    • Pour transmettre la configuration externe, exécutez l'interface de ligne de commande à l'aide de l'indicateur --config-file . Pour cela, utilisez la syntaxe suivante:
      api-test test yaml-files
        --config-file=location of config file
      
      yaml-files est l'emplacement du fichier YAML. Par exemple, apic test test1.yaml. location of config file indique l'emplacement du fichier de configuration.
    Remarque: les fichiers de certificat doivent être nommés au format suivant:
    • tls.crt -clé publique
    • tls.key-clé privée
    • ca.crt-Certificat de l'autorité de certification
    Pour plus d'informations sur la manière dont le test est défini dans un fichier YAML, consultez la section « Syntaxe de définition des tests ».

    Pour plus d'informations sur l'affectation de variables dans un fichier de configuration YAML, consultez la section « Affectation de variables dans la configuration YAML ».