Définition d'opérations pour un chemin

Modifier en ligne

Les opérations sur un chemin définissent les mécanismes disponibles pour interagir avec l'API lorsqu'elle est appelée à l'aide de ce chemin. Une opération peut avoir différents types prédéfinis. Par exemple, une opération POST est généralement utilisée pour créer des ressources, tandis qu'une opération GET est utilisée pour extraire une ressource.

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

  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.
  3. Développez le chemin requis, puis, s'il existe une ou plusieurs opérations, développez Opérations.
  4. Pour créer une opération, cliquez sur l'icône « Ajouter OpenAPI 3.0 Icône d'ajout d'API » située à côté de « Opérations » sous « Chemin » dans le volet de navigation. Pour éditer une opération existante, cliquez sur l'URL de l'opération sous le chemin dans le panneau de navigation.
  5. Fournissez les informations suivantes :
    • Instruction : Sélectionnez le type d'opération parmi les options suivantes :
      1. get
      2. POST
      3. put
      4. delete
      5. Options
      6. effectif
      7. PATCH
      8. suivi
    • Récapitulatif : Récapitulatif de l'opération.
    • Description: description du comportement de l'opération. Vous pouvez utiliser la syntaxe CommonMark pour afficher du texte formaté.
    • ID de l'opération : Chaîne unique utilisée pour identifier l'opération. L'ID doit être unique parmi toutes les opérations décrites dans l'API.
    • Obsolète : Déclare l'obsolescence de cette opération. Les consommateurs doivent s'abstenir d'utiliser l'opération déclarée.
  6. Si vous créez une opération de chemin, cliquez sur Créer.
  7. Cliquez sur Sauvegarder lorsque vous avez terminé.