Sdílet prostřednictvím

Vytváření, pochopení a ladění zásad služby Azure API Management v editoru Visual Studio Code

PLATÍ PRO: Všechny úrovně služby správy rozhraní API

Tento článek vysvětluje, jak pomocí rozšíření Azure API Management pro Visual Studio Code vytvářet, pochopit a ladit zásady služby Azure API Management pomocí AI pomocí GitHub Copilotu pro Azure.

Zásady služby Azure API Management jsou posloupnost příkazů, které řeší průřezové otázky, jako je ověřování, autorizace, omezování, ukládání do mezipaměti a transformace, použité u požadavků rozhraní API nebo odpovědí.

Požadavky

Omezení a limity

  • Ladění zásad se v současné době podporuje jenom na úrovni Developer služby API Management.

  • Ladění zásad používá vestavěné (na úrovni služby) předplatné s neomezeným přístupem (zobrazovaný název "Vestavěné předplatné s neomezeným přístupem"). Abyste mohli toto předplatné používat, musíte být vlastníkem služby.

Vytvoření zásady pomocí GitHub Copilotu pro Azure

Rozšíření Azure API Management se integruje s GitHub Copilotem pro Azure, které vám pomůže vytvořit koncept zásad. Pomocí AI můžete vytvářet a upravovat zásady uživatelsky přívětivým způsobem.

Vytvoření zásady:

  1. Otevřete rozšíření API Management v editoru Visual Studio Code.

  2. Vyberte instanci služby API Management, se kterou chcete pracovat.

  3. Vyberte rozsah zásad, se kterým chcete pracovat.

    • Pokud chcete vytvořit zásadu, která se vztahuje na všechna rozhraní API v instanci, vyberte Globální zásady.
    • Pokud chcete vytvořit zásadu, která se vztahuje na konkrétní rozhraní API, v části Rozhraní API vyberte rozhraní API a pak vyberte Zásady.
    • Pokud chcete vytvořit zásadu, která se vztahuje na konkrétní operaci rozhraní API, vyberte operaci a pak vyberte Zásady.

  4. Otevřete chat.

  5. V okně Chat zadejte výzvu k vytvoření zásady v přirozeném jazyce. Examples:

    @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 vygeneruje koncept zásad v okně Chat. Pokud chcete, aby Copilot změnil výstup, můžete ho upřesnit.

  7. Až budete připravení, vyberte tlačítko Kopírovat a zkopírujte zásadu do schránky. Pokud chcete zásadu vložit v okně editoru, vyberte Použít v Editoru . Pokud jste spokojení se změnou v souboru XML zásad, vyberte Zachovat.

Tip

V okně Problémy vyhledejte vysvětlení všech problémů v XML zásad.

Vysvětlení zásad pomocí GitHub Copilotu pro Azure

Copilot může pomoct vysvětlit existující zásady v instanci služby API Management.

Vysvětlení získáte tak, že:

  1. Otevřete rozšíření API Management v editoru Visual Studio Code.

  2. Vyberte instanci služby API Management, se kterou chcete pracovat.

  3. Vyberte rozsah zásad, se kterým chcete pracovat.

    • Pokud chcete vysvětlit zásadu, která se vztahuje na všechna rozhraní API v instanci, vyberte Globální zásady.
    • Pokud chcete vysvětlit zásadu, která se vztahuje na konkrétní rozhraní API, v části Rozhraní API vyberte rozhraní API a pak vyberte Zásady.
    • Pokud chcete vysvětlit zásadu, která se vztahuje na konkrétní operaci rozhraní API, vyberte operaci a pak vyberte Zásady.

  4. V okně editoru zásad, které se zobrazí, klikněte pravým tlačítkem myši a vyberte Vysvětlit.

  5. V okně Chat se vygeneruje přehled a vysvětlení zásad v dokumentu XML zásad.

Ladit zásady pomocí rozšíření Visual Studio Code

Rozšíření Azure API Management pro Visual Studio Code poskytuje možnosti ladění, které umožňuje procházet kanál zásad nebo nastavit zarážku při odesílání požadavku do brány.

Zahájení ladicí relace

  1. Otevřete rozšíření API Management v editoru Visual Studio Code.
  2. Vyberte instanci služby API Management ke ladění.
  3. Vyberte rozhraní API a operaci pro ladění.
  4. Klikněte pravým tlačítkem myši na operaci a vyberte Spustit ladění politiky.

V tomto okamžiku rozšíření začne navazovat ladicí relaci s bránou SLUŽBY API Management. Zkontrolujte průběh v okně Ladicí konzoly.

Snímek obrazovky při zahájení relace ladění zásad v editoru Visual Studio Code

Poznámka:

Spuštění ladicí relace také umožňuje trasování požadavků po dobu trvání relace, které vám pomůžou diagnostikovat a řešit problémy.

Odeslání testovací žádosti

Jakmile je relace ladění navázána, rozšíření REST Client otevře nový editor, který umožňuje vytvořit a odeslat testovací požadavek HTTP k bráně.

Hlavička Ocp-Apim-Debug se do požadavku přidá automaticky. 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 klikněte na Odeslat požadavek a odešlete testovací požadavek do brány služby API Management.

Snímek obrazovky s odesláním testovací žádosti v editoru Visual Studio Code

Ladění zásad

Po odeslání testovacího požadavku HTTP rozšíření otevře okno ladění, ve kterém se zobrazí efektivní zásady této operace a zastaví se na první efektivní zásadě.

Snímek obrazovky s oknem ladění v editoru Visual Studio Code

Pokud chcete sledovat řetězec zásad, můžete jednotlivé zásady procházet postupně nebo nastavit zarážku u určité zásady a přejít přímo na ni.

  • Na panelu Proměnné zkontrolujte hodnoty systémově vytvořených a uživatelem vytvořených proměnných.
  • Na panelu Zarážky zobrazte seznam všech nastavených zarážek.
  • Na panelu Zásobník volání zobrazte současný účinný rozsah 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.

Ukončete ladění kliknutím na tlačítko Zastavit, až budete hotovi.

Snímek obrazovky s výjimkou pravidla ve Visual Studio Code

Tip

Pokud chcete zkontrolovat trasování požadavku, vyberte hodnotu Ocp-Apim-Trace-Location hlavičky zadané v odpovědi HTTP.

Související obsah

  • Last updated on