Creación de un componente de esquema

Los esquemas proporcionan a los desarrolladores información relativa a la solicitud que deben realizar o a la respuesta que deben esperar recibir al llamar a una operación de API. Puede crear esquemas en diversos lugares de la definición de API.

Antes de empezar

Nota: Los esquemas se compilan antes de que se utilicen para la validación. Puesto que el proceso de compilación es más largo que el proceso de validación, los artefactos de esquema compilados se almacenan en una memoria caché. La capacidad limitada de la memoria caché puede hacer que las entradas más antiguas se desalojen de la memoria caché cuando se añadan entradas más recientes. Los esquemas cuyos artefactos se han desalojado de la memoria caché deben volver a compilarse, lo que puede provocar retrasos significativos en la validación.
Abra la ventana de creación de esquemas. Para obtener detalles de las áreas de la definición de API donde puede crear un esquema, consulte los temas siguientes:

Acerca de esta tarea

Nota:
  • Esta tarea está relacionada con la configuración de una definición de API OpenAPI 3.0. Para obtener detalles sobre cómo configurar una definición de API de OpenAPI 2.0 , consulte Edición de una definición de API de OpenAPI 2.0.
  • Las API de OpenAPI 3.0 solo están soportadas con DataPower® API Gateway, no con DataPower Gateway (v5 compatible).
  • Para obtener detalles sobre las limitaciones actuales del soporte de OpenAPI 3.0 , consulte el soporte de OpenAPI 3.0 en IBM® API Connect.

Puede completar esta tarea utilizando la aplicación de interfaz de usuario de API Designer o utilizando la interfaz de usuario de API Manager basada en navegador.

En cualquier momento, puede conmutar directamente al origen YAML OpenAPI subyacente pulsando el icono Origen Icono OpenAPI Source. Para volver al formulario de diseño, pulse el icono Formulario Icono de formulario.

Procedimiento

  1. Para crear una definición de esquema, abra el elemento Componentesy pulse el icono Añadir OpenAPI 2.0 Icono de adición de API junto a Esquema.
    Se visualiza el asistente Añadir objeto para un esquema.
  2. Especifique la información siguiente:
      • Nombre de esquema: si está creando un componente de esquema, este nombre define una clave que permite hacer referencia a este esquema desde otra ubicación de la definición de API; la referencia tiene el formato siguiente:
        #/components/schemas/Name
      • Título: El título del esquema.
      • Tipo: el tipo de datos del esquema; seleccione uno de los siguientes:
        • matriz
        • Boolean
        • entero
        • número
        • objeto
        • serie
  3. Pulse Crear.
    Los detalles del esquema se muestran para su posterior edición; consulte Edición de un componente de esquema.