L'éditeur d'assemblage

Le concepteur d'API de IBM® API Connect comporte un éditeur graphique que vous pouvez utiliser pour créer des assemblages. Ces assemblages vous permettent de personnaliser facilement vos API en y incluant des éléments tels que la consignation d'activités et l'occultation de zones spécifiques.

Remarque: Cette tâche concerne la configuration d'une définition d'API OpenAPI 2.0 . Pour plus d'informations sur la configuration d'une définition d'API OpenAPI 3.0 , voir Edition d'une définition d'API OpenAPI 3.0.

Vous pouvez accéder à la vue Assembler en cliquant sur l'onglet Passerelle dans l'éditeur d'API, puis en cliquant sur Stratégies. Cet onglet inclut les options suivantes:

Palette-répertorie les éléments disponibles dans le flux d'assemblage.
Canevas-utilisé pour organiser et visualiser les éléments dans l'assemblage.
Feuille de propriétés-utilisée pour configurer les éléments dans l'assemblage.

La palette

La palette est une liste des différents éléments que vous pouvez inclure dans l'assemblage. Pour afficher la palette, cliquez sur l'icône plus dans le canevas. Vous pouvez utiliser l'icône Rotation pour faire pivoter la palette comme vous le souhaitez. Pour agrandir et réduire la vue de la palette, cliquez sur les icônes Agrandir et Réduire .

Vous pouvez libérer la palette en cliquant sur l'icône Fermer Une croix sur l'en-tête de la palette .

La grille

La grille permet de créer une représentation graphique du flux d'assemblage. Pour ajouter un élément au flux d'assemblage à partir de la palette, cliquez sur l'icône plus à l'emplacement approprié sur le canevas et sélectionnez l'élément requis dans la liste disponible. Pour supprimer un élément du canevas, survolez-le et cliquez sur l'icône Supprimer Icône représentant une corbeille qui apparaît lorsque vous survolez un élément dans la grille .

Remarque: Vous devez cliquer sur Sauvegarder dans la vue Assembler pour sauvegarder vos mises à jour d'assemblage et les faire apparaître dans la vue Source .

Les appels API sont effectués dans le cercle initial non rempli et sont renvoyés dans le cercle final rempli. Vous pouvez insérer des éléments entre les deux cercles pour modifier les données reçues à partir de l'appel ou renvoyées par la réponse.

Vous pouvez utiliser le bouton à bascule Afficher les accroches pour afficher ou masquer les accroches d'erreur dans la palette. Une accroche est une section de l'assemblage qui est appliquée lorsqu'un appel API renvoie le code de statut HTTP correspondant. Cliquez sur la section accroche pour ouvrir la feuille de propriétés de toutes les accroches.

Vous pouvez effectuer un zoom avant ou arrière sur la vue de votre canevas en cliquant sur les icônes + et - . Pour adapter le canevas à la taille d'écran, cliquez sur l'icône Ajuster à l'écran Un carré contenant des crochets diagonaux .

La feuille de propriétés

Lorsque vous sélectionnez un élément dans l'assemblage en cliquant dessus, les détails de l'élément s'affichent dans la feuille de propriétés. Cette sous-fenêtre vous permet de configurer les propriétés de l'élément. Les options disponibles dans la feuille de propriétés sont spécifiques au type d'élément que vous utilisez. Pour certains éléments, vous pouvez ajouter et supprimer des propriétés en cliquant sur Propriétés de l'objet et en sélectionnant la propriété dans le menu déroulant.

Vous pouvez libérer la feuille de propriétés en cliquant sur l'icône Fermer Une croix sur l'en-tête de la palette .

Comportement d'un assemblage

L'assemblage exécute les stratégies dans l'ordre et agit sur des contextes différents de l'appel API. Lorsqu'une API est appelée, les limites de sécurité et de débit sont appliquées avant que l'assemblage ne soit exécuté. Lors de l'assemblage, le flux peut être ramifié, lancé et intercepté en fonction des stratégies disponibles. Le contexte de message passe par l'assemblage, qui est utilisé et modifié par diverses stratégies. En plus du message, d'autres contextes sont accessibles et peuvent être créés.

Limites de sécurité et de débit

Avant que l'assemblage ne soit exécuté, les limites de sécurité, puis de débit, sont appliquées.

Tout d'abord, les définitions de sécurité et le contrôle d'accès CORS sont utilisés pour authentifier un appel API. Les définitions de sécurité de clé d'API sont utilisées pour identifier les applications abonnées à un produit contenant l'API. Si une définition de sécurité n'autorise pas l'accès, l'appel API est rejeté.

Si une application est identifiée par son ID client ou la valeur secrète du client, une limite de débit peut être appliquée en fonction du plan ou de l'opération appelé.

Séquence d'exécution de l'assemblage

L'assemblage est exécuté dans l'ordre du cercle initial rempli au cercle final non rempli. Toutefois, il est possible de créer des branches, lorsque des constructions logiques if et operation-switch sont utilisées, ou d'ignorer l'assemblage restant lorsqu'une stratégie throw est exécutée.

Le message est le contexte sur lequel agit une stratégie autrement non configurée. Au début de l'appel API, le message est vide et à la fin de l'appel API, le message est utilisé comme réponse.

Le contexte de demande contient les informations envoyées par l'appelant de l'API et varie en fonction du type d'opération appelée et de la configuration de cette opération. Par exemple, pour une opération GET, request.body ne peut jamais être alimenté et vous pouvez configurer une opération de sorte qu'elle ait request.parameters (paramètres de requête). La première stratégie d'un assemblage agit sur la demande et génère la première instance du message. En l'absence de stratégies, la demande est renvoyée à l'appelant.

Gestion des contextes

Etant donné que le message peut être écrasé, il est utile de créer et de référencer de nouveaux contextes dans la mesure du possible afin qu'ils soient sauvegardés et réutilisés lors de l'appel API.

Utilisez la règle map pour remplacer le contexte de message lorsque vous devez exécuter une règle qui n'agit que sur le message.
Utilisez le contexte de demande lorsque vous souhaitez utiliser la demande d'origine envoyée à l'API.
Utilisez les règles map, invokeet proxy pour créer de nouveaux contextes lorsque vous souhaitez sauvegarder votre message.
Remarque: Lorsque vous créez un nouveau contexte, sauf si vous effectuez également un mappage vers le message, le message est remplacé par un objet vide.

Par exemple, invoke est la première stratégie de l'assemblage et sa réponse remplace la demande en tant que message. Le message est ensuite traité par une règle validate , puis une règle map sauvegarde le message en tant que nouveau contexte, prêt pour une deuxième règle invoke afin de remplacer le message sans perdre la sortie de la première règle invoke .

Vous pouvez également accéder à des contextes en dehors du message ou de vos contextes personnalisés, mais ces contextes ne peuvent pas être écrits. Pour obtenir la liste des contextes, voir Variables contextuelles d'API Connect.

Branchements et interceptions

A l'aide de constructions logiques, telles que operation-switch ou if, vous pouvez exécuter différentes sections de l'assemblage lorsque certaines conditions sont remplies. Lorsque l'assemblage est divisé, sa sous-section que la construction contient est exécutée de la même manière qu'un assemblage complet. Toutefois, les contextes sont partagés avec l'assemblage complet.

Lorsqu'une interception est déclenchée, soit par une erreur se produisant lors de l'exécution d'une stratégie, soit parce qu'une stratégie throw est détectée, le reste du flux d'assemblage est ignoré. Tous les contextes sont partagés par l'interception exécutée et, lorsque la fin de l'interception est atteinte, l'appel API est terminé. Il n'est pas possible de retourner d'une interception au reste de l'assemblage.