Définition de définitions de schéma pour une API

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 inclut une section dans laquelle les définitions de contenu d'API sont définies. Les définitions de contenu décrivent la structure des données transmises dans les demandes et les réponses d'API, en utilisant une variante de schéma JSON spécifique à OpenAPI. Chaque définition de contenu correspond à un schéma, qui répertorie les zones de données attendues. Ces zones de données sont représentées sous forme de propriétés dans le schéma et incluent un ensemble d'attributs qui décrivent leur type, les valeurs autorisées, le statut obligatoire et d'autres caractéristiques. Bien que de nombreux attributs soient disponibles, la majorité 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.

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. Si un ou plusieurs schémas sont déjà définis, développez Définitions.
  3. Vous pouvez créer un nouveau schéma ou éditer un schéma existant.