Fouten opsporen in Azure API Management-beleid in Visual Studio Code
VAN TOEPASSING OP: Ontwikkelaar
Beleidsregels in Azure API Management bieden krachtige mogelijkheden waarmee API-uitgevers kruislingse problemen kunnen aanpakken, zoals verificatie, autorisatie, beperking, caching en transformatie. Beleidsregels zijn een verzameling instructies die sequentieel worden uitgevoerd op de aanvraag of het antwoord van een API.
In dit artikel wordt beschreven hoe u fouten kunt opsporen in API Management-beleid met behulp van de Azure API Management-extensie voor Visual Studio Code.
Vereisten
Maak eerst een instantie van API Management Developer-tier door deze quickstart te volgen.
Installeer Visual Studio Code en de nieuwste versie van de Azure API Management-extensie voor Visual Studio Code.
Importeer een API in uw API Management-exemplaar. Zie bijvoorbeeld de zelfstudie: De API Management-extensie voor Visual Studio Code gebruiken om API's te importeren en te beheren.
Beperkingen en limieten
- Deze functie maakt gebruik van het ingebouwde (serviceniveau) abonnement voor alle toegang (weergavenaam 'Ingebouwd abonnement voor alle toegang') voor foutopsporing.
Belangrijk
- API Management ondersteunt geen abonnementen meer voor tracering of de Ocp-Apim-Trace-header .
- Om de API-beveiliging te verbeteren, kan tracering nu worden ingeschakeld op het niveau van een afzonderlijke API door een tijdsgebonden token te verkrijgen met behulp van de API Management REST API en het token door te geven in een aanvraag aan de gateway. Zie Tracering van een API inschakelen voor meer informatie.
- Zorg ervoor dat bij het inschakelen van tracering gevoelige informatie wordt weergegeven in de traceringsgegevens. Zorg ervoor dat u over de juiste beveiligingsmaatregelen beschikt om de traceringsgegevens te beveiligen.
Een foutopsporingssessie starten
- Visual Studio Code starten
- Navigeer naar de API Management-extensie onder Azure-extensies
- Het API Management-exemplaar zoeken om fouten op te sporen
- De API en bewerking zoeken om fouten op te sporen
- Klik met de rechtermuisknop op de bewerking en selecteer Beleidsopsporing starten
Op dit moment probeert de extensie een foutopsporingssessie met de API Management-gateway te starten en tot stand te brengen.
Een testaanvraag verzenden
Wanneer de foutopsporingssessie tot stand is gebracht, opent de extensie een nieuwe editor waarmee we een HTTP-testaanvraag kunnen maken en verzenden naar deze bewerking met behulp van de REST Client-extensie.
U ziet dat de header Ocp-Apim-Debug al aan de aanvraag is toegevoegd. Deze header is vereist en de waarde moet worden ingesteld op de abonnementssleutel op serviceniveau voor alle toegang om de functionaliteit voor foutopsporing in de API Management-gateway te activeren.
Wijzig de HTTP-aanvraag in de editor volgens uw testscenario. Klik vervolgens op Aanvraag verzenden om de testaanvraag naar de API Management-gateway te verzenden.
Fouten opsporen in beleid
Nadat de HTTP-testaanvraag is verzonden, opent de extensie het foutopsporingsvenster met het effectieve beleid van deze bewerking en stopt deze bij het eerste effectieve beleid.
Als u de beleidspijplijn wilt volgen, kunt u afzonderlijke beleidsregels één stap doorlopen of een onderbrekingspunt instellen op een beleid en rechtstreeks naar dat beleid gaan.
In het deelvenster Variabelen kunt u waarden controleren van door het systeem gemaakte en door de gebruiker gemaakte variabelen. In het deelvenster Onderbrekingspunten ziet u de lijst met alle onderbrekingspunten die zijn ingesteld. In het deelvenster Oproepstack ziet u het huidige effectieve beleidsbereik.
Als er een fout optreedt tijdens het uitvoeren van het beleid, ziet u de details van de fout in het beleid waar deze is opgetreden.
Tip
Vergeet niet om de foutopsporingssessie af te sluiten door op de knop Stoppen te klikken wanneer u klaar bent.
Volgende stappen
- Meer informatie over de API Management-extensie voor Visual Studio Code.
- Problemen melden in de GitHub-opslagplaats