Depurar una API

La depuración de una API permite identificar y depurar más rápidamente las solicitudes fallidas en tiempo de ejecución.

Antes de empezar

Asegúrese de que dispone de privilegios funcionales para Gestionar API o Activar o Desactivar API.

Acerca de esta tarea

El rastreador en webMethods API Gateway tiene la capacidad de depuración, que, cuando está activada, enumera las peticiones API realizadas. Tracer admite la supervisión del ciclo de vida de las solicitudes en tiempo de ejecución en webMethods API Gateway. La inspección de las solicitudes fallidas en tiempo de ejecución le ayuda a depurar y solucionar problemas de sus llamadas a la API.

Nota: Puede rastrear las llamadas a las API REST, SOAP y OData.

El siguiente ejemplo ilustra los pasos para crear una API REST Petstore Debugging, habilitar el seguimiento en esta API, iniciar la API Petstore Debugging mediante Postman y depurarla.

Procedimiento

  1. Cree una API REST importando una API de un archivo URL
    1. Abra el menú de opciones y seleccione APIs.
    2. Haga clic en Crear API.
    3. Haga clic en Importar API desde URL.
    4. Facilite la siguiente información

      La API se crea y aparece en la lista de APIs.

  2. Haga clic en Activar para activar la API.
    La página de detalles de la API muestra la Información básica, la Información técnica, los Recursos, los métodos y las especificaciones de la API seleccionada.
  3. Haga clic en Activar rastreo.
    Cuando se activa el rastreador webMethods API Gateway captura una gran cantidad de datos, lo que podría afectar al rendimiento y la disponibilidad de webMethods API Gateway. Por lo tanto, desactive el rastreador cuando no lo necesite.
  4. Ahora, puedes iniciar REST API URI en Postman. Para saber cómo iniciar API usando Postman sigue los siguientes pasos.
    1. Abra Postman y cree una nueva solicitud.
    2. Establezca el método de solicitud como GET e introduzca URL http://host/port/gateway/Petstore%20Debugging/1.0.6/pet/1
    3. Haga clic en Enviar para iniciar el punto final.
      Una vez que la API se llama correctamente, aparece un mensaje de éxito y puede acceder a los detalles en la pestaña Tracer.
  5. Haga clic en Rastreador para ver los detalles de rastreo de Depuración de la tienda de mascotas.
  6. La página API de rastreo muestra las secciones Eventos en tiempo de ejecución, Políticas aplicadas y Detalles del rastreador de eventos.
    Nota: La sección Eventos en tiempo de ejecución sólo enumera 20 eventos en tiempo de ejecución por página. Al hacer clic en la casilla Seleccionar todo por página, no se seleccionan todos los eventos de tiempo de ejecución de la API. En su lugar, se seleccionan los 20 eventos de ejecución que aparecen en esa página.

    La sección Eventos en tiempo de ejecución muestra la lista de eventos en tiempo de ejecución. Al hacer clic en Evento en tiempo de ejecución, por defecto se actualizan las secciones Políticas aplicadas y Detalles del rastreador de eventos. Los detalles del rastreador de eventos muestran secciones de información general, solicitud y respuesta de API y registros del servidor. En la sección Políticas aplicadas, haga clic en el nombre de la etapa de la que desea ver los detalles de la traza.

  7. En la sección Eventos en tiempo de ejecución, encontrará las opciones Actualizar, Filtrar, Importar y Ver eventos, y Exportar.
    • Para filtrar los eventos en tiempo de ejecución, haga clic en el icono del calendario y seleccione el intervalo de tiempo mediante Selección rápida y Filtros de uso común. La sección Eventos en tiempo de ejecución muestra la lista de eventos en tiempo de ejecución en función del filtro aplicado.

    • En la sección Eventos en tiempo de ejecución, haga clic en el icono de vista para importar las solicitudes en tiempo de ejecución archivadas. Aparece la ventana emergente Importar y ver eventos. Examine el archivo de solicitudes en tiempo de ejecución que desea importar y Ver.

    • En la sección Eventos en tiempo de ejecución, seleccione el evento en tiempo de ejecución que desea exportar o descargar. Haga clic en el icono de exportación para exportar la solicitud de tiempo de ejecución.