Kurz: Přístup k portálu pro vývojáře a jeho přizpůsobení

Portál pro vývojáře je automaticky vygenerovaný, plně přizpůsobitelný web s dokumentací k vašim rozhraním API. Je to místo, kde spotřebiteli rozhraní API mohou zjistit vaše rozhraní API, zjistit, jak je používat a požádat o přístup.

V tomto kurzu se naučíte:

Další podrobnosti najdete na portálu pro vývojáře v přehledu portálu azure API Management pro vývojáře.

Požadavky

• Projděte si následující rychlý start: Vytvoření instance služby Azure API Management
• Importujte a publikujte instanci API Management Azure. Další informace najdete v tématu Import a publikování.

Dostupnost

Přístup k portálu jako správce

Pokud chcete získat přístup ke spravované verzi portálu, postupujte podle následujících kroků.

1. V Azure Portalpřejděte k vaší API Management instance.
2. V horním navigačním panelu vyberte tlačítko Portál pro vývojáře. Otevře se nová karta prohlížeče s portálem pro správu.

Koncepty architektury portálu pro vývojáře

Komponenty portálu je možné logicky rozdělit do dvou kategorií: kód a obsah.

Kód

Kód se udržuje na API Management vývojářského GitHub úložiště a zahrnuje:

• Widgety – představují vizuální prvky a kombinují HTML, JavaScript, schopnost stylů, nastavení a mapování obsahu. Příkladem může být obrázek, textový odstavec, formulář, seznam rozhraní API atd.
• Definice stylů – určete, jak lze styl widgetů nastavit.
• Modul , který generuje statické webové stránky z obsahu portálu a je napsaný v JavaScriptu
• Vizuální editor – umožňuje přizpůsobení a vytváření obsahu v prohlížeči.

Content

Obsah je rozdělený do dvou podkategorií: obsah portálu a API Management obsah.

Obsah portálu je specifický pro portál a zahrnuje:

• Stránky – například vstupní stránka, kurzy k rozhraní API, blogové příspěvky

• Média – obrázky, animace a další obsah založený na souboru

• Rozložení – šablony, které se shodují s adresou URL a definují způsob zobrazení stránek

• Styly – hodnoty pro definice stylů, jako jsou písma, barvy, ohraničení

• Nastavení – konfigurace, jako je například suicon, metadata webu

  Obsah portálu s výjimkou médií se vyjadřuje jako dokumenty JSON.

API Management obsah zahrnuje entity, jako jsou rozhraní API, operace, produkty a předplatná.

Principy rozhraní pro správu portálu

Výchozí obsah

Pokud k portálu přistupujete poprvé, výchozí obsah se automaticky zřuje na pozadí. Výchozí obsah byl navržen tak, aby přednášal možnosti portálu a minimalizoval přizpůsobení potřebná k přizpůsobení portálu. Další informace o tom, co je součástí obsahu portálu, najdete v přehledu portálu azure API Management pro vývojáře.

Editor vizuálů

Obsah portálu můžete přizpůsobit pomocí editoru vizuálů.

• Oddíly nabídek na levé straně umožňují vytvářet nebo upravovat stránky, média, rozložení, nabídky, styly nebo nastavení webu.
• Položky nabídky v dolní části umožňují přepínat mezi zobrazeními (například mobilní nebo desktopové), zobrazit prvky portálu viditelné ověřeným nebo anonymním uživatelům nebo uložit nebo vrátit zpět akce.
• Kliknutím na modrou ikonu se znaménkem plus přidejte řádky na stránku.
• Widgety (například text, obrázky nebo seznam rozhraní API) je možné přidat stisknutím šedé ikony se znaménkem plus.
• Přeuspořádejte položky na stránce pomocí interakce přetažení.

Rozložení a stránky

Rozložení definují, jak se zobrazují stránky. Například ve výchozím obsahu existují dvě rozložení: jedno platí pro domovskou stránku a druhé pro všechny zbývající stránky.

Rozložení se na stránku použije tak, že se šablona její adresy URL shoduje s adresou URL stránky. Například rozložení se šablonou adresy URL se použije na každou stránku s /wiki/* /wiki/ segmentem v adrese URL: /wiki/getting-started , /wiki/styles atd.

Na předchozím obrázku je obsah patřící do rozložení označený modře, zatímco stránka je označená červeně. Oddíly nabídek jsou označené v uvedeném pořadí.

Průvodce styly

Průvodce stylů je panel vytvořený s myslem návrhářů. Umožňuje dohlížet na všechny vizuální prvky na portálu a vytvářet jejich styly. Styl je hierarchický – mnoho prvků dědí vlastnosti z jiných prvků. Například prvky tlačítka používají barvy pro text a pozadí. Pokud chcete změnit barvu tlačítka, musíte změnit původní variantu barvy.

Pokud chcete upravit variantu, vyberte ji a vyberte ikonu tužky, která se zobrazí nad ní. Po provedení změn v automaticky otevíraně otevřeném okně je zavřete.

Tlačítko Uložit

Kdykoli na portálu něco změníte, musíte ho uložit ručně tak, že v dolní nabídce vyberete tlačítko Uložit nebo stisknete [Ctrl]+[S]. Když změny uložíte, upravený obsah se automaticky nahraje do vaší API Management služby.

Přizpůsobení obsahu portálu

Než portál zpřednostníte návštěvníkům, měli byste si automaticky vygenerovaný obsah přizpůsobit. Mezi doporučené změny patří rozložení, styly a obsah domovské stránky.

Domovská stránka

Výchozí domovská stránka je vyplněná zástupným obsahem. Můžete buď odebrat celé oddíly obsahující tento obsah, nebo zachovat strukturu a jednotlivé prvky upravit. Nahraďte vygenerovaný text a obrázky vlastním textem a ujistěte se, že odkazy odkazují na požadovaná umístění. Strukturu a obsah domovské stránky můžete upravit pomocí:

• Přetažení prvků stránky do požadovaného umístění v lokalitě.
• Výběr textových prvků a elementů nadpisů pro úpravu a formátování obsahu
• Ověření, že tlačítka odkazují na pravou lokalitu

Rozložení

Nahraďte automaticky vygenerované logo na navigačním panelu vlastním obrázkem.

1. Na portálu pro vývojáře vyberte v levém horním rohu navigačního panelu výchozí logo Contoso.
2. Vyberte ikonu Upravit.
3. V části Main (Hlavní) vyberte Source (Zdroj).
4. V místní nabídce Média vyberte:
   • Obrázek, který jste už nahráli do knihovny, nebo
   • Upload k nahrání nového obrázového souboru, který se má použít, nebo
   • Pomocí loga vyberte Žádné a z forego.
5. Logo se aktualizuje v reálném čase.
6. Výběrem mimo automaticky otevíraná okna ukončete knihovnu médií.
7. Klikněte na Uložit.

Použití stylů

I když nemusíte upravovat žádné styly, můžete zvážit úpravu konkrétních prvků. Můžete například změnit primární barvu tak, aby odpovídala barvě vaší značky. To můžete provést dvěma způsoby:

Celkový styl webu

1. Na portálu pro vývojáře vyberte v levém panelu nástrojů ikonu Styly.
2. V části Barvy vyberte položku barevného stylu, kterou chcete upravit.
3. Klikněte na ikonu Upravit pro tuto položku stylu.
4. Vyberte barvu z výběru barev nebo zadejte šestnáctový kód barvy.
5. Kliknutím na Přidat barvu přidejte a pojmete další položku barvy.
6. Klikněte na Uložit.

Styl kontejneru

1. Na hlavní stránce portálu pro vývojáře vyberte pozadí kontejneru.
2. Klikněte na ikonu Upravit.
3. V místní nabídce nastavte:
   • Pozadí, které se má vymazat, obrázek, konkrétní barva nebo přechod.
   • Velikost kontejneru, okraj a odsazení.
   • Pozice a výška kontejneru.
4. Výběrem mimo automaticky otevíraná okna ukončete nastavení kontejneru.
5. Klikněte na Uložit.

Příklad přizpůsobení

V následujícím videu si ukážeme, jak upravit obsah portálu, přizpůsobit vzhled webu a publikovat změny.

Publikování portálu

Pokud chcete, aby byl portál a jeho nejnovější změny dostupné návštěvníkům, musíte ho publikovat. Portál můžete publikovat v rámci rozhraní pro správu portálu nebo z Azure Portal.

Publikování z rozhraní pro správu

1. Výběrem ikony Uložit se ujistěte, že jste změny uložili.

2. V části Operations (Operace) nabídky vyberte Publish website (Publikovat web). Tato operace může trvat několik minut.

   

Publikování z Azure Portal

1. V Azure Portalpřejděte na svou instanci API Management.

2. V nabídce vlevo v části Portál pro vývojáře vyberte Přehled portálu.

3. V okně přehledu portálu vyberte Publikovat.

   

Navštivte publikovaný portál.

Po publikování portálu k portálu můžete přistupovat na stejné adrese URL jako panel pro správu, například https://contoso-api.developer.azure-api.net . Podívejte se na něj v samostatné relaci prohlížeče (pomocí anonymního nebo privátního režimu procházení) jako externí návštěvník.

Použití zásad CORS u rozhraní API

Pokud chcete návštěvníkům na portálu umožnit testování rozhraní API prostřednictvím integrované interaktivní konzoly, povolte v rozhraních API CORS (sdílení prostředků mezi zdroji). Podrobnosti najdete v nejčastějších dotazech k portálu Azure API Management Developer Portal.

Další kroky

Další informace o portálu pro vývojáře:

• Přehled vývojářského portálu pro službu Azure API Management
• Migrujte na nový portál pro vývojáře z zastaralého starší verze portálu.