Produktvorlagen in Azure API Management

Azure API Management bietet Ihnen die Möglichkeit, den Inhalt von Seiten des Entwicklerportals mit einem Satz von Vorlagen anzupassen, die den Inhalt konfigurieren. Unter Verwendung dieser Vorlagen können Sie die Seiteninhalte mithilfe von DotLiquid-Syntax und dem Editor Ihrer Wahl (beispielsweise DotLiquid for Designers) sowie verschiedenen lokalisierten Zeichenfolgenressourcen, Glyph-Ressourcen und Seitensteuerelementen an Ihre Bedürfnisse anpassen.

Mit den Vorlagen in diesem Abschnitt können Sie den Inhalt der Produktseiten im Entwicklerportal anpassen.

• Produktliste

• Produkt

Hinweis

Beispielstandardvorlagen sind in der folgenden Dokumentation enthalten, können aber aufgrund von kontinuierlichen Verbesserungen geändert werden. Sie können die aktiven Standardvorlagen im Entwicklerportal anzeigen, indem Sie zu den gewünschten einzelnen Vorlagen navigieren. Weitere Informationen zum Arbeiten mit Vorlagen finden Sie unter So passen Sie das Azure API Management-Entwicklerportal mithilfe von Vorlagen an.

Hinweis

Der folgende Dokumentationsinhalt bezieht sich auf das veraltete Entwicklerportal. Sie können die Anwendung bis Oktober 2023 wie gewohnt weiterhin verwenden, daraufhin wird sie aus allen API Management-Diensten entfernt. Für das veraltete Portal werden nur kritische Sicherheitsupdates bereitgestellt. Weitere Informationen finden Sie in den folgenden Artikeln:

• Erfahren Sie, wie Sie zum neuen Entwicklerportal migrieren können
• Übersicht über das neue Azure API Management-Entwicklerportal
• Zugreifen auf das neue Entwicklerportal und Anpassen dieses Portals

GILT FÜR: Developer | Basic | Standard | Premium

Produktliste

Mit der Produktliste Vorlage können Sie den Textkörper der Produktlistenseite im Entwicklerportal anpassen.

Standardvorlage

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

Bedienelemente

In der Vorlage Product list können die folgenden Seitensteuerelemente verwendet werden.

• paging-control

• Suchsteuerelement

Datenmodell

Eigentum	Typ	BESCHREIBUNG
Auslagerung	Entität Paging.	Die Seiteninformationen für die Produktsammlung.
Filterung	Filterung Entität.	Die Filterinformationen für die Produktlistenseite.
Produkte	Sammlung von Product-Entitäten.	Die für den aktuellen Benutzer sichtbaren Produkte.

Beispieldaten für Vorlagen

{  
    "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  
        }  
    ]  
}  

Produkt

Mit der Vorlage Produkt- können Sie den Textkörper der Produktseite im Entwicklerportal anpassen.

Standardvorlage

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

Bedienelemente

In der Vorlage Product list können die folgenden Seitensteuerelemente verwendet werden.

• Schaltfläche "Abonnieren"

Datenmodell

Eigentum	Typ	BESCHREIBUNG
Produkt	Produkt	Das angegebene Produkt.
IstEntwicklerAbonniert	Boolescher Wert	Gibt an, ob der aktuelle Benutzer dieses Produkt abonniert hat.
Abonnementstatus	Zahl	Der Status des Abonnements. Mögliche Zustände: - 0 - suspended – das Abonnement wird blockiert, und der Abonnent kann keine APIs des Produkts aufrufen. - 1 - active – das Abonnement ist aktiv. - 2 - expired – das Abonnement hat das Ablaufdatum erreicht und wurde deaktiviert. - 3 - submitted – die Abonnementanforderung wurde vom Entwickler gestellt, wurde aber noch nicht genehmigt oder abgelehnt. - 4 - rejected – die Abonnementanforderung wurde von einem Administrator verweigert. - 5 - cancelled – das Abonnement wurde vom Entwickler oder Administrator storniert.
Grenzen	Array	Diese Eigenschaft ist veraltet und sollte nicht verwendet werden.
DelegierteAbonnementAktiviert	Boolescher Wert	Gibt an, ob Delegierung für dieses Abonnement aktiviert ist.
DelegierteAbonnementUrl	Schnur	Wenn die Delegierung aktiviert ist, die delegierte Abonnement-URL.
istZugestimmt	Boolescher Wert	Wenn das Produkt Bedingungen hat, ob der aktuelle Nutzer den Bedingungen zugestimmt hat.
Abonnements	Sammlung der Abonnementzusammenfassung Entitäten.	Die Abonnements für das Produkt.
Apis	Sammlung von -API--Entitäten.	Die APIs in diesem Produkt.
Hinzufügen nicht möglich, da die Abonnementanzahlgrenze erreicht wurde	Boolescher Wert	Gibt an, ob der aktuelle Benutzer berechtigt ist, dieses Produkt im Hinblick auf das Abonnementlimit zu abonnieren.
Kann nicht hinzugefügt werden, da mehrere Abonnements nicht erlaubt sind.	Boolescher Wert	Gibt an, ob der aktuelle Benutzer berechtigt ist, dieses Produkt in Bezug auf mehrere Abonnements zu abonnieren, die zulässig sind oder nicht.

Beispieldaten für Vorlagen

{  
    "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  
}  

Nächste Schritte

Weitere Informationen zum Arbeiten mit Vorlagen finden Sie unter So passen Sie das Azure API Management-Entwicklerportal mithilfe von Vorlagen an.