Définition des paramètres d'une API

Les paramètres peuvent spécifier des éléments variables d'un chemin d'accès URL, des paramètres de requête, des en-têtes ou un corps de requête.

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.

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 pour édition, comme décrit dans Edition d'une définition d'API OpenAPI 2.0.
  2. S'il existe déjà un ou plusieurs paramètres définis, développez Définitions de paramètres.
  3. Vous pouvez créer un nouveau paramètre ou éditer tout paramètre existant.
    • Pour créer un paramètre, cliquez sur l'icône d'ajout OpenAPI 2.0 Icône d'ajout d'API en regard de Paramètres, puis reportez-vous à la rubrique Création d'un paramètre.
    • Pour éditer un paramètre existant, cliquez sur le nom du paramètre dans le panneau de navigation, puis reportez-vous à la rubrique Edition d'un paramètre.