Dela via

Migrera till den nya utvecklarportalen

  • Artikel

Den här artikeln beskriver de steg du behöver vidta för att migrera från den inaktuella äldre portalen till den nya utvecklarportalen i API Management.

Viktigt

Den äldre utvecklarportalen är nu inaktuell och får endast säkerhetsuppdateringar. Du kan fortsätta att använda den som vanligt tills den dras tillbaka i oktober 2023, då den tas bort från alla API Management-tjänster.

API Management utvecklarportalen

Tillgänglighet

Viktigt

Den här funktionen är tillgänglig på nivåerna Premium, Standard, Basic och Developer för API Management.

Information om funktionstillgänglighet på v2-nivåerna (förhandsversion) finns i översikten över v2-nivåer.

Förbättringar i den nya utvecklarportalen

Den nya utvecklarportalen åtgärdar många begränsningar i den inaktuella portalen. Den har en visuell dra och släpp-redigerare för redigering av innehåll och en dedikerad panel där designers kan utforma webbplatsen. Sidor, anpassningar och konfiguration sparas som Azure-Resource Manager resurser i din API Management-tjänst, vilket gör att du kan automatisera portaldistributioner. Slutligen är portalens kodbas öppen källkod, så du kan utöka den med anpassade funktioner.

Migrera till den nya utvecklarportalen

Den nya utvecklarportalen är inkompatibel med den inaktuella portalen och automatisk migrering är inte möjlig. Du måste återskapa innehållet manuellt (sidor, text, mediefiler) och anpassa utseendet på den nya portalen. Exakta steg varierar beroende på portalens anpassningar och komplexitet. Mer information finns i självstudien om utvecklarportalen . Återstående konfiguration, till exempel listan över API:er, produkter, användare och identitetsprovidrar, delas automatiskt mellan båda portalerna.

Viktigt

Om du har startat den nya utvecklarportalen tidigare, men inte har gjort några ändringar, återställer du standardinnehållet för att uppdatera det till den senaste versionen.

Tänk på följande ändringar när du migrerar från den inaktuella portalen:

  • Om du exponerar utvecklarportalen via en anpassad domän tilldelar du en domän till den nya utvecklarportalen. Använd alternativet Utvecklarportal i listrutan i Azure Portal.

  • Tillämpa en CORS-princip på dina API:er för att aktivera den interaktiva testkonsolen.

  • Om du matar in anpassad CSS för att formatera portalen måste du replikera formatmallen med hjälp av den inbyggda designpanelen. CSS-inmatning tillåts inte i den nya portalen.

  • Du kan endast mata in anpassad JavaScript i den lokala versionen av den nya portalen.

  • Om din API Management finns i ett virtuellt nätverk och exponeras för Internet via Application Gateway läser du den här dokumentationsartikeln för exakta konfigurationssteg. Du måste:

    • Aktivera anslutning till API Management hanteringsslutpunkt.
    • Aktivera anslutning till den nya portalslutpunkten.
    • Inaktivera markerade Web Application Firewall regler.

  • Om du har ändrat standardmallarna för e-postaviseringar så att de innehåller en uttryckligen definierad inaktuell portal-URL ändrar du dem så att de antingen använder portalens URL-parameter eller pekar på den nya portal-URL:en. Om mallarna använder den inbyggda portalens URL-parameter i stället krävs inga ändringar.

  • Problem och program stöds inte i den nya utvecklarportalen.

  • Direkt integrering med Facebook, Microsoft, Twitter och Google som identitetsprovidrar stöds inte i den nya utvecklarportalen. Du kan integrera med dessa leverantörer via Azure AD B2C.

  • Om du använder delegering ändrar du retur-URL:en i dina program och använder API-slutpunkten Get Shared Access Token i stället för slutpunkten Generate SSO URL (Generera URL för enkel inloggning).

  • Om du använder Microsoft Entra-ID som identitetsprovider:

    • Ändra retur-URL:en i ditt program så att den pekar på den nya utvecklarportaldomänen.
    • Ändra suffixet för retur-URL:en i ditt program från /signin-aad till /signin.

  • Om du använder Azure AD B2C som identitetsprovider:

    • Ändra retur-URL:en i ditt program så att den pekar på den nya utvecklarportaldomänen.
    • Ändra suffixet för retur-URL:en i ditt program från /signin-aad till /signin.
    • Inkludera förnamn, efternamn och användarens objekt-ID i programanspråken.

  • Om du använder OAuth 2.0 i den interaktiva testkonsolen ändrar du retur-URL:en i ditt program så att den pekar på den nya utvecklarportaldomänen och ändrar suffixet:

    • Från /docs/services/[serverName]/console/oauth2/authorizationcode/callback till /signin-oauth/code/callback/[serverName] för beviljandeflödet för auktoriseringskoden.
    • Från /docs/services/[serverName]/console/oauth2/implicit/callback till /signin-oauth/implicit/callback för det implicita beviljandeflödet.

  • Om du använder OpenID Connect i den interaktiva testkonsolen ändrar du retur-URL:en i ditt program så att den pekar på den nya utvecklarportaldomänen och ändrar suffixet:

    • Från /docs/services/[serverName]/console/openidconnect/authorizationcode/callback till /signin-oauth/code/callback/[serverName] för beviljandeflödet för auktoriseringskoden.
    • Från /docs/services/[serverName]/console/openidconnect/implicit/callback till /signin-oauth/implicit/callback för det implicita beviljandeflödet.

Nästa steg

Läs mer om utvecklarportalen: