Kurz: Ladění rozhraní API pomocí trasování požadavků

  • Článek

PLATÍ PRO: Consumption | Vývojář | Základní | Standardní | Premium

Tento kurz popisuje, jak ve službě Azure API Management kontrolovat (trasování) zpracování požadavků. Trasování pomáhá ladit a řešit potíže s rozhraním API.

V tomto kurzu se naučíte:

  • Trasování ukázkového volání
  • Kontrola kroků zpracování požadavků

Snímek obrazovky znázorňující inspektor rozhraní API

Poznámka:

Trasování požadavků rozhraní API se v současné době nepodporuje na úrovních Basic v2 a Standard v2.

Požadavky

Ověření nastavení povolit trasování

Pokud chcete trasovat zpracování žádostí, musíte povolit nastavení Povolit trasování pro předplatné použité k ladění rozhraní API. Postup vrácení se změnami na portálu:

  1. Přejděte do vaší instance služby API Management a výběrem předplatných zkontrolujte nastavení.

    Snímek obrazovky znázorňující, jak povolit trasování předplatného

  2. Pokud pro předplatné, které používáte, není povolené trasování, vyberte předplatné a povolte trasování povolit.

Upozorňující

  • Povolte trasování jenom u předplatných určených pro účely ladění. Sdílení klíčů předplatného s povoleným trasováním s neoprávněnými uživateli může vést ke zpřístupnění citlivých informací obsažených v protokolech trasování, jako jsou klíče, přístupové tokeny, hesla, interní názvy hostitelů a IP adresy.
  • V testovací konzole služba API Management automaticky zakáže trasování 1 hodinu po povolení předplatného.

Trasování volání

  1. Přihlaste se k webu Azure Portal a přejděte k vaší instanci služby API Management.

  2. Vyberte Rozhraní API.

  3. Ze seznamu rozhraní API vyberte ukázkové rozhraní API konference.

  4. Vyberte kartu Test.

  5. Vyberte operaci GetSpeakers.

  6. Volitelně můžete zkontrolovat hodnotu hlavičky Ocp-Apim-Subscription-Key použité v požadavku výběrem ikony oka.

    Tip

    Hodnotu Ocp-Apim-Subscription-Key můžete přepsat načtením klíče pro jiné předplatné na portálu. Vyberte Předplatná a otevřete místní nabídku (...) pro jiné předplatné. Vyberte Zobrazit nebo skrýt klíče a zkopírujte jeden z těchto klíčů. V případě potřeby můžete klíče znovu vygenerovat. Potom v testovací konzole vyberte + Přidat hlavičku a přidejte hlavičku Ocp-Apim-Subscription-Key s novou hodnotou klíče.

  7. Vyberte Trasování.

    • Pokud vaše předplatné ještě nepovoluje trasování, zobrazí se výzva, abyste ho povolili, pokud chcete hovor sledovat.

    • Můžete se také rozhodnout odeslat požadavek bez trasování.

      Snímek obrazovky znázorňující konfiguraci trasování rozhraní API

Kontrola informací o trasování

  1. Po dokončení volání přejděte v odpovědi HTTP na kartu Trasování.

  2. Pokud chcete přejít na podrobné informace o trasování, vyberte některý z následujících odkazů: Příchozí, Back-end, Odchozí, Při chybě.

    Kontrola trasování odpovědí

    • Příchozí – zobrazuje původní požadavek služby API Management přijatý od volajícího a zásady použité na požadavek. Pokud jste například přidali zásady v kurzu: Transformace a ochrana rozhraní API, zobrazí se tady.

    • Back-end – zobrazuje požadavky služby API Management odeslané do back-endu rozhraní API a přijatou odpověď.

    • Odchozí – zobrazuje zásady použité na odpověď před odesláním zpět volajícímu.

    • Při chybě – zobrazuje chyby, ke kterým došlo při zpracování požadavku, a zásady použité na chyby.

    Tip

    Každý krok také ukazuje uplynulý čas od přijetí požadavku službou API Management.

  3. Na kartě Zpráva se v hlavičce ocp-apim-trace-location zobrazí umístění dat trasování uložených v úložišti objektů blob v Azure. V případě potřeby přejděte do tohoto umístění a načtěte trasování. K trasovacím datům je možné přistupovat až po dobu 24 hodin.

    Umístění trasování ve službě Azure Storage

Povolení trasování pomocí hlavičky Ocp-Apim-Trace

Při provádění požadavků na službu API Management pomocí curlklienta REST, jako je Postman nebo klientská aplikace, povolte trasování přidáním následujících hlaviček požadavků:

  • Ocp-Apim-Trace – nastavení hodnoty na true
  • Ocp-Apim-Subscription-Key – nastavte hodnotu na klíč pro předplatné s povoleným trasováním, které umožňuje přístup k rozhraní API.

Odpověď obsahuje hlavičku Ocp-Apim-Trace-Location s adresou URL pro umístění dat trasování v úložišti objektů blob v Azure.

Informace o přizpůsobení informací o trasování najdete v zásadách trasování .

Další kroky

V tomto kurzu jste se naučili, jak:

  • Trasování ukázkového volání
  • Kontrola kroků zpracování požadavků

Přejděte k dalšímu kurzu:

Použití revizí