Edition d'un lien

Modifier en ligne

Les liens décrivent la façon dont différentes valeurs renvoyées par une seule opération peuvent être utilisées comme entrée pour d'autres opérations, en fournissant une relation connue et un mécanisme de traversée entre les opérations.

Avant de commencer

Ouvrez le formulaire des détails d'un lien. Pour en savoir plus sur les zones de votre définition d'API à partir desquelles vous pouvez éditer un lien, consultez les rubriques suivantes :

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.

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

Procédure

Fournissez les informations suivantes :
- Nom: Si vous éditez un composant de lien, ce nom définit une clé qui permet à ce lien d'être référencé à partir d'un autre emplacement dans la définition d'API. La référence est au format suivant :
```
#/components/links/Name
```
  Pour modifier le nom, cliquez sur Mettre à jour, puis sur Sauvegarder lorsque vous avez terminé.
- ID de l'opération : ID d'une opération existante. Cette zone et la zone Référence de l'opération s'excluent mutuellement. Pour plus de détails sur la définition des opérations, voir Définition des opérations pour un chemin.
- Référence de l'opération : Référence URI relative ou absolue à une opération existante. Cette zone et la zone ID de l'opération s'excluent mutuellement. Pour plus d'informations sur la définition des opérations, consultez la section « Définition des opérations pour un chemin ».
- Paramètres : Mappe représentant les paramètres à transmettre à une opération telle qu'elle est spécifiée avec l'ID de l'opération ou identifiée dans Référence de l'opération. La clé est le nom de paramètre à utiliser, tandis que la valeur peut être une constante ou une expression à évaluer et à transmet tre à l'opération liée.
- Corps de demande : Corps de la demande à utiliser lors de l'appel de l'opération cible.
- Description: description du lien. Vous pouvez utiliser la syntaxe CommonMark pour afficher du texte formaté.
- Serveur : Serveur à utiliser par l'opération cible. Fournissez les informations suivantes :
  - URL de serveur : L'URL spécifiée permet de déterminer le noeud final d'URL complet qui sert à appeler l'API, en tenant compte des éventuelles configurations de noeud final personnalisé dans le catalogue dans lequel l'API est publiée. Pour plus de détails, voir Configuration de noeuds finaux personnalisés pour un catalogue.
  - Description du serveur : Description facultative de l'hôte désigné par l'URL. Vous pouvez utiliser la syntaxe CommonMark pour afficher du texte formaté.
  - Variables du serveur : Une variable de serveur définit une mappe entre un nom de variable et sa valeur. La valeur est utilisée pour la substitution dans le modèle d'URL du serveur.
    1. Pour ajouter une nouvelle variable de serveur, cliquez sur Ajouter. Pour éditer une variable de serveur existante, cliquez sur le nom de la variable.
    2. Fournissez les informations suivantes :
      
      Nom de variable de serveur (obligatoire).
      
      Valeur par défaut (obligatoire).
      
      Une description facultative en texte enrichi. Vous pouvez utiliser la syntaxe CommonMark pour afficher du texte formaté.
      
      Une ou plusieurs entrées Valeur Enum (disponibles lors de l'édition d'une variable de serveur existante). Les valeurs Enum indiquent une énumération de valeurs de chaîne à utiliser si les options de substitution proviennent d'un ensemble limité. Pour ajouter une valeur Enum, cliquez sur Ajouter, entrez la valeur, puis cliquez sur Créer. Pour éditer une valeur Enum existante, cliquez sur la valeur Enum.
    3. Si vous créez une variable de serveur, cliquez sur Créer. Les détails de la variable du serveur s'affichent pour modification ultérieure.
Cliquez sur Sauvegarder lorsque vous avez terminé.

Etape suivante

Au besoin, utilisez le trajet de navigation pour accéder à un autre emplacement dans la hiérarchie de l'objet sur lequel vous travaillez.