Traitement des erreurs dans l'assemblage

Modifier en ligne

Utilisez la section catch de l'assemblage pour décrire le traitement des erreurs générées lors de l'exécution de l'assemblage.

A propos de cette tâche

Remarque :
  • Cette tâche concerne la configuration d'une définition d'API OpenAPI 3.0. Pour plus de détails sur la configuration d'une définition d'API OpenAPI 2.0 , voir Edition d'une définition d'API OpenAPI 2.0.
  • Les API OpenAPI 3.0 sont prises en charge uniquement avec le DataPower® API Gatewayet non avec le DataPower Gateway (v5 compatible).
  • Pour plus de détails sur les limitations actuelles de la prise en charge d' OpenAPI 3.0 , voir Prise en charge d'OpenAPI 3.0 dans IBM® 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.

La section catch de l'assemblage est utilisée pour implémenter un assemblage au cas où une erreur est générée lors de l'exécution de l'assemblage. Par exemple, l'assembly pourrait contenir un throw élément, l'appelant de l'API pourrait ne pas réussir à s'authentifier, ou une politique pourrait ne pas s'exécuter correctement. Chaque erreur peut être gérée avec une accroche différente et chaque accroche peut gérer plusieurs erreurs de statut.

Procédure

Pour créer une accroche et y inclure des éléments, procédez comme suit :
  1. Dans le volet de navigation, cliquez Icône de développement dans le panneau de navigation sur « Développement », puis sélectionnez l'onglet « API ».
    La page Développement s'ouvre.
  2. Cliquez sur le titre de la définition d'API à laquelle vous souhaitez appliquer une accroche.
  3. Sélectionnez l'onglet Passerelle , puis cliquez sur Stratégies dans le panneau de navigation.
  4. Définissez l'option Afficher les accroches dans la barre de menus du canevas sur la position Afficher .
  5. Cliquez sur « Catches » dans la zone de travail, ou sur l'icône « Catch L'icône attrape » si celle-ci s'affiche.
    La feuille de propriétés des accroches de l'API s'ouvre.
  6. Pour ajouter une interception par défaut qui est exécutée lorsqu'une erreur autrement non interceptée est générée, cliquez sur Ajouter une interception par défaut.
    Remarque: Si vous disposez d'une interception par défaut avant une autre interception en priorité, l'interception par défaut s'active même lorsque l'erreur de l'autre interception est générée.
  7. Pour ajouter une nouvelle accroche, cliquez sur Ajouter une accroche.
  8. Pour préciser à quelles erreurs s'applique la gestion d'exception, utilisez le champ « Sélectionner les erreurs » pour choisir l'erreur appropriée.
  9. Facultatif : pour supprimer un cas d'erreur d'un bloc catch, décochez la case correspondante dans la liste déroulante « Sélectionner les erreurs ». Pour effacer tous les cas d'erreur d'un bloc catch, cliquez sur la croix correspondant au nombre total de cas d'erreur dans le champ « Sélectionner les erreurs ».
  10. Facultatif : pour modifier l'ordre de vos captures, utilisez les icônes « L'icône Déplacer vers le bas Monter » Icône Déplacer vers le haut ou « Descendre ».
    Si un cas d'erreur est traité par plusieurs accroches, l'accroche au début de la liste est appliquée.
  11. Pour ajouter un élément à un composant à partir de la palette, cliquez sur l'icône « + Signe « + » à l'intérieur d'un cercle » à l'emplacement approprié dans le flux d'assemblage. Sélectionnez l'élément que vous souhaitez appliquer au « catch » en cliquant dessus.
  12. Cliquez sur Sauvegarder pour sauvegarder vos modifications.

Etape suivante

Si vous avez ajouté une instruction catch pour les exceptions ConnectionError, SOAPError ou OperationError, vous devez ajouter ces mêmes exceptions au paramètre « Stop on error » de la Invoke politique de votre assembly. Sinon, si l'erreur survient pendant l'exécution de la Invoke politique, elle n'est pas détectée, l'exécution de la politique se poursuit jusqu'à son terme et le flux d'assemblage continue. Pour plus d'informations sur la configuration d'une Invoke politique, consultez Invoke.

Pour plus de détails sur toutes les erreurs pouvant être renvoyées par l'assembly et prises en charge par la fonction `catch`, consultez la section « Cas d'erreur pris en charge par les blocs `catch` de l'assembly ».