Définition des schémas pour une API

Modifier en ligne

Les composants de schéma définissent des schémas réutilisables qui fournissent aux développeurs des informations sur la demande qu'ils doivent effectuer, ou la réponse qu'ils doivent s'attendre à recevoir lors de l'appel d'une opération API.

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.

Une API créée dans OpenAPI 2.0 comprend une section où sont définies les spécifications de la charge utile de l'API. Les définitions de la charge utile décrivent la structure des données transmises dans les requêtes et les réponses de l'API, en utilisant une variante spécialisée du schéma JSON propre à OpenAPI. Chaque définition de charge utile correspond à un schéma qui répertorie les champs de données attendus. Ces champs de données sont représentés sous forme de propriétés au sein du schéma et comprennent un ensemble d'attributs qui décrivent leur type, leurs valeurs autorisées, leur caractère obligatoire et d'autres caractéristiques. Bien que de nombreux attributs soient disponibles, la plupart d'entre eux sont rarement utilisés.

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

Ouvrez l'API pour édition, comme décrit dans Edition d'une définition d'API OpenAPI 2.0.
Si un ou plusieurs schémas sont déjà définis, développez Définitions.
Vous pouvez créer un nouveau schéma ou éditer un schéma existant.
- Pour créer un schéma, cliquez sur l'icône « Ajouter » située à côté de « Définitions », puis consultez la section « Création de définitions de schéma ».
- Pour modifier un schéma existant, cliquez sur le nom du composant du schéma dans le volet de navigation, puis consultez la section « Modification des définitions de schéma ».