Sdílet prostřednictvím

Přizpůsobení portálu Centra rozhraní API

Tento článek vysvětluje nastavení, která můžete přizpůsobit na portálu API Center (Preview). Portál API Center je 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.

Pokud chcete nastavit portál API Center pro počáteční použití a přihlášení, přečtěte si téma Nastavení portálu API Center.

Poznámka:

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

Stránka nastavení portálu

Nakonfigurujte nastavení portálu API Center na webu Azure Portal. Přístup ke stránce nastavení:

  1. Na webu Azure Portal přejděte do centra rozhraní API.
  2. V části Portál centra rozhraní API vyberte Nastavení.
  3. Kliknutím na záložky můžete zobrazit a upravit nastavení.
  4. Vyberte Uložit a publikovat , aby se změny použily.

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

Důležité

Při každé změně nastavení vyberte Uložit a publikovat . Dokud změny nepublikujete, neuvidíte je na portálu API Center.

Profil webu

Na kartě Profil webu volitelně zadejte vlastní název, který se zobrazí na horním panelu publikovaného portálu.

Snímek obrazovky s vlastním názvem na portálu API Center

Viditelnost rozhraní API

Na kartě Viditelnost rozhraní API určete, která rozhraní API jsou zjistitelná (viditelná) pro uživatele portálu API Center. Nastavení viditelnosti platí pro všechny uživatele portálu API Center.

Portál API Center používá rozhraní API roviny dat Azure API Center k načtení a zobrazení rozhraní API ve vašem centru rozhraní API a ve výchozím nastavení zobrazuje všechna rozhraní API pro přihlášené uživatele s oprávněními Azure RBAC.

Pokud chcete zobrazit pouze konkrétní rozhraní API, přidejte podmínky filtru pro rozhraní API na základě předdefinovaných vlastností. Můžete například zobrazit rozhraní API pouze určitých typů (například REST nebo GraphQL) nebo na základě určitých formátů specifikace (například OpenAPI).

snímek obrazovky přidávání podmínek viditelnosti rozhraní API na portálu

Anonymní přístup

Na kartě Viditelnost rozhraní API můžete volitelně povolit anonymní přístup pro čtení k rozhraní API datové roviny Azure API Center, což umožňuje neověřeným uživatelům objevovat inventář rozhraní API prostřednictvím přímých volání rozhraní API. Toto nastavení můžete například povolit, aby rozhraní API byla zjistitelná pro neověřené uživatele, když hostujete portál Centra rozhraní API sami.

Upozornění

Při povolování anonymního přístupu dbejte na to, aby se citlivé informace nezpřístupnily v definicích nebo nastaveních rozhraní API.

Pokud je tato možnost povolená na kartě Sémantické vyhledávání , portál API Center doplňuje základní vyhledávání rozhraní API založené na názvech a sémantické vyhledávání s asistencí umělé inteligence založené na názvech rozhraní API, popisech a volitelně vlastních metadatech. Sémantické vyhledávání je k dispozici pouze v plánu Standard .

Uživatelé můžou hledat rozhraní API pomocí dotazů v přirozeném jazyce, což usnadňuje hledání rozhraní API na základě jejich záměru. Pokud například vývojář vyhledá "Potřebuji rozhraní API pro správu inventáře", portál může navrhnout relevantní rozhraní API, i když názvy nebo popisy rozhraní API neobsahují přesná slova.

Tip

Při použití bezplatného plánu Azure API Center můžete snadno upgradovat na plán Standard a povolit tak úplné funkce služeb, včetně sémantického vyhledávání na portálu API Center.

Pokud chcete při přihlášení k portálu api Center použít vyhledávání s asistencí umělé inteligence, klikněte do vyhledávacího pole, vyberte Hledat pomocí AI a zadejte dotaz.

Snímek obrazovky s sémantickými výsledky hledání na portálu Centra rozhraní API

Vlastní metadata

Na kartě Metadata volitelně vyberte vlastní vlastnosti metadat , které chcete zveřejnit v podrobnostech rozhraní API a sémantickém vyhledávání.

Povolení přístupu k testovací konzole pro rozhraní API

V centru rozhraní API můžete nakonfigurovat uživatelská nastavení pro podrobnou autorizaci přístupu k rozhraním API a jejich konkrétní verze. Nakonfigurujte například určité verze rozhraní API tak, aby používaly klíče rozhraní API pro ověřování, a vytvořte zásady přístupu, které umožňují ověřování pomocí těchto klíčů jenom konkrétním uživatelům.

Zásady přístupu platí také pro funkci Vyzkoušet toto rozhraní API pro rozhraní API na portálu API Center a zajišťují, že testovací konzolu pro tyto verze rozhraní API můžou používat jenom uživatelé portálu s příslušnými zásadami přístupu. Další informace o autorizaci přístupu k rozhraním API

Související obsah

  • Last updated on