Ajout d'éléments à votre assemblage

Modifier en ligne

Créez votre assemblage d'API à l'aide de la vue Assembler dans API Designer. Vous pouvez accéder à la vue Assemble en cliquant sur l'onglet Gateway dans l'éditeur d'API.

A propos de cette tâche

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 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.

Vous pouvez utiliser l'outil d'assemblage dans l'interface utilisateur pour créer des assemblages qui permettent de manipuler les demandes adressées aux opérations d'API ou les réponses renvoyées par ces dernières.

À tout moment, vous pouvez accéder directement au fichier YAML source d' OpenAPI en cliquant sur l'icône Source OpenAPI Icône Source . Pour revenir au formulaire de conception, cliquez sur l'icône Formulaire Icône de formulaire .

Si vous souhaitez utiliser la vue Source pour éditer la source de votre définition d'API, voir execute OpenAPI extension pour plus d'informations sur la configuration du fichier YAML OpenAPI .

Pour plus d'informations sur l'utilisation de l'outil d'assemblage, consultez la section « L'éditeur d'assemblage ».

Procédure

Pour ajouter des éléments à votre assemblage à l'aide de l'outil d'assemblage, procédez comme suit :

Dans le volet de navigation, cliquez sur « Développement », puis sélectionnez l'onglet « API ».
La page Développement s'ouvre.
Cliquez sur le titre de la définition d'API à utiliser.
Utilisez la vue Règles pour ajouter un élément.

Remarque: vous devez spécifier une version pour la règle. Afin d'éviter toute erreur due à une incompatibilité entre les versions d'une politique au niveau de l'API et de la passerelle, API ConnectAI Gateway ne publiera une API vers la passerelle que si la version de la politique dans l'API correspond exactement à celle présente sur la passerelle.
1. Sélectionnez l'onglet Passerelle , puis cliquez sur Stratégies dans le panneau de navigation.
2. Cliquez sur l'icône « + » à l'endroit souhaité sur le canevas pour afficher la palette répertoriant les éléments disponibles.
3. Sélectionnez l'élément que vous souhaitez ajouter de la palette à la zone de travail en cliquant dessus.
  Remarque :
  - L'assemblage est exécuté dans l'ordre, du cercle initial non rempli au cercle final rempli.
  - L'assemblage s'applique en totalité à toutes les opérations de l'API sauf si un élément Permutation d'opération est utilisé.
4. Pour ajouter ou modifier les propriétés d'un élément, cliquez dessus et utilisez la feuille de propriétés.
  Pour certains éléments, vous pouvez ajouter et supprimer des propriétés en cliquant sur Propriétés de l'objet, puis en sélectionnant la propriété dans la liste déroulante. Pour plus d'informations sur les propriétés des éléments de stratégie, consultez la section « Stratégies API et constructions logiques ». Pour plus d'informations sur les propriétés des constructions logiques, consultez la section « Constructions logiques ».
5. Indiquez une version pour la règle.
  Pour ajouter une version, cliquez sur l'icône Source , puis complétez la version section correspondante du fichier YAML de la politique. Par exemple :
```
execute:
  - invoke:
      version: 2.2.0
      title: invoke
...
```
  Vous devez spécifier une version pour la règle compatible avec la passerelle que vous utilisez. Lorsque l'API est publiée, si la version est incompatible avec la passerelle, une erreur de validation indiquant les versions disponibles est émise. Pour plus d'informations sur la configuration de la stratégie OpenAPI YAML, voir execute OpenAPI extension.
Facultatif : répétez les étapes décrites aux pages 3.b à 3.e pour tout élément supplémentaire que vous souhaitez ajouter.
Cliquez sur Sauvegarder pour sauvegarder vos modifications.

Résultats

Vous avez ajouté un ou plusieurs éléments à votre assemblage.