Zjištění služby API Management

Dokončeno

Služba API Management poskytuje základní funkce, které zajišťují úspěšný program rozhraní API prostřednictvím zapojení vývojářů, obchodních přehledů, analýz, zabezpečení a ochrany. Každé rozhraní API se skládá z jedné nebo několika operací a každé rozhraní API můžete přidat do jednoho nebo více produktů. Pokud chcete použít rozhraní API, vývojáři se přihlásí k odběru produktu, který toto rozhraní API obsahuje, a pak můžou volat operaci rozhraní API, a to v závislosti na zásadách použití, které se můžou projevit.

Komponenty služby API Management

Azure API Management se skládá z brány rozhraní API, roviny správy a portálu pro vývojáře. Tyto komponenty jsou ve výchozím nastavení hostované v Azure a plně spravované. Api Management je k dispozici v různých úrovních , které se liší v kapacitě a funkcích.

  • Brána rozhraní API je koncovým bodem, který plní následující úkoly:

    • Přijímá volání rozhraní API a směruje je do příslušných back-endů.
    • Ověřuje klíče rozhraní API a další přihlašovací údaje prezentované požadavky.
    • Vynucuje kvóty využití a omezení četnosti.
    • Transformuje požadavky a odpovědi zadané v prohlášeních zásad.
    • Ukládá odpovědi do mezipaměti za účelem zlepšení latence odpovědi a minimalizace zatížení back-endových služeb.
    • Generuje protokoly, metriky a trasování pro monitorování, vytváření sestav a řešení potíží.
  • Rovina správy je rozhraní pro správu, ve kterém jste nastavili program rozhraní API. Použijte ji k následujícím akcím:

    • Zřízení a konfigurace nastavení služby API Management
    • Definování nebo import schématu rozhraní API
    • Zabalení rozhraní API do produktů
    • Nastavení zásad, jako jsou kvóty nebo transformace v rozhraních API
    • Získání přehledů z analýz
    • Spravovat uživatele
  • Portál pro vývojáře je automaticky generovaný plně přizpůsobitelný web s dokumentací vašich rozhraní API. Vývojáři můžou pomocí portálu pro vývojáře:

    • Dokumentace k rozhraní API pro čtení
    • Volání rozhraní API prostřednictvím interaktivní konzoly
    • Vytvoření účtu a přihlášení k odběru získání klíčů rozhraní API
    • Přístup k analýzám vlastního využití
    • Stažení definic rozhraní API
    • Správa klíčů API

Produkty

Rozhraní API se k vývojářům dostávají prostřednictvím produktů. Produkty v API Management mají jedno nebo několik rozhraní API a mají nakonfigurovaný název, popis a podmínky použití. Produkty můžou být otevřené nebo chráněné. V případě chráněných produktů se musíte nejdřív přihlásit k jejich odběru a až potom je můžete používat. Otevřené produkty můžete používat bez předplatného. Schválení předplatného se konfiguruje na úrovni produktu a může vyžadovat schválení správce nebo automatické schválení.

Skupiny

Ke správě viditelnosti produktů pro vývojáře se používají skupiny. Služba API Management má následující neměnné systémové skupiny:

  • Správci – Spravují instance služby API Management a vytvářejí rozhraní API, operace a produkty, které používají vývojáři. Správci předplatného Azure jsou členy této skupiny.
  • Vývojáři – Ověření uživatelé portálu pro vývojáře, kteří vytvářejí aplikace pomocí vašich rozhraní API. Vývojáři mají přístup k portálu pro vývojáře a vytvářejí aplikace, které volají operace rozhraní API.
  • Hosté – neověřené uživatele portálu pro vývojáře Může jim být udělen určitý přístup jen pro čtení, například možnost zobrazit rozhraní API, ale ne volat je.

Kromě těchto systémových skupin mohou správci vytvářet vlastní skupiny nebo používat externí skupiny v přidružených tenantech Microsoft Entra.

Vývojáři

Vývojáři představují uživatelské účty v instanci služby API Management. Vývojáře můžou vytvořit nebo pozvat správci, nebo se můžou sami zaregistrovat na portálu pro vývojáře. Každý vývojář je členem jedné nebo několika skupin a může se přihlásit k odběru produktů, které jsou pro tyto skupiny viditelné.

Zásady

Zásady představují kolekci příkazů, které se postupně provádí na základě požadavku nebo odezvy z rozhraní API. Mezi oblíbené příkazy patří převod formátu XML do formátu JSON a omezení četnosti volání, kterým omezíte počet příchozích volání od vývojáře. K dispozici je i mnoho dalších zásad.

Výrazy zásad můžete použít jako hodnoty atributů nebo textové hodnoty v libovolných zásadách API Management (pokud zásady neurčí jinak). Některé zásady, například řízení toku a nastavená proměnná, jsou založené na výrazech zásad.

Zásady se dají použít v různých oborech v závislosti na vašich potřebách: globální (všechna rozhraní API), produkt, konkrétní rozhraní API nebo operace rozhraní API.