Kurz: Použití a přizpůsobení nového vývojářského portálu

  • Článek

PLATÍ PRO: Vývojář | Základní | Basic v2 | Standardní | Standard v2 | Premium

Portál pro vývojáře je automaticky generovaný plně přizpůsobitelný web s dokumentací vašich rozhraní API. V této lokalitě můžou uživatelé rozhraní API zjišťovat vaše rozhraní API, učit se je používat a požádat o přístup.

V tomto kurzu se naučíte:

  • Přístup ke spravované verzi portálu pro vývojáře
  • Navigace v rozhraní pro správu
  • Přizpůsobení obsahu
  • Publikování změn
  • Zobrazení publikovaného portálu

Další informace o funkcích a možnostech vývojářského portálu najdete v přehledu portálu pro vývojáře služby Azure API Management.

Snímek obrazovky s portálem pro vývojáře služby API Management – režim správce

Požadavky

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

Pokud chcete získat přístup ke spravované verzi portálu pro vývojáře, postupujte takto.

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

  2. Pokud jste instanci vytvořili na úrovni služby v2, která podporuje portál pro vývojáře, nejprve povolte portál pro vývojáře.

    1. V nabídce vlevo v části Portál pro vývojáře vyberte nastavení portálu.
    2. V okně nastavení portálu vyberte Povoleno. Zvolte Uložit.

    Povolení portálu pro vývojáře může trvat několik minut.

  3. V nabídce vlevo v části Portál pro vývojáře vyberte Přehled portálu. Pak na horním navigačním panelu vyberte tlačítko Portál pro vývojáře . Otevře se nová karta prohlížeče s verzí pro správu portálu.

Vysvětlení rozhraní pro správu portálu

Jako správce můžete obsah portálu přizpůsobit pomocí editoru vizuálů.

Snímek obrazovky s editorem vizuálů na portálu pro vývojáře

  • Pomocí možností nabídky vlevo můžete vytvářet nebo upravovat stránky, média, rozložení, nabídky, styly nebo nastavení webu.

  • Nahoře můžete přepínat mezi oblastmi zobrazení (pro obrazovky různých velikostí) nebo zobrazit prvky portálu viditelné pro uživatele v různých skupinách. Můžete například chtít zobrazit určité stránky jenom skupinám přidruženým k určitým produktům nebo uživatelům, kteří mají přístup ke konkrétním rozhraním API.

  • Uložte nebo vraťte změny, které provedete, nebo publikujte web.

Přidání obrázku do knihovny médií

Na portálu pro vývojáře budete chtít použít vlastní obrázky a další mediální obsah, abyste odráželi branding vaší organizace. Pokud obrázek, který chcete použít, ještě není v knihovně médií portálu, přidejte ho na portál pro vývojáře:

  1. V levé nabídce editoru vizuálů vyberte Multimédia.
  2. Udělejte jednu z těchto věcí:
    • Vyberte Nahrát soubor a vyberte místní soubor obrázku v počítači.
    • Vyberte Propojit soubor. Zadejte adresu URL odkazu na soubor obrázku a další podrobnosti. Pak vyberte Stáhnout.
  3. Stisknutím klávesy Zavřít ukončete knihovnu médií.

Tip

Do knihovny médií můžete také přidat obrázek přetažením přímo v okně editoru vizuálu.

Nahrazení výchozího loga na domovské stránce

V levém horním rohu navigačního panelu je k dispozici zástupné logo. Můžete ho nahradit vlastním logem tak, aby odpovídal brandingu vaší organizace.

  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 položku Upravit.
  3. V místní nabídce Obrázek v části Hlavní vyberte Zdroj.
  4. V automaticky otevíraných otevíraných oknech médií vyberte jednu z těchto možností:
    • Obrázek již nahraný v knihovně médií
    • Nahrání souboru pro nahrání nového souboru obrázku do knihovny médií
    • Žádné , pokud nechcete používat logo
  5. Logo se aktualizuje v reálném čase.
  6. Výběrem mimo automaticky otevíraná okna ukončete knihovnu médií.
  7. V horním panelu vyberte Uložit.

Úprava obsahu na domovské stránce

Výchozí domovská stránka a další stránky jsou k dispozici se zástupným textem a dalšími obrázky. Můžete buď odebrat celé oddíly obsahující tento obsah, nebo zachovat strukturu a upravit prvky o jeden po druhém. Vygenerovaný text a obrázky nahraďte vlastním textem a ujistěte se, že všechny odkazy odkazují na požadovaná umístění.

Upravte strukturu a obsah vygenerovaných stránek několika způsoby. Příklad:

  • Vyberte existující prvky textu a nadpisu a upravte a naformátujte obsah.

  • Když na stránku najedete myší na prázdnou oblast, klikněte na modrou ikonu se znaménkem plus. Vyberte si z několika rozložení oddílů.

    Snímek obrazovky znázorňující ikonu pro přidání oddílu na portálu pro vývojáře

  • Přidejte widget (například text, obrázek, vlastní widget nebo seznam rozhraní API) tak, že najedete myší na prázdnou oblast a kliknete na šedou ikonu se znaménkem plus.

    Snímek obrazovky znázorňující ikonu pro přidání widgetu na portálu pro vývojáře

  • Přeuspořádá položky na stránce přetažením.

Úprava primární barvy lokality

Pokud chcete změnit barvy, přechody, typografii, tlačítka a další prvky uživatelského rozhraní na portálu pro vývojáře, upravte styly webu. Můžete například změnit primární barvu použitou v navigačním panelu, tlačítkách a dalších prvkách tak, aby odpovídala brandingu vaší organizace.

  1. Na portálu pro vývojáře v levé nabídce editoru vizuálů vyberte Styly.
  2. V části Barvy vyberte položku stylu barvy, kterou chcete upravit. Vyberte například Primární.
  3. Vyberte Upravit barvu.
  4. Vyberte barvu z nástroje pro výběr barvy nebo zadejte šestnáctkový kód barvy.
  5. V horním panelu zvolte Uložit.

Aktualizovaná barva se použije na web v reálném čase.

Tip

Pokud chcete, přidejte a pojmenujte další barevnou položku tak, že na stránce Styly vyberete + Přidat barvu.

Změna obrázku pozadí na domovské stránce

Pozadí na domovské stránce portálu můžete změnit na obrázek nebo barvu, která odpovídá brandingu vaší organizace. Pokud jste ještě do knihovny médií nenahráli jiný obrázek, můžete ho nahrát před změnou obrázku na pozadí nebo při změně obrázku.

  1. Na domovské stránce portálu pro vývojáře klikněte v pravém horním rohu, aby byl horní oddíl zvýrazněný v rozích a zobrazila se místní nabídka.

  2. Napravo od možnosti Upravit článek v místní nabídce vyberte šipku nahoru (Přepnout na nadřazenou položku).

  3. Vyberte Upravit oddíl.

  4. V místní nabídce Oddíl vyberte v části Pozadí jednu z ikon:

    Snímek obrazovky s nastavením pozadí na portálu pro vývojáře

    • Vymazání pozadí pro odebrání obrázku pozadí
    • Obrázek na pozadí, výběr obrázku z knihovny médií nebo nahrání nového obrázku
    • Barva pozadí, výběr barvy z výběru barvy nebo vymazání barvy
    • Přechod na pozadí, výběr přechodu ze stránky stylů webu nebo vymazání přechodu

  5. V části Nastavení velikosti pozadí proveďte výběr vhodný pro vaše pozadí.

  6. V horním panelu vyberte Uložit.

Změna výchozího rozložení

Portál pro vývojáře používá rozložení k definování běžných prvků obsahu, jako jsou navigační panely a zápatí na skupinách souvisejících stránek. Každá stránka se automaticky shoduje s rozložením na základě šablony adresy URL.

Portál pro vývojáře má ve výchozím nastavení dvě rozložení:

  • Domovská stránka – používá se pro domovskou stránku (šablona /adresy URL)

  • Výchozí – používá se pro všechny ostatní stránky (šablona /*adresy URL).

Snímek obrazovky s výchozími rozloženími na portálu pro vývojáře

Rozložení libovolné stránky na portálu pro vývojáře můžete změnit a definovat nová rozložení, která se mají použít na stránky, které odpovídají jiným šablonám adres URL.

Pokud například chcete změnit logo použité v navigačním panelu výchozího rozložení tak, aby odpovídalo brandingu vaší organizace:

  1. V nabídce vlevo v editoru vizuálů vyberte Stránky.
  2. Vyberte kartu Rozložení a vyberte Výchozí.
  3. Vyberte obrázek loga v levém horním rohu a vyberte Upravit.
  4. V části Hlavní vyberte Zdroj.
  5. V automaticky otevíraných oknech Multimédia vyberte jednu z následujících možností:
    • Obrázek již nahraný v knihovně médií
    • Nahrání souboru pro nahrání nového souboru obrázku do multimediálního souboru, který můžete vybrat
    • Žádné , pokud nechcete používat logo
  6. Logo se aktualizuje v reálném čase.
  7. Výběrem mimo automaticky otevíraná okna ukončete knihovnu médií.
  8. V horním panelu vyberte Uložit.

Úpravy navigačních nabídek

Navigační nabídky v horní části stránek portálu pro vývojáře můžete upravit a změnit pořadí položek nabídky, přidat položky nebo odebrat položky. Můžete také změnit název položek nabídky a adresu URL nebo jiný obsah, na který odkazují.

Například výchozí a domovské rozložení portálu pro vývojáře zobrazují dvě nabídky uživatelům typu host na portálu pro vývojáře:

  • hlavní nabídka s odkazy na domovskou stránku, rozhraní API a produkty
  • anonymní uživatelská nabídka s odkazy na přihlašovací a registrační stránky.

Můžete je ale chtít přizpůsobit. Pokud například chcete nezávisle pozvat uživatele na váš web, můžete zakázat odkaz pro registraci v nabídce anonymního uživatele.

Snímek obrazovky s výchozími navigačními nabídkami na portálu pro vývojáře

  1. V nabídce vlevo v editoru vizuálů vyberte nabídku Web.
  2. Na levé straně rozbalte nabídku anonymního uživatele.
  3. Vyberte nastavení (ikona ozubeného kola) vedle položky Zaregistrovat se a vyberte Odstranit.
  4. Zvolte Uložit.

Upravit nastavení webu

Upravte nastavení webu portálu pro vývojáře a změňte název webu, popis a další podrobnosti.

  1. V nabídce vlevo v editoru vizuálů vyberte Nastavení.
  2. V místní nabídce Nastavení zadejte metadata webu, která chcete změnit. Volitelně můžete nastavit favicon webu z obrázku v knihovně médií.
  3. Na horním panelu uložte.

Tip

Pokud chcete změnit název domény lokality, musíte nejprve nastavit vlastní doménu v instanci služby API Management. Přečtěte si další informace o vlastních názvech domén ve službě API Management.

Publikování portálu

Pokud chcete portál a jeho nejnovější změny zpřístupnit návštěvníkům, musíte ho publikovat .

Publikování z rozhraní pro správu portálu pro vývojáře:

  1. Vyberte tlačítko Uložit a ujistěte se, že jste změny uložili.

  2. V nabídce v horní části vyberte Publikovat web. Tato operace může trvat několik minut.

    Snímek obrazovky s tlačítkem Publikovat web na portálu pro vývojáře

Tip

Další možností je publikovat web z webu Azure Portal. Na stránce přehleduportálu vaší instance služby API Management na webu Azure Portal vyberte Publikovat.

Navštivte publikovaný portál.

Pokud chcete zobrazit změny po publikování portálu, přejděte k ní na stejné adrese URL jako na panelu pro správu, například https://contoso-api.developer.azure-api.net. Můžete ho zobrazit 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 na rozhraních API

Pokud chcete návštěvníkům portálu umožnit testování rozhraní API prostřednictvím integrované interaktivní konzoly, povolte CORS (sdílení prostředků mezi zdroji) na vašich rozhraních API, pokud jste to ještě neudělali. Na stránce přehleduportálu vaší instance služby API Management na webu Azure Portal vyberte Povolit CORS. Další informace.

Další kroky

V tomto kurzu jste se naučili, jak:

  • Přístup ke spravované verzi portálu pro vývojáře
  • Navigace v rozhraní pro správu
  • Přizpůsobení obsahu
  • Publikování změn
  • Zobrazení publikovaného portálu

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

Import a správa rozhraní API pomocí editoru Visual Studio Code

Podívejte se na související obsah týkající se portálu pro vývojáře: