Spécification des schémas pour une API

Les schémas définissent les protocoles de transfert que votre API doit utiliser.

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. Développez la section Général , puis, si un ou plusieurs schémas sont déjà définis, développez Liste des schémas.
  3. Pour spécifier un nouveau schéma, cliquez sur l'icône d'ajout OpenAPI 2.0 Icône d'ajout d'API en regard de Liste des schémas. Pour modifier un schéma existant, cliquez sur l'entrée de schéma dans le panneau de navigation.
  4. Sélectionnez le schéma requis dans la liste fournie, puis cliquez sur Créer.
  5. Cliquez sur Sauvegarder lorsque vous avez terminé.