Sdílet prostřednictvím

Přizpůsobení vývojářského portálu služby Azure API Management pomocí šablon

Portál pro vývojáře ve službě Azure API Management můžete přizpůsobit třemi základními způsoby:

Šablony slouží k přizpůsobení obsahu systémově generovaných stránek portálu pro vývojáře (například dokumentace k rozhraní API, produkty, ověřování uživatelů atd.). Pomocí DotLiquid syntaxe a poskytnuté sady lokalizovaných řetězcových prostředků, ikon a ovládacích prvků stránek máte skvělou flexibilitu při konfiguraci obsahu stránek podle vlastních představ.

Poznámka:

Následující obsah dokumentace se týká zastaralého portálu pro vývojáře. Můžete ji dál používat jako obvykle do jejího vyřazení z provozu v říjnu 2023, kdy se odebere ze všech služeb API Management. Zastaralý portál bude dostávat pouze důležité aktualizace zabezpečení. Další podrobnosti najdete v následujících článcích:

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

Přehled šablon portálu pro vývojáře

Úpravy šablon se provádějí na portálu pro vývojáře při přihlášení jako správce. Nejdřív otevřete Azure Portal a klikněte na portál pro vývojáře na panelu nástrojů služby vaší instance služby API Management.

Chcete-li získat přístup k šabloně portálu pro vývojáře, kliknutím na ikonu přizpůsobení na levé straně zobrazte nabídku přizpůsobení a klikněte na Šablony.

Snímek obrazovky se zvýrazněnou ikonou přizpůsobení pro zobrazení nabídky přizpůsobení

V seznamu šablon se zobrazí několik kategorií šablon, které pokrývají různé stránky na portálu pro vývojáře. Každá šablona je jiná, ale postup, jak je upravit a publikovat změny, jsou stejné. Pokud chcete šablonu upravit, klikněte na název šablony.

šablony portálu pro vývojáře

Kliknutím na šablonu přejdete na stránku portálu pro vývojáře, která je přizpůsobitelná danou šablonou. V tomto příkladu se zobrazí šablona seznamu produktů. Šablona Seznam produktů řídí oblast obrazovky označenou červeným obdélníkem.

šablona seznamu produktů

Některé šablony, jako jsou šablony uživatelského profilu a šablony, přizpůsobují různé části stejné stránky.

šablon profilů uživatelů

Editor pro každou šablonu portálu pro vývojáře má v dolní části stránky dva oddíly. Na levé straně se zobrazí podokno pro úpravy šablony a na pravé straně se zobrazí datový model šablony.

Podokno pro úpravy šablony obsahuje značky, které řídí vzhled a chování odpovídající stránky na portálu pro vývojáře. Kód v šabloně používá syntaxi DotLiquid. Jedním z oblíbených editorů pro DotLiquid je DotLiquid pro návrháře. Všechny změny šablony provedené během úprav se v prohlížeči zobrazí v reálném čase, ale nebudou viditelné pro vaše zákazníky, dokud neuložíte a publikujete šablonu.

značky šablony

Podokno Data šablony poskytuje průvodce datovým modelem pro entity, které jsou k dispozici pro použití v konkrétní šabloně. Tento průvodce poskytuje zobrazením živých dat, která se aktuálně zobrazují na portálu pro vývojáře. Podokna šablon můžete rozbalit kliknutím na obdélník v pravém horním rohu podokna Šablona dat.

datový model šablony

V předchozím příkladu se na portálu pro vývojáře zobrazují dva produkty, které byly načteny z dat zobrazených v podokně Šablony, jak je znázorněno v následujícím příkladu:

{
    "Paging": {
        "Page": 1,
        "PageSize": 10,
        "TotalItemCount": 2,
        "ShowAll": false,
        "PageCount": 1
    },
    "Filtering": {
        "Pattern": null,
        "Placeholder": "Search products"
    },
    "Products": [
        {
            "Id": "56ec64c380ed850042060001",
            "Title": "Starter",
            "Description": "Subscribers will be able to run 5 calls/minute up to a maximum of 100 calls/week.",
            "Terms": "",
            "ProductState": 1,
            "AllowMultipleSubscriptions": false,
            "MultipleSubscriptionsCount": 1
        },
        {
            "Id": "56ec64c380ed850042060002",
            "Title": "Unlimited",
            "Description": "Subscribers have completely unlimited access to the API. Administrator approval is required.",
            "Terms": null,
            "ProductState": 1,
            "AllowMultipleSubscriptions": false,
            "MultipleSubscriptionsCount": 1
        }
    ]
}

Značení v šabloně zpracovává data tak, aby poskytlo požadovaný výstup iterací přes kolekci produktů pro zobrazení informací a odkazu na každý jednotlivý produkt. Všimněte si <search-control> a <page-control> prvků v kódu. Tyto ovládací prvky řídí zobrazení ovládacích prvků vyhledávání a stránkování na stránce. ProductsStrings|PageTitleProducts je lokalizovaný odkaz na řetězec, který obsahuje text záhlaví h2 stránky. Seznam řetězcových prostředků, ovládacích prvků stránek a ikon dostupných pro použití v šablonách portálu pro vývojáře najdete v referenčních informacích k šablonám portálu pro vývojáře služby API Management.

<search-control></search-control>
<div class="row">
    <div class="col-md-9">
        <h2>{% localized "ProductsStrings|PageTitleProducts" %}</h2>
    </div>
</div>
<div class="row">
    <div class="col-md-12">
    {% if products.size > 0 %}
    <ul class="list-unstyled">
    {% for product in products %}
        <li>
            <h3><a href="/products/{{product.id}}">{{product.title}}</a></h3>
            {{product.description}}
        </li>
    {% endfor %}
    </ul>
    <paging-control></paging-control>
    {% else %}
    {% localized "CommonResources|NoItemsToDisplay" %}
    {% endif %}
    </div>
</div>

Uložení šablony

Pokud chcete šablonu uložit, klikněte v editoru šablon na uložit.

Uložit šablonu

Uložené změny nejsou na portálu pro vývojáře aktivní, dokud nebudou publikovány.

Publikování šablony

Uložené šablony je možné publikovat jednotlivě nebo společně. Pokud chcete publikovat jednotlivé šablony, klikněte v editoru šablon na publikovat.

Publikovat šablonu

Kliknutím na Ano potvrďte a vytvořte šablonu na portálu pro vývojáře.

Snímek obrazovky, který ukazuje, kde vyberete Ano, aby byla šablona aktivní.

Pokud chcete publikovat všechny aktuálně nepublikované verze šablon, klikněte v seznamu šablon na Publikovat. Nepublikované šablony jsou označené hvězdičkou za názvem šablony. V tomto příkladu se publikují šablony Seznam produktů a Produkt.

Publikovat šablony

Kliknutím na Publikovat vlastní nastavení potvrďte.

Potvrdit publikování

Nově publikované šablony se okamžitě projeví na portálu pro vývojáře.

Vrácení šablony k předchozí verzi

Pokud chcete vrátit šablonu na předchozí publikovanou verzi, klikněte v editoru šablon na tlačítko Zpět.

Snímek obrazovky se zvýrazněnou ikonou, kterou používáte k vrácení šablony.

Kliknutím na Ano potvrďte.

Snímek obrazovky, který ukazuje, kde vyberete Ano, potvrďte změny.

Po dokončení operace vrácení se na portálu pro vývojáře živě nachází dříve publikovaná verze šablony.

Obnovení šablony do výchozí verze

Obnovení šablon do výchozí verze je dvoustupňový proces. Nejprve je nutné obnovit šablony a potom musí být obnovené verze publikovány.

Pokud chcete obnovit jednu šablonu do výchozí verze, klikněte v editoru šablon na obnovit.

vrátit zpět šablonu

Kliknutím na Ano potvrďte.

Potvrdit

Pokud chcete obnovit všechny šablony do výchozích verzí, klikněte na Obnovit výchozí šablony v seznamu šablon.

Obnovit šablony

Obnovené šablony pak musí být publikovány jednotlivě nebo všechny najednou pomocí kroků v Chcete-li publikovat šablonu.

Další kroky

Referenční informace o šablonách portálu pro vývojáře, řetězcových prostředcích, ikonách a ovládacích prvcích stránek najdete v referenčních informacích k šablonám portálu pro vývojáře služby API Management.

  • Last updated on