Sdílet prostřednictvím


Šablony stránek 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í DotLiquid syntaxe a editoru podle vašeho výběru, jako je například DotLiquid for Designers, a zadanou sadu lokalizovaných prostředků řetězců, prostředků glyfůa ovládacích prvků stránek, máte velkou volnost při konfiguraci obsahu stránek podle vlastních představ pomocí těchto šablon.

Šablony v této části umožňují přizpůsobit obsah přihlášení, registrace a stránky, které nebyly nalezeny 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

Přihlásit se

Šablona přihlášení umožňuje přizpůsobit přihlašovací stránku na portálu pro vývojáře.

Přihlašovací stránka

Výchozí šablona

<h2 class="text-center">{% localized "SigninStrings|WebAuthenticationSigninTitle" %}</h2>  
{% if registrationEnabled == true %}  
<p class="text-center">{% localized "SigninStrings|WebAuthenticationNotAMember" %}</p>  
{% endif %}  
  
<div class="row center-block ap-idp-container">  
  <div class="col-md-6">  
    {% if registrationEnabled == true %}  
        <p>{% localized "SigninStrings|WebAuthenticationSigininWithPassword" %}</p>  
    <basic-SignIn></basic-SignIn>  
    {% endif %}  
  </div>  
  
    {% if registrationEnabled != true and providers.size == 0 %}  
        {% localized "ProviderInfoStrings|TextboxExternalIdentitiesDisabled" %}  
  {% else %}  
        {% if providers.size > 0 %}  
      <div class="col-md-6">  
            <div class="providers-list">  
                <p class="text-left">  
                {% if registrationEnabled == true %}  
                    {% localized "ProviderInfoStrings|TextboxExternalIdentitiesSigninInvitation" %}  
                {% else %}  
                    {% localized "ProviderInfoStrings|TextboxExternalIdentitiesSigninInvitationPrimary" %}  
                {% endif %}  
                </p>  
        <providers></providers>  
            </div>  
    </div>  
        {% endif %}  
    {% endif %}  
  
  {% if userRegistrationTermsEnabled == true %}  
    <div class="col-md-6">  
        <div id="terms" class="modal" role="dialog" tabindex="-1">  
            <div class="modal-dialog">  
                <div class="modal-content">  
                    <div class="modal-header">  
                        <h4 class="modal-title">{% localized "SigninResources|DialogHeadingTermsOfUse" %}</h4>  
                    </div>  
                    <div class="modal-body break-all">{{userRegistrationTerms}}</div>  
                    <div class="modal-footer">  
                        <button type="button" class="btn btn-default" data-dismiss="modal">{% localized "CommonStrings|ButtonLabelClose" %}</button>  
                    </div>  
                </div>  
            </div>  
        </div>  
        <p>{% localized "SigninResources|TextblockUserRegistrationTermsProvided" %}</p>  
    </div>  
    {% endif %}  
</div>  

Ovládání

Tato šablona může používat následující ovládací prvky stránky .

Datový model

Přihlášení uživatelské entity.

Šablona ukázkových dat

{
    "Email": null,
    "Password": null,
    "ReturnUrl": null,
    "RememberMe": false,
    "RegistrationEnabled": true,
    "DelegationEnabled": false,
    "DelegationUrl": null,
    "SsoSignUpUrl": null,
    "AuxServiceUrl": "https://portal.azure.com/#resource/subscriptions/{subscription ID}/resourceGroups/Api-Default-West-US/providers/Microsoft.ApiManagement/service/contoso5",
    "Providers": [  
        {  
            "Properties": {  
                "AuthenticationType": "Aad",  
                "Caption": "Azure Active Directory"  
            },  
            "AuthenticationType": "Aad",  
            "Caption": "Azure Active Directory"  
        }  
        ],
    "UserRegistrationTerms": null,
    "UserRegistrationTermsEnabled": false
}

Zaregistrovat se

Šablona registrace umožňuje přizpůsobit registrační stránku na portálu pro vývojáře.

registrační stránka

Výchozí šablona

<h2 class="text-center">{% localized "SignupStrings|PageTitleSignup" %}</h2>  
<p class="text-center">  
  {% localized "SignupStrings|WebAuthenticationAlreadyAMember" %} <a href="/signin">{% localized "SignupStrings|WebAuthenticationSigninNow" %}</a>  
</p>  
  
<div class="row center-block ap-idp-container">  
  <div class="col-md-6">  
    <p>{% localized "SignupStrings|WebAuthenticationCreateNewAccount" %}</p>  
    <sign-up></sign-up>  
  </div>  
</div>  

Ovládání

Tato šablona může používat následující ovládací prvky stránky .

Datový model

Zaregistrování uživatele entity.

Šablona ukázkových dat

{  
    "PasswordConfirm": null,  
    "Password": null,  
    "PasswordVerdictLevel": 0,  
    "UserRegistrationTerms": null,  
    "UserRegistrationTermsOptions": 0,  
    "ConsentAccepted": false,  
    "Email": null,  
    "FirstName": null,  
    "LastName": null,  
    "UserData": null,  
    "NameIdentifier": null,  
    "ProviderName": null  
}  

Stránka nebyla nalezena.

Šablona pro stránku nenalezeno umožňuje přizpůsobit stránku nenalezeno na portálu pro vývojáře.

stránka nenalezena

Výchozí šablona

<h2>{% localized "NotFoundStrings|PageTitleNotFound" %}</h2>  
  
<h3>{% localized "NotFoundStrings|TitlePotentialCause" %}</h3>  
<ul>  
  <li>{% localized "NotFoundStrings|TextblockPotentialCauseOldLink" %}</li>  
  <li>{% localized "NotFoundStrings|TextblockPotentialCauseMisspelledUrl" %}</li>  
</ul>  
  
<h3>{% localized "NotFoundStrings|TitlePotentialSolution" %}</h3>  
<ul>  
  <li>{% localized "NotFoundStrings|TextblockPotentialSolutionRetype" %}</li>  
  <li>  
    {% capture textPotentialSolutionStartOver %}{% localized "NotFoundStrings|TextblockPotentialSolutionStartOver" %}{% endcapture %}  
    {% capture homeLink %}<a href="/">{% localized "NotFoundStrings|LinkLabelHomePage" %}</a>{% endcapture %}  
    {% assign replaceString = '{0}' %}  
  
    {{ textPotentialSolutionStartOver | replace : replaceString, homeLink }}  
  </li>  
</ul>  
  
<p>  
  {% capture textReportProblem %}{% localized "NotFoundStrings|TextReportProblem" %}{% endcapture %}  
  {% capture emailLink %}<a href="mailto:apimgmt@microsoft.com" target="_self" title="API Management Support">{% localized "NotFoundStrings|LinkLabelSendUsEmail" %}</a>{% endcapture %}  
  {% assign replaceString = '{0}' %}  
  
  {{ textReportProblem | replace : replaceString, emailLink }}  
</p>  

Ovládání

Tato šablona nesmí používat žádné ovládací prvky stránky .

Datový model

Vlastnictví Typ Popis
referenční kód řetězec Kód vygenerovaný, pokud byla tato stránka zobrazena jako výsledek vnitřní chyby.
kód chyby řetězec Kód vygenerovaný, pokud byla tato stránka zobrazena jako výsledek vnitřní chyby.
emailBody řetězec Text e-mailu vygenerovaný, pokud se tato stránka zobrazila jako výsledek vnitřní chyby.
požadovaná URL řetězec Adresa URL požadovaná, když nebyla stránka nalezena.
odkazující URL řetězec Adresa URL odkazujícího na požadovanou adresu URL.

Šablona ukázkových dat

{  
    "referenceCode": null,  
    "errorCode": null,  
    "emailBody": null,  
    "requestedUrl": "https://contoso5.portal.azure-api.net:443/NotFoundPage?startEditTemplate=NotFoundPage",  
    "referrerUrl": "https://contoso5.portal.azure-api.net/signup?startEditTemplate=SignUpTemplate"  
}  

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.