Creación de una respuesta

Las respuestas definen el código de estado HTTP y los datos devueltos en un cuerpo de respuesta y las cabeceras. Puede crear respuestas para las operaciones de vía de acceso en la definición de API.

Antes de empezar

Abra la ventana de creación de respuestas. Para obtener detalles de las áreas de la definición de API desde donde puede crear una respuesta, 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. Cree la respuesta; puede crear una respuesta desde cero o hacer referencia a una respuesta que esté definida en un componente de respuesta.
    • Para crear la respuesta desde cero, especifique la información siguiente en la pestaña Definición:
      • Nombre de respuesta: un nombre para la respuesta.

        Si está creando una respuesta de operación, este nombre es el código de estado HTTP.

        Si está creando un componente de respuesta, este nombre define una clave que permite hacer referencia a esta respuesta desde otra ubicación de la definición de API; la referencia tiene el formato siguiente:
        #/components/responses/Name
      • Descripción (obligatorio): Una descripción de la respuesta. Puede utilizar la sintaxis CommonMark para la representación de texto enriquecido.
    • Para hacer referencia a una respuesta que está definida en un componente de respuesta, especifique la información siguiente en la pestaña Referencia:
      • Nombre de respuesta: un nombre para la respuesta.

        Si está creando una respuesta de operación, este nombre es el código de estado HTTP.

        Si está creando un componente de respuesta, este nombre define una clave que permite hacer referencia a esta respuesta desde otra ubicación de la definición de API; la referencia tiene el formato siguiente:
        #/components/responses/Name
      • Referencia desde: seleccione una referencia a un componente de respuesta.
  2. Pulse Crear.
    Los detalles de la respuesta se muestran para su posterior edición; consulte Edición de una respuesta.