Definición de componentes de respuesta

Los componentes de respuesta definen objetos de respuesta reutilizables que especifican el código de estado HTTP y los datos devueltos en un cuerpo de respuesta y las cabeceras.

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.

Para utilizar un componente de respuesta, debe hacer referencia a él desde otra ubicación de la definición de API.

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 3.0.
  2. Expandir Componentes , si ya hay uno o varios componentes de respuesta definidos, expanda Respuestas.
  3. Puede crear un componente de respuesta o editar cualquier componente de respuesta existente.
    • Para crear un componente de respuesta, pulse el icono de añadir OpenAPI 3.0 Icono de adición de API junto a Respuestasy, a continuación, consulte Creación de una respuesta.
    • Para editar un componente de respuesta existente, pulse el nombre del componente de respuesta en el panel de navegación y, a continuación, consulte Edición de una respuesta.