Test d'une API à l'aide de l'éditeur de règles

IBM® API Connect fournit un environnement de test de base dans l'éditeur Règles afin que vous puissiez vous assurer que vos API sont définies et implémentées correctement.

A propos de cette tâche

Vous pouvez effectuer cette tâche soit à l'aide de l'application d'interface utilisateur API Designer , soit à l'aide de l'interface utilisateur API Manager basée sur un navigateur.

Remarque :
  • Si vous testez une API OpenAPI 2.0 , vous pouvez utiliser l'outil de test de l'éditeur Règles décrit ici ou l'onglet Test . Si vous testez une API OpenAPI 3.0 , seul l'onglet Test est disponible ; voir Utilisation de l'onglet Test pour déboguer votre API.
  • Si vous testez une API qui contient des références à des propriétés d'API, seules les références définies dans l'assemblage d'API sont résolues et remplacées par les valeurs correspondantes lorsque vous appelez l'API dans l'outil de test d'assemblage ; les références de propriété qui sont définies en dehors de l'assemblage d'API ne sont pas résolues. Pour plus d'informations sur les propriétés d'API, voir Définition des propriétés d'API (OpenAPI 2.0) ou Définition des propriétés d'API (OpenAPI 3.0).
  • En raison des restrictions de partage de ressources d'origine croisée (CORS), l'outil de test d'assemblage n'est pas compatible avec Chrome ou Safari sur la plateforme macOS Catalina.

Procédure

Pour tester une API, procédez comme suit :

  1. Si vous utilisez API Designer, définissez le mode sur En ligne à l'aide du menu Options Menu Options de la page principale.
  2. Dans le panneau de navigation, cliquez sur Icône de développement dans le panneau de navigation de l'interface utilisateur d'API Développement, puis sélectionnez l'onglet API.
  3. Cliquez sur le titre de l'API à utiliser.
  4. Cliquez sur l'onglet Passerelle , puis, dans le panneau de navigation, cliquez sur Stratégies.
  5. Si vous testez l'API pour la première fois et que, lorsque vous avez créé la définition d'API, vous avez sélectionné l'option Activer l'API , votre configuration de test est déjà configurée et vous pouvez passer immédiatement à l'étape suivante pour tester votre API. Sinon, cliquez sur Hors ligne pour faire passer l'API à l'état En ligne . Si vous retestez votre API après avoir apporté des modifications, l'API modifiée aura été republiée automatiquement lors de l'enregistrement.
  6. Cliquez sur l'icône Tester Icône Test (flèche droite).
    Remarque :
    • L'icône Test est active uniquement si vous avez basculé votre API à l'état En ligne , comme décrit à l'étape 5.
    • Les détails du catalogue, du produit, du plan et de l'application affichés dans le panneau Configuration reflètent vos préférences de test d'API configurées ; voir Spécification des préférences de test pour une API.
  7. Dans la section Opération , sélectionnez l'opération d'API à tester, puis cliquez sur Appeler.
    La réponse API est affichée à la section Réponse.
    Remarque: Si vous recevez un message relatif à un certificat non digne de confiance, cliquez sur le lien fourni, acceptez le certificat, puis revenez à l'environnement de test et cliquez à nouveau sur Appeler . Le message mentionne également l'absence de prise en charge CORS sur le serveur, mais il ne s'agit que d'une cause possible de l'échec de la connexion.