Definición de respuestas para una API

Editar en línea

Las respuestas definen el código de estado HTTP y los datos devueltos en un cuerpo de respuesta y las cabeceras. Las respuestas definidas para una API se pueden utilizar entre operaciones.

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.

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, puedes pasar directamente al código fuente YAML de « OpenAPI » haciendo clic Icono OpenAPI Source en el icono «Fuente ». Para volver al formulario de diseño, haz clic en el icono del 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 una o más respuestas definidas, expanda Definiciones de respuesta.
  3. Puede crear una respuesta o editar cualquier respuesta existente.
    • Para crear una respuesta, haz clic en el icono de añadir OpenAPI 2.0 Icono de adición de API situado junto a «Definiciones de respuesta » y, a continuación, consulta la sección «Creación de una respuesta ».
    • Para editar una respuesta existente, haz clic en el nombre de la respuesta en el panel de navegación y, a continuación, consulta la sección «Edición de una respuesta ».