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

Modifier en ligne

IBM® API ConnectAI Gateway 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 soit utiliser l'outil de test de l'éditeur de politiques décrit ici, soit utiliser l'onglet Test. Si vous testez une API OpenAPI 3.0, seul l'onglet « Test » est disponible; consultez la section « Utilisation de l'onglet Test pour déboguer votre API ».
  • Si vous testez une API contenant des références à des propriétés d'API, seules les références définies au sein de l'assembly de l'API sont résolues et remplacées par leurs valeurs correspondantes lorsque vous appelez l'API dans l'outil de test d'assembly. Les références de propriété définies en dehors de l'assembly de l'API ne sont pas résolues pendant le test. Pour plus d'informations sur les propriétés de l'API, consultez la section « Configuration des propriétés de l'API » ( OpenAPI2.0 ) ou « Configuration des propriétés de l'API » ( OpenAPI3.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, réglez le mode sur « En ligne » via le menu Options Menu Options de la page d'accueil.
  2. Dans le volet de navigation, cliquez Icône de développement dans le panneau de navigation de l'interface utilisateur d'API sur « 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 testez à nouveau votre API après l'avoir modifiée, les API modifiées sont republiées automatiquement lors de l'enregistrement.
  6. Cliquez sur l'icône « Test 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 informations relatives au catalogue, au produit, au plan et à l'application qui s'affichent dans le volet « Configuration » reflètent les préférences de test d'API que vous avez définies; voir la section « Définition 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 associé à un certificat non fiable, procédez comme suit :
    1. Cliquez sur le lien fourni.
    2. Acceptez le certificat.
    3. Revenir à l'environnement de test.
    4. Cliquez à nouveau sur « Invoke ».
    Le message mentionne également l'absence de prise en charge d' CORS s sur le serveur, ce qui constitue l'une des causes possibles de l'échec de la connexion.