Definición de definiciones de esquema para una API

Los componentes de esquema definen esquemas reutilizables que 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.

Acerca de esta tarea

Nota: Esta tarea está relacionada con la configuración de una definición de API de OpenAPI 2.0 . Para obtener detalles sobre cómo configurar una definición de API de OpenAPI 3.0 , consulte Edición de una definición de API de OpenAPI 3.0.

Una API creada en OpenAPI 2.0 incluye una sección en la que se definen definiciones de carga útil de API. Las definiciones de carga útil describen la estructura de datos transmitidos en solicitudes y respuestas de API, utilizando una variante de esquema JSON especializada específica de OpenAPI. Cada definición de carga útil corresponde a un esquema, que lista los campos de datos esperados. Estos campos de datos se representan como propiedades dentro del esquema e incluyen un conjunto de atributos que describen su tipo, valores permitidos, estado obligatorio y otras características. Aunque hay numerosos atributos disponibles, la mayoría de ellos se utilizan con poca frecuencia.

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. Abra la API para editarla, tal como se describe en Edición de una definición de API de OpenAPI 2.0.
  2. Si ya hay uno o varios esquemas definidos, expanda Definiciones.
  3. Puede crear un esquema nuevo o editar cualquier esquema existente.