Ladění zásad služby Azure API Management v editoru Visual Studio Code

  • Článek

PLATÍ PRO: Vývojář

Zásady ve službě Azure API Management poskytují výkonné funkce, které pomáhají vydavatelům rozhraní API řešit průřezové otázky, jako je ověřování, autorizace, omezování, ukládání do mezipaměti a transformace. Zásady představují kolekci příkazů, které se postupně provádí na základě požadavku nebo odezvy z rozhraní API.

Tento článek popisuje, jak ladit zásady služby API Management s využitím rozšíření služby Azure API Management pro Visual Studio Code.

Požadavky

Omezení a limity

  • Tato funkce používá k ladění integrované předplatné (na úrovni služby) s přístupem (zobrazovaný název "Předdefinované předplatné s přístupem pro celý přístup").

Důležité

  • Api Management už nepodporuje předplatná pro trasování nebo hlavičku Ocp-Apim-Trace .
  • Pokud chcete zlepšit zabezpečení rozhraní API, můžete teď trasování povolit na úrovni jednotlivých rozhraní API získáním časově omezeného tokenu pomocí rozhraní REST API služby API Management a předáním tokenu v požadavku na bránu. Podrobnosti najdete v tématu Povolení trasování rozhraní API.
  • Při povolování trasování je potřeba dbát na to, jak může v datech trasování vystavit citlivé informace. Ujistěte se, že máte k ochraně dat trasování zavedená vhodná bezpečnostní opatření.

Zahájení ladicí relace

  1. Spusťte Visual Studio Code
  2. Přejděte do rozšíření API Management v části Rozšíření Azure.
  3. Vyhledání instance služby API Management pro ladění
  4. Vyhledání rozhraní API a operace pro ladění
  5. Klikněte pravým tlačítkem myši na operaci a vyberte Spustit ladění zásad.

V tomto okamžiku se rozšíření pokusí zahájit a vytvořit ladicí relaci s bránou služby API Management.

inicializovat ladění

Odeslání testovací žádosti

Po vytvoření relace ladění otevře rozšíření nový editor, který nám umožní vytvořit a odeslat testovací požadavek HTTP této operaci s využitím rozšíření REST Client.

Všimněte si, že hlavička Ocp-Apim-Debug již byla do požadavku přidána. Tato hlavička je povinná a hodnota musí být nastavená na klíč předplatného s přístupem na úrovni služby, aby se aktivovaly funkce ladění v bráně služby API Management.

Upravte požadavek HTTP v editoru podle vašeho testovacího scénáře. Potom kliknutím na odeslat požadavek odešlete testovací požadavek do brány služby API Management.

odeslání testovací žádosti

Ladění zásad

Po odeslání testovacího požadavku HTTP rozšíření otevře okno ladění zobrazující efektivní zásady této operace a zastaví první efektivní zásady.

ladění zásad

Pokud chcete postupovat podle kanálu zásad, můžete jednotlivé zásady procházet jednotlivými zásadami nebo nastavit zarážku u zásady a krok přímo na tuto zásadu.

Na panelu Proměnné můžete zkontrolovat hodnoty systémově vytvořených a uživatelem vytvořených proměnných. Na panelu Zarážky můžete zobrazit seznam všech nastavených zarážek. Na panelu Zásobník volání uvidíte aktuální efektivní obor zásad.

Pokud během provádění zásad dojde k chybě, zobrazí se podrobnosti o chybě v zásadách, kde k ní došlo.

výjimky

Tip

Po dokončení nezapomeňte ukončit ladicí relaci kliknutím na tlačítko Zastavit .

Další kroky