L'éditeur d'assemblage

Modifier en ligne

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 comprend les options suivantes :

Palette - répertorie les éléments disponibles dans le flux d'assemblage.
Toile - sert à organiser et à visualiser les éléments de l'assemblage.
Fiche de propriétés - sert à configurer les éléments de 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 « + » sur le canevas. Vous pouvez utiliser l'icône « Rotation » pour faire pivoter la palette comme vous le souhaitez. Pour agrandir ou réduire la fenêtre de la palette, cliquez sur les icônes d'agrandissement et de réduction.

Vous pouvez fermer la palette en cliquant sur l'icône « Une croix sur l'en-tête de la palette Fermer ».

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 « + » à l'emplacement souhaité sur le canevas, puis sélectionnez l'élément souhaité dans la liste disponible. Pour supprimer un élément du canevas, passez la souris dessus et cliquez sur l'icône L'icône en forme de corbeille qui apparaît lorsque vous passez la souris sur un élément de la zone de travail Supprimer.

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 la toile à la taille de l'écran, cliquez sur l'icône « Ajuster Un carré contenant des crochets obliques à l'écran ».

La feuille de propriétés

Lorsque vous sélectionnez un élément de l'assemblage en cliquant dessus, des informations détaillées sur cet é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 dépendent du type d'élément sur lequel vous travaillez. 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 fermer la fenêtre de propriétés en cliquant sur l'icône Une croix sur l'en-tête de la palette Fermer.

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é. Au cours de l'assemblage, le flux peut être dérivé, renvoyé et intercepté selon les règles disponibles. Le contexte du message circule à travers l'ensemble, où il est utilisé et modifié par différentes politiques. 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. Cependant, il est possible de créer des branchements lorsque des if constructions logiques operation-switch et sont utilisées, ou d'ignorer le reste du code d'assemblage lorsqu'une throw politique 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, ce message sert de réponse.

Le contexte de la requête contient les informations envoyées par l'appelant de l'API; il varie en fonction du type d'opération appelée ainsi que 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

Comme le message peut être écrasé, il est utile de créer et d'utiliser de nouveaux contextes lorsque cela est possible, afin qu'ils soient enregistrés et réutilisés lors de l'appel de l'API.

Utilisez cette map politique pour remplacer le contexte du message lorsque vous devez exécuter une politique 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, invokeproxy , et pour créer de nouveaux contextes lorsque vous souhaitez enregistrer 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 règle de l'ensemble et sa réponse remplace la requête en tant que message. Le message est ensuite traité par une validate politique, qui map enregistre ensuite ce message dans un nouveau contexte, permettant ainsi à une deuxième invoke politique de le réécrire sans perdre le résultat de la première invoke politique.

Vous pouvez également accéder à des contextes extérieurs au message ou à vos contextes personnalisés, mais il n'est pas possible d'y écrire. Pour obtenir la liste des variables de contexte, consultez la page API Connect context variables.

Branchements et interceptions

En utilisant des constructions logiques, telles que operation-switch ou if, vous pouvez exécuter différentes sections du programme 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 exception est levée, soit à la suite d'une erreur survenue pendant l'exécution d'une règle, soit parce qu'une throw règle a été rencontré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.