Définition des paramètres d'une opération

Les paramètres d'opération peuvent définir des éléments de variable du chemin d'URL, des paramètres de requête, des en-têtes ou des paramètres de corps pour le chemin d'URL associé à cette opération spécifique.

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.

Un paramètre d'opération remplace un paramètre du même nom défini sur le chemin parent ; voir Définition de paramètres pour un chemin.

Un paramètre est semblable à un en-tête, avec les différences suivantes :
  • Les paramètres comportent des données réelles et sont disponibles pour les utilisateurs finaux, les en-têtes comportent des métadonnées associées à une demande ou une réponse et sont masqués pour les utilisateurs finaux.
  • Un paramètre peut avoir différents emplacements, l'emplacement d'un en-tête est toujours défini sur header.
  • Un paramètre peut avoir différents styles de format, le style d'un en-tête étant toujours simple.
Pour plus d'informations sur les en-têtes, voir Création d'un en-tête.

A tout moment, vous pouvez passer directement à la source YAML OpenAPI sous-jacente 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

  1. Ouvrez l'API à des fins d'édition, comme décrit dans Edition d'une définition d'API OpenAPI 3.0.
  2. Développez Chemins, puis développez le chemin requis.
  3. Développez Opérations, puis développez l'opération requise.
  4. Vous pouvez créer un nouveau paramètre d'opération ou éditer un paramètre existant.
    • Pour créer un paramètre d'opération, cliquez sur l'icône d'ajout OpenAPI 3.0 Icône d'ajout d'API en regard de Paramètre, puis reportez-vous à la rubrique Création d'un paramètre.
    • Pour éditer un paramètre d'opération existant, cliquez sur le nom du paramètre dans le panneau de navigation, puis reportez-vous à la rubrique Edition d'un paramètre.