Sdílet prostřednictvím

Nastavení portálu API Center

V tomto článku se dozvíte, jak nastavit portál API Center (Preview), web spravovaný v Azure, který vývojáři a další účastníci ve vaší organizaci používají ke zjišťování rozhraní API v centru rozhraní API. Přihlášení uživatelé můžou procházet a filtrovat rozhraní API a zobrazovat podrobnosti rozhraní API, jako jsou definice rozhraní API a dokumentace. Uživatelský přístup k informacím o rozhraní API je založený na ID Microsoft Entra a řízení přístupu na základě role v Azure.

snímek obrazovky portálu API Center po přihlášení uživatele

Poznámka:

Portál API Center je aktuálně ve verzi Preview.

Návod

Azure API Management i Azure API Center poskytují prostředí portálu API pro vývojáře. Porovnání portálů

Požadavky

  • Centrum rozhraní API ve vašem předplatném Azure. Pokud jste ho ještě nevytvořili, přečtěte si článek Rychlý start: Vytvoření centra rozhraní API.

  • Oprávnění k vytvoření registrace aplikace v tenantovi Microsoft Entra přidruženém k vašemu předplatnému Azure a oprávnění k udělení přístupu k datům ve vašem centru rozhraní API.

Vytvoření registrace aplikace Microsoft Entra

Nejprve nakonfigurujte registraci aplikace v tenantovi Microsoft Entra ID. Registrace aplikace umožňuje portálu API Center přistupovat k datům z centra rozhraní API jménem přihlášeného uživatele.

Centrum API může registraci aplikace nastavit automaticky nebo můžete registraci aplikace vytvořit ručně.

Automatické nastavení registrace aplikace

Pokud chcete registraci aplikace nastavit automaticky, postupujte takto:

  1. Na webu Azure Portal přejděte do centra rozhraní API.
  2. V nabídce vlevo vyberteNastavení> API Center.
  3. Na kartě zprostředkovatele identity vyberte Zahájit nastavení.
  4. Na kartě Rychlé nastavení vyberte Uložit a publikovat.

Pokud potřebujete později získat přístup k registraci aplikace, najdete ji na portálu v části Registrace aplikací. Aplikace má následující formát: <api-center-name-apic-aad>.

Ruční nastavení registrace aplikace

Pokud chcete registraci aplikace vytvořit ručně, postupujte takto:

  1. Na webu Azure Portal přejděte do části Správaregistrací aplikací>>.

  2. Vyberte + Nová registrace.

  3. Na stránce Zaregistrovat aplikaci nastavte hodnoty následujícím způsobem:

    1. Nastavte Název na smysluplný název, například api-center-portal
    2. V části Podporované typy účtů vyberte Účty pouze v tomto adresáři organizace (<název> adresáře – jeden tenant).
    3. V URI přesměrovánívyberte jednostránkovou aplikaci (SPA) a nastavte URI. Zadejte identifikátor URI nasazení portálu API Center v následujícím formátu: https://<service-name>.portal.<location>.azure-apicenter.ms. Nahraďte <service name> a <location> názvem centra rozhraní API a umístěním, kam je nasazený, příklad: https://myapicenter.portal.eastus.azure-apicenter.ms.
    4. Vyberte Zaregistrovat.

Konfigurace dalších identifikátorů URI přesměrování pro rozšíření VS Code

Při povolování zobrazení portálu API Center v rozšíření Visual Studio Code pro api Center nakonfigurujte také následující identifikátory URI přesměrování v registraci aplikace:

  1. Na webu Azure Portal přejděte k registraci aplikace.

  2. Na stránce Spravovat>ověřování vyberte Přidat platformu a vyberte Mobilní a desktopové aplikace.

  3. Nakonfigurujte následující tři vlastní identifikátory URI přesměrování:
    https://vscode.dev/redirect
    http://localhost
    ms-appx-web://Microsoft.AAD.BrokerPlugin/<application-client-id>

    Nahraďte <application-client-id> ID klienta této aplikace. Tuto hodnotu najdete na stránce Přehled registrace aplikace.

Konfigurace a publikování portálu API Center

Po vytvoření registrace aplikace portálu API Center můžete přizpůsobit nastavení a publikovat portál služby API Center. Na webu Azure Portal proveďte následující kroky.

  1. Na webu Azure Portal přejděte do centra rozhraní API.

  2. V nabídce vlevo v části Portál centra rozhraní API vyberte Nastavení.

    snímek obrazovky s nastavením portálu API Center na webu Azure Portal

  3. Pokud registraci aplikace nastavíte ručně, vyberte na kartě Zprostředkovatel identity možnost Spustit. Pokud jste použili rychlé nastavení, tento krok je už hotový a můžete pokračovat v nastavení na dalších kartách.

    1. Na kartě Ruční zadejte id aplikace (klienta) z registrace aplikace, kterou jste vytvořili v předchozí části.
    2. Ověřte, že adresa URI přesměrování je hodnota, kterou jste nakonfigurovali v registraci aplikace.
    3. Vyberte Uložit a publikovat.

  4. Nazbývajícíchch Informace o nastavení najdete v tématu Přizpůsobení portálu API Center.

  5. Vyberte Uložit a publikovat.

Přístup k portálu

Po publikování můžete v prohlížeči získat přístup k portálu API Center.

  • Na stránce Nastavení portálu vyberte Zobrazit portál Centra rozhraní API a otevřete portál na nové kartě.
  • Nebo zadejte v prohlížeči následující adresu URL a nahraďte <service-name> a <location> názvem centra rozhraní API a umístěním, kam se nasazuje:
    https://<service-name>.portal.<location>.azure-apicenter.ms

Domovská stránka portálu je ve výchozím nastavení přístupná veřejně, ale pro přístup k rozhraním API vyžaduje přihlášení. Podrobnosti o konfiguraci přístupu uživatelů k portálu na portálu uživatelům a skupinám Microsoft Entra najdete v tématu Povolení přihlašování k portálu.

Povolení přihlášení k portálu uživateli a skupinami Microsoft Entra

Pokud chcete povolit přihlášení k portálu SLUŽBY API Center pro přístup k rozhraním API, přiřaďte uživatelům nebo skupinám ve vaší organizaci roli Čtenář dat služby Azure API Center , která je vymezená na centrum rozhraní API.

Důležité

Ve výchozím nastavení se vy a další správci centra rozhraní API musíte přihlásit, abyste měli přístup k rozhraním API na portálu API Center. Nezapomeňte přiřadit roli Čtenář dat ve službě Azure API Center sobě a dalším správcům.

Podrobné požadavky a kroky pro přiřazení role uživatelům a skupinám najdete v tématu Přiřazení rolí Azure pomocí webu Azure Portal. Stručné kroky:

  1. Na webu Azure Portal přejděte do centra rozhraní API.
  2. V nabídce vlevo vyberte Řízení přístupu (IAM)>+ Přidat přiřazení role.
  3. V podokně Přidat přiřazení role nastavte hodnoty následujícím způsobem:
    1. Na stránce Role vyhledejte a vyberte Azure API Center Data Reader. Vyberte Další.
    2. Na stránce Členové v Přiřadit přístup k vyberte Uživatel, skupina nebo instanční objekt>+ Vyberte členy.
    3. Na stránce Vyberte členy vyhledejte a vyberte uživatele nebo skupiny, ke kterému chcete roli přiřadit. Klikněte na Vybrat a pak na Další.
    4. Zkontrolujte přiřazení role a vyberte Zkontrolovat a přiřadit.

Poznámka:

Pokud chcete zjednodušit konfiguraci přístupu pro nové uživatele, doporučujeme přiřadit roli skupině Microsoft Entra a nakonfigurovat pravidlo dynamického členství ve skupině. Další informace najdete v tématu Vytvoření nebo aktualizace dynamické skupiny vMicrosoft Entra ID .

Po nakonfigurování přístupu k portálu se nakonfigurovaní uživatelé můžou přihlásit k portálu a zobrazit rozhraní API v centru rozhraní API.

Poznámka:

První uživatel, který se přihlásí k portálu, se zobrazí výzva k vyjádření souhlasu s oprávněními požadovanými registrací aplikace portálu API Center. Další nakonfigurovaní uživatelé pak nebudou vyzváni k vyjádření souhlasu.

Zjišťování a spotřeba rozhraní API na portálu API Center

Portál API Center podporuje a zjednodušuje práci vývojářů, kteří používají a vytvářejí rozhraní API ve vaší organizaci. Přihlášení uživatelé můžou:

  • Hledání rozhraní API podle názvu nebo pomocí sémantického vyhledávání s asistencí AI

  • Filtrování rozhraní API podle typu nebo fáze životního cyklu

  • Zobrazení podrobností a definic rozhraní API , včetně koncových bodů, metod, parametrů a formátů odpovědí

  • Stažení definic rozhraní API do místního počítače nebo jejich otevření v editoru Visual Studio Code

  • Vyzkoušejte rozhraní API , která podporují ověřování pomocí klíče rozhraní API nebo autorizaci OAuth 2.0.

Portály pro správu API a centrum API

Služby Azure API Management a azure API Center poskytují portály pro vývojáře ke zjišťování a využívání rozhraní API:

  • Portál pro vývojáře API Management umožňuje uživatelům najít spravovaná rozhraní API, zjistit, jak je používat, požádat o přístup a otestovat je.
  • Portál API Center (Preview) je portál s více bránami, kde můžou uživatelé zjišťovat a filtrovat kompletní inventář rozhraní API organizace.

I když tyto dva portály sdílejí některé funkce, mají také odlišné rozdíly. Následující tabulka porovnává aktuální možnosti a pomáhá určit, který portál se má použít. Některé organizace můžou preferovat jeden portál, zatímco jiné můžou potřebovat obojí.

Vlastnost Portál pro vývojáře služby API Management Portál API Center (náhled)
Vyhledávání a filtrování inventáře rozhraní API Pouze instance služby API Management Všechna rozhraní API1
Zobrazení podrobností a definic rozhraní API ✔️ ✔️
Zobrazit dokumentaci k rozhraní API ✔️ ✔️
Přizpůsobte pomocí značky ✔️ Pouze název
Integrujte se s Microsoft Entra ID ✔️ ✔️
Přidání vlastních widgetů ✔️ ❌
Přizpůsobení pomocí WordPressu ✔️ ❌
Testujte rozhraní API v testovací konzoli ✔️ ✔️
Přihlásit se k odběru rozhraní API ✔️ ❌
Zobrazení analýzy využití rozhraní API ✔️ ❌

1 portál API Center může obsahovat všechna rozhraní API ve vaší organizaci, včetně rozhraní API spravovaných ve službě Azure API Management a dalších platforem, stejně jako nespravovaných rozhraní API a rozhraní API v rámci vývoje.

Související obsah

  • Last updated on