Sdílet prostřednictvím

Šablony produktů ve službě Azure API Management

Azure API Management umožňuje přizpůsobit obsah stránek portálu pro vývojáře pomocí sady šablon, které konfigurují jejich obsah. Pomocí syntaxe DotLiquid a editoru podle vašeho výběru, například prostřednictvím DotLiquid pro návrhářea zadané sady lokalizovaných prostředků řetězcových prostředků, grafických prostředkůa ovládacích prvků stránky, máte velkou flexibilitu pro konfiguraci obsahu stránek podle potřeby pomocí těchto šablon.

Šablony v této části umožňují přizpůsobit obsah stránek produktu na portálu pro vývojáře.

Poznámka:

Ukázkové výchozí šablony jsou součástí následující dokumentace, ale kvůli průběžným vylepšením se můžou změnit. Živé výchozí šablony můžete zobrazit na portálu pro vývojáře tak, že přejdete na požadované jednotlivé šablony. Další informace o práci se šablonami najdete v tématu Jak přizpůsobit portál pro vývojáře služby API Management pomocí šablon.

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

Seznam produktů

Šablona Seznam produktů umožňuje přizpůsobit text stránky seznamu produktů na portálu pro vývojáře.

seznam produktů

Výchozí šablona

<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>

Ovládání

Šablona Product list může používat následující ovládací prvky stránky .

Datový model

Vlastnictví Typ Popis
Stránkování stránkování entity. Údaje o stránkování pro kolekci produktů.
Filtrování Filtrování entita. Informace o filtrování pro stránku se seznamem produktů
Produkty Kolekce objektů Product Produkty viditelné aktuálnímu uživateli.

Ukázková šablona dat

{  
    "Paging": {  
        "Page": 1,  
        "PageSize": 10,  
        "TotalItemCount": 2,  
        "ShowAll": false,  
        "PageCount": 1  
    },  
    "Filtering": {  
        "Pattern": null,  
        "Placeholder": "Search products"  
    },  
    "Products": [  
        {  
            "Id": "56f9445ffaf7560049060001",  
            "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": "56f9445ffaf7560049060002",  
            "Title": "Unlimited",  
            "Description": "Subscribers have completely unlimited access to the API. Administrator approval is required.",  
            "Terms": null,  
            "ProductState": 1,  
            "AllowMultipleSubscriptions": false,  
            "MultipleSubscriptionsCount": 1  
        }  
    ]  
}

Výrobek

Šablona Product umožňuje přizpůsobit text stránky produktu na portálu pro vývojáře.

na stránce produktu portálu pro vývojáře

Výchozí šablona

<h2>{{Product.Title}}</h2>  
<p>{{Product.Description}}</p>  
  
{% assign replaceString0 = '{0}' %}  
  
{% if Limits and Limits.size > 0 %}  
<h3>{% localized "ProductDetailsStrings|WebProductsUsageLimitsHeader"%}</h3>  
<ul>  
  {% for limit in Limits %}  
  <li>{{limit.DisplayName}}</li>  
  {% endfor %}  
</ul>  
{% endif %}  
  
{% if apis.size > 0 %}  
<p>  
  <b>  
    {% if apis.size == 1 %}  
    {% capture apisCountText %}{% localized "ProductDetailsStrings|TextblockSingleApisCount" %}{% endcapture %}  
    {% else %}  
    {% capture apisCountText %}{% localized "ProductDetailsStrings|TextblockMultipleApisCount" %}{% endcapture %}  
    {% endif %}  
  
    {% capture apisCount %}{{apis.size}}{% endcapture %}  
    {{ apisCountText | replace : replaceString0, apisCount }}  
  </b>  
</p>  
  
<ul>  
  {% for api in Apis %}  
  <li>  
    <a href="/docs/services/{{api.Id}}">{{api.Name}}</a>  
  </li>  
  {% endfor %}  
</ul>  
{% endif %}  
  
{% if subscriptions.size > 0 %}  
<p>  
  <b>  
    {% if subscriptions.size == 1 %}  
    {% capture subscriptionsCountText %}{% localized "ProductDetailsStrings|TextblockSingleSubscriptionsCount" %}{% endcapture %}  
    {% else %}  
    {% capture subscriptionsCountText %}{% localized "ProductDetailsStrings|TextblockMultipleSubscriptionsCount" %}{% endcapture %}  
    {% endif %}  
  
    {% capture subscriptionsCount %}{{subscriptions.size}}{% endcapture %}  
    {{ subscriptionsCountText | replace : replaceString0, subscriptionsCount }}  
  </b>  
</p>  
  
<ul>  
  {% for subscription in subscriptions %}  
  <li>  
    <a href="/developer#{{subscription.Id}}">{{subscription.DisplayName}}</a>  
  </li>  
  {% endfor %}  
</ul>  
{% endif %}  
{% if CannotAddBecauseSubscriptionNumberLimitReached %}  
<b>{% localized "ProductDetailsStrings|TextblockSubscriptionLimitReached" %}</b>  
{% elsif CannotAddBecauseMultipleSubscriptionsNotAllowed == false %}  
<subscribe-button></subscribe-button>  
{% endif %}

Ovládání

Šablona Product list může používat následující ovládací prvky stránky .

Datový model

Vlastnictví Typ Popis
Výrobek produkt Zadaný produkt.
JeVývojářPřihlášenSepřihlásit Boolean Určuje, jestli je aktuální uživatel přihlášen k odběru tohoto produktu.
Stav Předplatného číslo Stav předplatného. Možné stavy jsou:

- 0 - suspended – předplatné je zablokované a odběratel nemůže volat žádná rozhraní API produktu.
- 1 - active – předplatné je aktivní.
- 2 - expired – předplatné dosáhlo data vypršení platnosti a bylo deaktivováno.
- 3 - submitted – žádost o předplatné udělal vývojář, ale ještě nebyla schválena nebo odmítnuta.
- 4 - rejected – žádost o předplatné zamítl správce.
- 5 - cancelled – předplatné zrušil vývojář nebo správce.
Omezení pole Tato vlastnost je zastaralá a neměla by se používat.
Povolené delegované předplatné Boolean Určuje, jestli je pro toto předplatné povolené delegování.
DelegatedSubscriptionUrl řetězec Pokud je delegování povolené, adresa URL delegovaného předplatného.
Souhlaseno Boolean Pokud má produkt podmínky, zda aktuální uživatel souhlasil s podmínkami.
Předplatná Kolekce entit Souhrn předplatného. Předplatná produktu.
Rozhraní API Kolekce entit API Rozhraní API tohoto produktu.
Nelze přidat, protože byl dosažen limit počtu předplatných. Boolean Jestli má aktuální uživatel nárok na přihlášení k odběru tohoto produktu, pokud jde o limit předplatného.
Nelze přidat, protože nejsou povoleny více předplatná. Boolean Jestli má aktuální uživatel nárok na přihlášení k odběru tohoto produktu, pokud jde o povolení více předplatných, nebo ne.

Ukázková šablona dat

{  
    "Product": {  
        "Id": "56f9445ffaf7560049060001",  
        "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  
    },  
    "IsDeveloperSubscribed": true,  
    "SubscriptionState": 1,  
    "Limits": [],  
    "DelegatedSubscriptionEnabled": false,  
    "DelegatedSubscriptionUrl": null,  
    "IsAgreed": false,  
    "Subscriptions": [  
        {  
            "Id": "56f9445ffaf7560049070001",  
            "DisplayName": "Starter  (default)"  
        }  
    ],  
    "Apis": [  
        {  
            "id": "56f9445ffaf7560049040001",  
            "name": "Echo API",  
            "description": null,  
            "serviceUrl": "http://echoapi.cloudapp.net/api",  
            "path": "echo",  
            "protocols": [  
                2  
            ],  
            "authenticationSettings": null,  
            "subscriptionKeyParameterNames": null  
        }  
    ],  
    "CannotAddBecauseSubscriptionNumberLimitReached": false,  
    "CannotAddBecauseMultipleSubscriptionsNotAllowed": true  
}

Další kroky

Další informace o práci se šablonami najdete v tématu Jak přizpůsobit portál pro vývojáře služby API Management pomocí šablon.

  • Last updated on