Sdílet prostřednictvím

Migrace na nový portál pro vývojáře

Tento článek popisuje kroky potřebné k migraci z zastaralého zastaralého portálu na nový vývojářský portál ve službě API Management.

Důležité

Starší verze vývojářského portálu je nyní zastaralá a bude dostávat pouze aktualizace zabezpečení. 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.

portál pro vývojáře API Management

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

Vylepšení nového portálu pro vývojáře

Nový portál pro vývojáře řeší řadu omezení zastaralého portálu. Obsahuje vizuální nástroj pro úpravy obsahu a vyhrazený panel pro návrháře k úpravě stylu webu. Stránky, přizpůsobení a konfigurace se ve službě API Management ukládají jako prostředky Azure Resource Manageru, které vám umožní automatizovat nasazení portálu. Nakonec je základ kódu portálu opensourcový, takže ho můžete rozšířit o vlastní funkce.

Jak migrovat na nový vývojářský portál

Nový vývojářský portál není kompatibilní s zastaralým portálem a automatizovaná migrace není možná. Musíte ručně znovu vytvořit obsah (stránky, text, multimediální soubory) a přizpůsobit vzhled nového portálu. Přesné kroky se budou lišit v závislosti na přizpůsobení a složitosti portálu. Pokyny najdete v kurzu k vývojářskému portálu. Zbývající konfigurace, jako je seznam rozhraní API, produkty, uživatelé, zprostředkovatelé identit, se automaticky sdílí na obou portálech.

Důležité

Pokud jste před tím spustili nový portál pro vývojáře, ale neprovedli jste žádné změny, obnovte výchozí obsah a aktualizujte ho na nejnovější verzi.

Při migraci z zastaralého portálu mějte na paměti následující změny:

  • Pokud portál pro vývojáře zveřejníte prostřednictvím vlastní domény, přiřaďte doménu novému portálu pro vývojáře. Použijte možnost portálu pro vývojáře z rozevíracího seznamu na webu Azure Portal.

  • Aplikujte zásady CORS na vašich rozhraních API, abyste povolili interaktivní testovací konzolu.

  • Pokud do portálu vložíte vlastní šablony stylů CSS, musíte replikovat styly pomocí integrovaného návrhového panelu. Injektáž css není na novém portálu povolená.

  • Vlastní JavaScript můžete vložit pouze v samohostované verzi nového portálu.

  • Pokud je vaše služba API Management ve virtuální síti a je přístupná k internetu přes Application Gateway, najdete v tomto článku dokumentace přesné kroky konfigurace. Budete muset:

    • Povolte připojení ke koncovému bodu správy služby API Management.
    • Povolte připojení k novému koncovému bodu portálu.
    • Zakázat vybraná pravidla firewallu webových aplikací

  • Pokud jste změnili výchozí šablony e-mailových oznámení tak, aby obsahovaly explicitně definovanou zastaralou adresu URL portálu, změňte je tak, aby používaly parametr adresy URL portálu nebo odkazovaly na novou adresu URL portálu. Pokud šablony místo toho používají předdefinovaný parametr adresy URL portálu, nevyžadují se žádné změny.

  • Problémy a aplikace nejsou podporovány na novém portálu pro vývojáře.

  • Přímá integrace s Facebookem, Microsoftem, Twitterem a Googlem jako zprostředkovateli identity se na novém portálu pro vývojáře nepodporuje. S těmito poskytovateli se můžete integrovat prostřednictvím Azure AD B2C.

  • Pokud používáte delegování, změňte ve svých aplikacích zpáteční adresu URL a místo koncového bodu Vygenerovat adresu URL jednotného přihlašování použijte koncový bod rozhraní API Získat sdílený přístupový token.

  • Pokud jako zprostředkovatele identity použijete Microsoft Entra ID:

    • Změňte zpáteční adresu URL v aplikaci tak, aby odkazovat na novou doménu portálu pro vývojáře.
    • Upravte příponu návratové adresy URL v aplikaci z /signin-aad na /signin.

  • Pokud jako zprostředkovatele identity používáte Azure AD B2C:

    • Změňte zpáteční adresu URL v aplikaci tak, aby odkazovat na novou doménu portálu pro vývojáře.
    • Upravte příponu návratové adresy URL v aplikaci z /signin-aad na /signin.
    • Zahrňte dané jméno, příjmenía ID objektu uživatele do deklarací identity aplikace.

  • Pokud používáte OAuth 2.0 v interaktivní testovací konzole, změňte v aplikaci zpáteční adresu URL tak, aby odkazovat na novou doménu portálu pro vývojáře a upravte příponu:

    • Od /docs/services/[serverName]/console/oauth2/authorizationcode/callback do /signin-oauth/code/callback/[serverName] pro tok udělování autorizačního kódu.
    • Od /docs/services/[serverName]/console/oauth2/implicit/callback do /signin-oauth/implicit/callback pro implicitní proces udělení.

  • Pokud v interaktivní testovací konzole používáte OpenID Connect, změňte zpáteční adresu URL v aplikaci tak, aby odkazovat na novou doménu portálu pro vývojáře a upravte příponu:

    • Od /docs/services/[serverName]/console/openidconnect/authorizationcode/callback do /signin-oauth/code/callback/[serverName] pro tok udělování autorizačního kódu.
    • Od /docs/services/[serverName]/console/openidconnect/implicit/callback do /signin-oauth/implicit/callback pro implicitní proces udělení.

Další kroky

Další informace o portálu pro vývojáře:

  • Last updated on