Depuración de directivas de Azure API Management en Visual Studio Code

  • Artículo

SE APLICA A: Desarrollador

Las directivas de Azure API Management proporcionan funcionalidades eficaces que ayudan a los editores de API a abordar cuestiones transversales, como la autenticación, la autorización, la limitación, el almacenamiento en caché y la transformación. Las directivas son una colección de declaraciones que se ejecutan secuencialmente en la solicitud o respuesta de una API.

En este artículo se describe cómo depurar directivas de API Management mediante la extensión de Azure API Management para Visual Studio Code.

Requisitos previos

Restricciones y limitaciones

  • Esta característica usa la suscripción de acceso completo (nivel de servicio) integrada (nombre para mostrar "Suscripción de acceso completo integrada") para la depuración. La opción Permitir seguimiento debe estar habilitada en esta suscripción.

Advertencia

  • Solo permita el seguimiento en suscripciones destinadas a fines de depuración. Compartir claves de suscripciones con seguimiento permitido con usuarios no autorizados podría dar lugar a divulgación de información confidencial contenida en los registros de seguimiento, como claves, tokens de acceso, contraseñas, nombres de host internos y direcciones IP.
  • En la consola de prueba, API Management deshabilita automáticamente el seguimiento 1 hora después de habilitarlo en una suscripción.

Inicio de una sesión de depuración

  1. Iniciar Visual Studio Code
  2. Diríjase a la extensión de API Management en las extensiones de Azure.
  3. Busque la instancia de API Management que quiere depurar.
  4. Busque la API y la operación que quiere depurar.
  5. Haga clic con el botón derecho en la operación y seleccione Start Policy Debugging (Iniciar la depuración de directiva).

En este momento, la extensión intentará iniciar y establecer una sesión de depuración con la puerta de enlace de API Management.

Iniciar depuración

Envío de una solicitud de prueba

Cuando se establezca la sesión de depuración, la extensión abrirá un nuevo editor que nos permitirá crear y enviar una solicitud HTTP de prueba a esta operación con la extensión de cliente REST.

Observará que el encabezado Ocp-Apim-Debug ya se ha agregado a la solicitud. Este encabezado es obligatorio y el valor se debe establecer en la clave de suscripción de acceso a todo de nivel de servicio para desencadenar la funcionalidad de depuración en la puerta de enlace de API Management.

Modifique la solicitud HTTP en el editor según el escenario de prueba. A continuación, haga clic en Enviar solicitud para enviar la solicitud de prueba a la puerta de enlace de API Management.

Enviar una solicitud de prueba

Depuración de directivas

Después de enviar la solicitud HTTP de prueba, la extensión abrirá la ventana depuración que muestra las directivas vigentes de esta operación y se detendrá en la primera directiva efectiva.

Depurar directivas

Para seguir la canalización de la directiva, puede realizar un paso único a través de directivas individuales o establecer un punto de interrupción en una directiva y pasar directamente a esa directiva.

En el panel Variables, puede inspeccionar los valores de las variables creadas por el sistema y creadas por el usuario. En el panel Puntos de interrupción, puede ver la lista de todos los puntos de interrupción que se han establecido. En el panel Pila de llamadas, puede ver el ámbito de la directiva vigente actual.

Si se produce un error durante la ejecución de la directiva, verá los detalles del error en la directiva en la que se produjo.

exceptions

Sugerencia

Recuerde hacer clic en el botón Detener para salir de la sesión de depuración cuando termine.

Pasos siguientes