Azure API Management-szabályzatok létrehozása, értelmezése és hibakeresése a Visual Studio Code-ban

Alkalmazható minden API Management-szintre

Ez a cikk bemutatja, hogyan használhatja a Azure API Management bővítményt Visual Studio Code API Management-szabályzatok létrehozásához, megértéséhez és hibakereséséhez. A bővítmény integrálva van a GitHub Copilot for Azure-ral a szabályzatok kidolgozásának és magyarázatának elősegítésére.

A Azure API Management policy olyan utasítások sorozata, amelyek az API-kérelmekre vagy válaszokra alkalmazott horizontális problémákat kezelik. Ilyenek például a hitelesítés, az engedélyezés, a korlátozás, a gyorsítótárazás és az átalakítás.

Előfeltételek

Korlátozások és korlátozottságok

  • A szabályzatok hibakeresése jelenleg csak az API Management fejlesztői szintjén támogatott.

  • A szabályzatok hibakeresése a beépített (szolgáltatásszintű) teljes hozzáférésű előfizetést használja, amelynek megjelenítendő neve Beépített teljes hozzáférésű előfizetés. Az előfizetés használatához szolgáltatástulajdonosnak kell lennie.

Szabályzat létrehozása az Azure-hoz készült GitHub Copilot használatával

Az Azure API Management bővítmény integrálható az Azure-hoz készült GitHub Copilottal, hogy segítsen létrehozni egy szabályzattervezetet. AI-támogatással felhasználóbarát módon hozhat létre és szerkeszthet szabályzatokat.

Szabályzat létrehozása:

  1. Nyissa meg az API Management bővítményt a Visual Studio Code-ban.

  2. Válassza ki a használni kívánt API Management-példányt.

  3. Válassza ki a használni kívánt szabályzat hatókörét.

    • Ha olyan szabályzatot szeretne létrehozni, amely a példány összes API-ra vonatkozik, válassza a Globális házirend lehetőséget.
    • Ha egy adott API-ra vonatkozó szabályzatot szeretne létrehozni, az API-k alatt válassza ki az API-t, majd válassza a Szabályzat lehetőséget.
    • Ha egy adott API-műveletre vonatkozó szabályzatot szeretne létrehozni, jelölje ki a műveletet, majd válassza a Szabályzat lehetőséget.

  4. Nyissa meg a Csevegést.

  5. A Csevegés ablakban írjon be egy természetes nyelvű kérést egy szabályzat létrehozásához. 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

    A Copilot létrehoz egy szabályzattervezetet a Csevegés ablakban. Finomíthatja a kérést, ha azt szeretné, hogy a Copilot módosítsa a kimenetet.

  6. Ha elkészült, a Másolás gombra kattintva másolja a szabályzatot a vágólapra, vagy a Szerkesztőben az Alkalmaz gombra kattintva szúrja be a szabályzatot a szerkesztőablakba. Ha elégedett a szabályzat XML-fájljának módosításával, válassza a Keep ( Megtartás) lehetőséget.

Tipp.

A szabályzat XML-fájljában található problémák magyarázatát a Problémák ablakban tekinthet meg.

Szabályzat ismertetése az Azure-hoz készült GitHub Copilot használatával

A Copilot segíthet elmagyarázni egy meglévő szabályzatot az API Management-példányban.

Magyarázat fogadása:

  1. Nyissa meg az API Management bővítményt a Visual Studio Code-ban.

  2. Válassza ki a használni kívánt API Management-példányt.

  3. Válassza ki a használni kívánt szabályzat hatókörét.

    • A példány összes API-jának ismertetéséhez válassza a Globális házirend lehetőséget.
    • Egy adott API-ra vonatkozó szabályzat magyarázatához az API-k alatt válassza ki az API-t, majd válassza a Szabályzat lehetőséget.
    • Egy adott API-műveletre vonatkozó szabályzat magyarázatához válassza ki a műveletet, majd válassza a Szabályzat lehetőséget.

  4. A megjelenő szabályzatszerkesztő ablakban kattintson a jobb gombbal, majd válassza a Magyarázat lehetőséget.

  5. A házirend XML-dokumentumában található szabályzatok áttekintése és magyarázata a Csevegés ablakban jön létre.

Szabályzatok hibakeresése a VS Code-bővítmény használatával

A Visual Studio Code Azure API Management bővítménye hibakeresési felületet biztosít, amely lehetővé teszi, hogy végiglépkedjen a szabályzatfolyamaton, vagy töréspontot állítson be, amikor kérést küld az átjárónak.

Hibakeresési munkamenet kezdeményezése

  1. Nyissa meg az API Management bővítményt a Visual Studio Code-ban.
  2. Válassza ki a hibakereséshez az API Management-példányt.
  3. Válassza ki a hibakereséshez szükséges API-t és műveletet.
  4. Kattintson a jobb gombbal a műveletre, és válassza a Házirend-hibakeresés indítása parancsot.

A bővítmény egy hibakeresési munkamenetet kezd létrehozni az API Management-átjáróval. Ellenőrizze a hibakeresési konzol ablakának állapotát.

Képernyőkép, ha házirend-hibakeresési munkamenetet kezdeményez a Visual Studio Code-ban.

Megjegyzés:

A hibakeresési munkamenet indítása lehetővé teszi a kérések nyomon követését is a munkamenet során, hogy segítsen a problémák diagnosztizálásában és megoldásában.

Tesztkérelem küldése

A hibakeresési munkamenet létrehozásakor a REST-ügyfél bővítmény egy új szerkesztőt nyit meg, amely lehetővé teszi egy teszt HTTP-kérés létrehozását és elküldését az átjárónak.

Az Ocp-Apim-Debug fejléc automatikusan hozzáadódik a kéréshez. Ez a fejléc szükséges, és az értéket a szolgáltatásszintű, teljes hozzáférésű előfizetési kulcsra kell állítani az API Management-átjáró hibakeresési funkciójának aktiválásához.

Módosítsa a HTTP-kérést a szerkesztőben a tesztforgatókönyvnek megfelelően. Ezután válassza a Kérés küldése lehetőséget a tesztkérelem API Management-átjárónak való elküldéséhez.

Képernyőkép egy tesztkérelem Visual Studio Code-ban való küldéséről.

Hibakeresési szabályzatok

A HTTP-tesztkérelem elküldése után a bővítmény megnyitja a hibakeresési ablakot, amely megjeleníti a művelet hatályos szabályzatait, és az első érvényes szabályzatnál leáll.

A Visual Studio Code hibakeresési ablakának képernyőképe.

A szabályzatfolyamat követéséhez egyetlen lépéssel végigléphet az egyes szabályzatokon, vagy beállíthat egy töréspontot egy szabályzatban, és közvetlenül erre a szabályzatra léphet.

  • A Változók panelen vizsgálja meg a rendszer által létrehozott és a felhasználó által létrehozott változók értékeit.
  • A Töréspontok panelen tekintse meg az összes beállított töréspont listáját.
  • A Hívásverem panelen tekintheti meg a szabályzat aktuálisan érvényes hatókörét.

Ha hiba történik a szabályzat végrehajtása során, a hiba részleteit abban a szabályzatban láthatja, ahol az történt.

A hibakeresési munkamenetből való kilépéshez válassza a Leállítás lehetőséget.

Képernyőkép a Visual Studio Code egy szabályzatkivételéről.

Tipp.

A kérelem nyomkövetésének áttekintéséhez válassza ki a Ocp-Apim-Trace-Location HTTP-válaszban megadott fejléc értékét.

Kapcsolódó tartalom

  • További információ a Visual Studio CodeAPI Management bővítményéről>
  • Problémák jelentése a GitHub-adattárban
  • Last updated on