Test d'une API à l'aide de l'onglet Explorateur

Utilisez l'onglet Explorateur de l'éditeur d'API pour voir à quoi ressemblent vos API pour un consommateur dans le portail de développeur. Vous pouvez également utiliser l'outil Try it pour tester le comportement de l'API.

Avant de commencer

Pour tester une API dans l'outil de test Try it , l'API doit être publiée automatiquement. Si l'API n'est pas publiée automatiquement, l'outil Try it n'est pas activé dans l' Explorer.

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.

A propos de cette tâche

L'onglet Explorateur de l'éditeur d'API de l'interface utilisateur d' API Designer et de l'interface utilisateur d' API Manager vous permet de visualiser l'aspect de vos API pour un consommateur d'API dans le portail de développeur. Vous pouvez vérifier les descriptions des différents artefacts, ainsi que les schémas ou les exemples, et vous pouvez également tester le comportement de l'API à l'aide de l'outil Try it .

Remarque :
  • Vous ne pouvez pas utiliser l'outil Try it pour tester des API non appliquées.

Procédure

Pour tester une API à l'aide de l'outil Try it , 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.
    L'éditeur d'API s'affiche.
  4. Cliquez sur l'onglet Explorateur .
    Une présentation de l'API s'affiche.
  5. Cliquez sur les artefacts d'API dans la barre de menus latérale pour explorer les opérations et les définitions disponibles dans l'API, y compris les exemples et les schémas.
  6. Pour tester le comportement de l'API, cliquez sur une opération dans la barre de menus latérale, puis cliquez sur l'onglet Try it .
    Le panneau de test de l'opération s'affiche, comme illustré dans l'exemple suivant:
    Panneau Try it test de l'onglet Explorer.
  7. Indiquez les paramètres d'API requis et cliquez sur Envoyer.
    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 Envoyer .

Etape suivante

Lorsque vous êtes satisfait de l'apparence et du comportement de votre API, vous pouvez la mettre en préproduction dans un produit d'un catalogue. Pour plus d'informations, voir Transfert d'une API.