Définition des composants de schéma

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 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.

Une API créée dans OpenAPI 3.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.

Pour utiliser un composant de schéma, vous devez le référencer à partir d'un autre emplacement dans votre définition d'API. Vous pouvez référencer un schéma à partir des emplacements suivants :

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 à des fins d'édition, comme décrit dans Edition d'une définition d'API OpenAPI 3.0.
  2. Développez Composants puis, si un ou plusieurs composants de schéma sont déjà définis, développez Schémas.
  3. Vous pouvez créer un composant de schéma ou éditer un composant de schéma existant.
    • Pour créer un composant de schéma, cliquez sur l'icône d'ajout OpenAPI 3.0 Icône d'ajout d'API en regard de Schémas, puis reportez-vous à la rubrique Création d'un composant de schéma.
    • Pour éditer un composant de schéma existant, cliquez sur le nom du composant de schéma dans le panneau de navigation, puis reportez-vous à la rubrique Edition d'un composant de schéma.