Préparation du débogage d'une API à l'aide de l'onglet Test

Modifier en ligne

Vérifiez que la définition de l'API répond aux exigences de débogage dans l'onglet Test de API Connect .

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.

Pour appeler votre API dans l'onglet « Test », les conditions suivantes doivent être remplies :

La passerelle d'API DataPower est configurée pour prendre en charge la sonde d'API
Pour activer la fonction de trace de l'onglet Test, la passerelle d'API DataPower doit être configurée pour prendre en charge l'appairage de la passerelle et la sonde de la passerelle. Dans un service passerelle s'exécutant dans Kubernetes, la sonde d'API est automatiquement activée. Dans un service passerelle s'exécutant en dehors d' Kubernetes, la configuration DataPower doit être ajoutée au domaine d'application qui prend en charge API Connect. Vérifiez auprès de votre administrateur que le peering de passerelle et la sonde de passerelle sont activés, comme expliqué dans la section « Configuration de l' DataPower » à l'adresse API Gateway.
CORS est activé dans la définition de l'API
La prise en charge du partage de ressources d'origine croisée (CORS) garantit que l'API est accessible depuis un autre domaine. La prise en charge CORS doit être activée pour que votre API soit correctement appelée et suivie. Si votre API utilise la passerelle d'API mais que vous ne pouvez pas ouvrir l'onglet Test, il est possible que CORS n'ait pas été activé dans la définition d'API.

Vous pouvez activer la fonctionnalité « CORS » pour votre API en suivant les étapes suivantes :

  1. Connectez-vous à API Manager.
  2. Dans la liste de navigation, cliquez Icône de développement sur « Développement ».
  3. Sur la page Développement, cliquez sur le nom de l'API que vous voulez tester. La page « Conception » de l'API s'affiche.
  4. Dans l'onglet « Gateway », repérez le champ « CORS » et sélectionnez-le pour activer la prise en charge.
  5. Cliquez sur Sauvegarder dans l'en-tête de la page.
L'API est publiée dans le catalogue du bac à sable avec le produit ou la formule par défaut, ou dans un catalogue et avec un produit ou une formule spécifiques
Par défaut, lorsque vous testez une API à l'aide de l'onglet Test, un produit / plan par défaut est généré pour l'API et publié dans le catalogue pour bac à sable intégré. Vous pouvez toutefois, si vous le souhaitez, définir une série de préférences de test pour l'API, notamment un autre produit ou forfait, ainsi que le catalogue cible; pour plus d'informations, consultez la section « Définition des préférences de test pour une API ». Lorsque vous publiez (activez) une API, celle-ci est activée en ligne et devient disponible. Vous ne pouvez pas exécuter une API hors ligne, même à des fins de test. Pour définir une API en ligne, procédez comme suit :
  1. Connectez-vous à API Manager.
  2. Dans la liste de navigation, cliquez Icône de développement sur « Développement ».
  3. Sur la page Développement, cliquez sur le nom de l'API que vous voulez tester.
  4. Dans l'en-tête de la page « Design », cliquez sur l'icône des paramètres Icône des paramètres dans l'en-tête de la page de conception. La page « Préférences » s'affiche.
  5. Placez le bouton de publication automatique en position « Activé ».