Creación, comprensión y depuración de directivas de Azure API Management en Visual Studio Code

SE APLICA A: todos los niveles de API Management

En este artículo se explica cómo usar la extensión de Azure API Management para Visual Studio Code para crear, comprender y depurar directivas de Azure API Management con ayuda de IA de GitHub Copilot para Azure.

Las directivas de Azure API Management son una secuencia de instrucciones que abordan problemas transversales como autenticación, autorización, limitación, almacenamiento en caché y transformación, aplicados a las solicitudes o respuestas de API.

Requisitos previos

• Visual Studio Code y la versión más reciente de la extensión de Azure API Management para Visual Studio Code.

• Se necesitan las siguientes extensiones para los escenarios especificados:

  • GitHub Copilot para la extensión de Azure : para crear y explicar directivas
  • Extensión de cliente REST - para la depuración de directivas

• Una instancia de API Management. Si necesita crear una, consulte este inicio rápido.

• Importe una API a la instancia de API Management. Para obtener pasos de ejemplo, vea Tutorial: Uso de la extensión API Management para Visual Studio Code para importar y administrar las API.

Restricciones y limitaciones

• Actualmente la depuración de directivas solo se admite en el nivel Desarrollador de API Management.

• La depuración de directivas usa la suscripción de acceso completo (nivel de servicio) integrada (nombre para mostrar "Suscripción de acceso completo integrada"). Debe ser propietario del servicio para usar esta suscripción.

Creación de una directiva mediante GitHub Copilot para Azure

La extensión azure API Management se integra con GitHub Copilot para Azure para ayudarle a crear un borrador de una directiva. Con la ayuda de inteligencia artificial, cree y edite directivas de forma fácil de usar.

Para crear una directiva:

1. Abra la extensión API Management en Visual Studio Code.

2. Seleccione la instancia de API Management con la que desea trabajar.

3. Seleccione el ámbito de directiva con el que desea trabajar.

   • Para crear una directiva que se aplique a todas las API de la instancia, seleccione Directiva global.
   • Para crear una directiva que se aplique a una API específica, en API, seleccione la API y, a continuación, seleccione Directiva.
   • Para crear una directiva que se aplique a una operación de API específica, seleccione la operación y, a continuación, seleccione Directiva.

4. Abrir chat.

5. En la ventana Chat, escriba un mensaje en lenguaje natural para crear una directiva. Ejemplos:

   @azure I want to limit requests to 100 calls per minute
   

   @azure Create a policy that sets the backend URL to https://mybackend.contoso.com and adds a custom header to the request
   

6. Copilot genera un borrador de directiva en la ventana Chat. Puede refinar la sugerencia si desea que Copilot cambie el resultado.

7. Cuando esté listo, seleccione el botón Copiar para copiar la directiva en el Portapapeles o seleccione Aplicar en el Editor para insertar la directiva en la ventana del editor. Si está satisfecho con el cambio en el XML de la directiva, seleccione Mantener.

Sugerencia

Compruebe la ventana Problemas para obtener una explicación de los problemas en el XML de la directiva.

Explicación de una directiva mediante GitHub Copilot para Azure

Copilot puede ayudar a explicar una directiva existente en la instancia de API Management.

Para recibir una explicación:

1. Abra la extensión API Management en Visual Studio Code.

2. Seleccione la instancia de API Management con la que desea trabajar.

3. Seleccione el ámbito de directiva con el que desea trabajar.

   • Para explicar una directiva que se aplica a todas las API de la instancia, seleccione Directiva global.
   • Para explicar una directiva que se aplica a una API específica, en API, seleccione la API y, a continuación, seleccione Directiva.
   • Para explicar una directiva que se aplica a una operación de API específica, seleccione la operación y, a continuación, seleccione Directiva.

4. En la ventana del editor de directivas que aparece, haga clic con el botón derecho y seleccione Explicar.

5. En la ventana de chat se genera una visión general y una explicación de las directivas en el documento XML de políticas.

Depurar políticas con la extensión de VS Code

La extensión Azure API Management para Visual Studio Code proporciona una experiencia de depuración que le permite recorrer paso a paso la canalización de directivas o establecer un punto de interrupción cuando envía una solicitud a la puerta de enlace.

Inicio de una sesión de depuración

1. Abra la extensión API Management en Visual Studio Code.
2. Seleccione la instancia de API Management que se va a debuguear.
3. Seleccione la API y la operación para depurar.
4. Haga clic derecho sobre la operación y seleccione Iniciar depuración de directivas.

En este momento, la extensión comienza a establecer una sesión de depuración con la puerta de enlace de API Management. Verifique el progreso en la ventana Consola de depuración.

Nota:

Al iniciar una sesión de depuración también se habilita el seguimiento de solicitudes durante la sesión, para ayudarle a diagnosticar y resolver problemas.

Envío de una solicitud de prueba

Cuando se establece la sesión de depuración, la extensión cliente REST abre un nuevo editor que le permite crear y enviar una solicitud HTTP de prueba a la puerta de enlace.

El encabezado Ocp-Apim-Debug se agrega automáticamente 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.

Depuración de directivas

Una vez enviada la solicitud HTTP de prueba, la extensión abre la ventana de depuración, que muestra las directivas vigentes de esta operación y se detiene en la primera directiva efectiva.

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 , inspeccione los valores de las variables creadas por el sistema y creadas por el usuario.
• En el panel Puntos de interrupción, vea la lista de todos los puntos de interrupción que se han establecido.
• En el panel Pila de llamadas, vea 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.

Salga de la sesión de depuración haciendo clic en el botón Detener cuando haya terminado.

Sugerencia

Para revisar el seguimiento de la solicitud, seleccione el valor del Ocp-Apim-Trace-Location encabezado que se proporciona en la respuesta HTTP.

Contenido relacionado

• Obtenga más información acerca de la Extensión de API Management para Visual Studio Code.
• Notifique los problemas en el repositorio de Github.