Eseguire il debug dei criteri di Gestione API di Azure in Visual Studio Code

  • Articolo

SI APPLICA A: Sviluppatore

I criteri in Gestione API di Azure offrono potenti funzionalità che consentono agli editori di API di risolvere problemi trasversali, ad esempio l'autenticazione, l'autorizzazione, la limitazione, la memorizzazione nella cache e la trasformazione. I criteri sono una raccolta di istruzioni che vengono eseguite in modo sequenziale sulla richiesta o la risposta di un'API.

Questo articolo descrive come eseguire il debug dei criteri di Gestione API usando l'estensione Gestione API di Azure per Visual Studio Code.

Prerequisiti

Restrizioni e limitazioni

  • Questa funzionalità usa la sottoscrizione all-access predefinita (a livello di servizio) (nome visualizzato "Sottoscrizione all-access predefinita") per il debug.

Importante

  • Gestione API non supporta più le sottoscrizioni per la traccia o Intestazione Ocp-Apim-Trace.
  • Per migliorare la sicurezza dell'API, la traccia può ora essere abilitata a livello di singola API ottenendo un token limitato a tempo usando l'API REST Gestione API e passando il token in una richiesta al gateway. Per informazioni dettagliate, vedere Abilitare la traccia di un'API.
  • Prestare attenzione quando si abilita la traccia, in quanto può esporre informazioni riservate nei dati di traccia. Assicurarsi di avere misure di sicurezza appropriate per proteggere i dati di traccia.

Avviare una sessione di debug

  1. Avviare Visual Studio Code
  2. Passare all'estensione Gestione API in Estensioni di Azure
  3. Trovare l'istanza di Gestione API per il debug
  4. Trovare l'API e l'operazione di debug
  5. Fare clic con il pulsante destro del mouse sull'operazione e selezionare Avvia debug dei criteri

A questo punto, l'estensione tenterà di avviare e stabilire una sessione di debug con il gateway di Gestione API.

avviare il debug

Inviare una richiesta di test

Quando viene stabilita la sessione di debug, l'estensione aprirà un nuovo editor che consente di creare e inviare una richiesta HTTP di test a questa operazione sfruttando l'estensione client REST.

Si noterà che l'intestazione Ocp-Apim-Debug è già stata aggiunta alla richiesta. Questa intestazione è obbligatoria e il valore deve essere impostato sulla chiave di sottoscrizione a livello di servizio, all-access per attivare la funzionalità di debug nel gateway di Gestione API.

Modificare la richiesta HTTP nell'editor in base allo scenario di test. Fare quindi clic su Invia richiesta per inviare la richiesta di test al gateway di Gestione API.

inviare una richiesta di test

Criteri di debug

Dopo l'invio della richiesta HTTP di test, l'estensione aprirà la finestra di debug che mostra i criteri effettivi di questa operazione e si arresterà al primo criterio effettivo.

criteri di debug

Per seguire la pipeline dei criteri, è possibile eseguire un unico passaggio tra singoli criteri o impostare un punto di interruzione in un criterio e passare direttamente a tale criterio.

Nel pannello variabili è possibile esaminare i valori delle variabili create dal sistema e create dall'utente. Nel pannello punti di interruzione è possibile visualizzare l'elenco di tutti i punti di interruzione impostati. Nel pannello stack di chiamate è possibile visualizzare l'ambito dei criteri effettivo corrente.

Se si verifica un errore durante l'esecuzione dei criteri, verranno visualizzati i dettagli dell'errore nel criterio in cui si è verificato.

exceptions

Suggerimento

Ricordarsi di uscire dalla sessione di debug facendo clic sul pulsante Arresta al termine.

Passaggi successivi