Definición de componentes de esquema

Editar en línea

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

Una API creada en OpenAPI 3.0 incluye una sección en la que se definen las definiciones de la carga útil de la API. Las definiciones de la carga útil describen la estructura de los datos transmitidos en las solicitudes y respuestas de la API, utilizando una variante especializada del esquema JSON específica de OpenAPI. Cada definición de carga útil se corresponde con un esquema, que enumera los campos de datos previstos. Estos campos de datos se representan como propiedades dentro del esquema e incluyen un conjunto de atributos que describen su tipo, los valores permitidos, su carácter 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.

Para utilizar un componente de esquema, debe hacer referencia a él desde otra ubicación de la definición de API. Puede hacer referencia a un esquema desde las ubicaciones siguientes:

Un parámetro de ruta de la API; consulte «Definición de parámetros para una ruta ».
Un parámetro de una operación de la API; véase «Definición de parámetros para una operación ».
El cuerpo de la solicitud de una operación de API; véase «Definición del cuerpo de la solicitud de una operación ».
Una respuesta de una operación de API; véase «Definición de respuestas para una operación ».

En cualquier momento, puedes pasar directamente al código fuente YAML de « OpenAPI » haciendo clic en el icono «Fuente Icono OpenAPI Source ». Para volver al formulario de diseño, haz clic en el icono del formulario Icono de formulario .

Procedimiento

Abra la API para editarla, tal como se describe en Edición de una definición de API de OpenAPI 3.0.
Expandir Componentes , si ya hay uno o más componentes de esquemas definidos, expanda Esquemas.
Puede crear un componente de esquema o editar cualquier componente de esquema existente.
- Para crear un componente de esquema, haz clic en el icono de añadir situado junto a «Esquemas » y, a continuación, consulta la sección «Creación de un componente de esquema ».
- Para editar un componente de esquema existente, haga clic en el nombre del componente de esquema en el panel de navegación y, a continuación, consulte la sección «Edición de un componente de esquema ».