Migreren naar de nieuwe ontwikkelaarsportal

  • Artikel

In dit artikel worden de stappen beschreven die u moet uitvoeren om te migreren van de afgeschafte verouderde portal naar de nieuwe ontwikkelaarsportal in API Management.

Belangrijk

De verouderde ontwikkelaarsportal is nu afgeschaft en ontvangt alleen beveiligingsupdates. U kunt deze zoals gebruikelijk blijven gebruiken tot de buitengebruikstelling in oktober 2023, wanneer de portal wordt verwijderd uit alle API Management Services.

API Management ontwikkelaarsportal

Beschikbaarheid

Belangrijk

Deze functie is beschikbaar in de Premium-, Standard-, Basic- en Developer-lagen van API Management.

Zie het overzicht van v2-lagen voor de beschikbaarheid van functies in de v2-lagen (preview).

Verbeteringen in de nieuwe ontwikkelaarsportal

De nieuwe ontwikkelaarsportal biedt een oplossing voor veel beperkingen van de afgeschafte portal. Het beschikt over een visuele editor voor slepen en neerzetten voor het bewerken van inhoud en een speciaal paneel voor ontwerpers om de website te stylen. Pagina's, aanpassingen en configuratie worden opgeslagen als Azure Resource Manager-resources in uw API Management-service, waarmee u portalimplementaties kunt automatiseren. Ten slotte is de codebasis van de portal opensource, zodat u deze kunt uitbreiden met aangepaste functionaliteit.

Migreren naar de nieuwe ontwikkelaarsportal

De nieuwe ontwikkelaarsportal is niet compatibel met de afgeschafte portal en geautomatiseerde migratie is niet mogelijk. U moet de inhoud (pagina's, tekst, mediabestanden) opnieuw handmatig maken en het uiterlijk van de nieuwe portal aanpassen. De exacte stappen zijn afhankelijk van de aanpassingen en complexiteit van uw portal. Raadpleeg de zelfstudie over de ontwikkelaarsportal voor hulp. De resterende configuratie, zoals de lijst met API's, producten, gebruikers en id-providers, wordt automatisch gedeeld tussen beide portals.

Belangrijk

Als u de nieuwe ontwikkelaarsportal eerder hebt gestart, maar u geen wijzigingen hebt aangebracht, stelt u de standaardinhoud opnieuw in om deze bij te werken naar de nieuwste versie.

Wanneer u migreert vanuit de afgeschafte portal, moet u rekening houden met de volgende wijzigingen:

  • Als u uw ontwikkelaarsportal beschikbaar maakt via een aangepast domein, wijst u een domein toe aan de nieuwe ontwikkelaarsportal. Gebruik de optie Ontwikkelaarsportal in de vervolgkeuzelijst in de Azure Portal.

  • Pas cors-beleid toe op uw API's om de interactieve testconsole in te schakelen.

  • Als u aangepaste CSS in de portal gebruikt, moet u de stijl repliceren met behulp van het ingebouwde ontwerpvenster. CSS-injectie is niet toegestaan in de nieuwe portal.

  • U kunt aangepaste JavaScript alleen in de zelf-hostende versie van de nieuwe portal invoeren.

  • Als uw API Management zich in een virtueel netwerk bevindt en via Application Gateway wordt blootgesteld aan internet, raadpleegt u dit documentatieartikel voor nauwkeurige configuratiestappen. Moet u:

    • Schakel connectiviteit met het beheereindpunt van de API Management in.
    • Schakel connectiviteit met het nieuwe portaleindpunt in.
    • Geselecteerde Web Application Firewall-regels uitschakelen.

  • Als u de standaardsjablonen voor e-mailmeldingen hebt gewijzigd om een expliciet gedefinieerde afgeschafte portal-URL op te nemen, wijzigt u deze in de parameter portal-URL of verwijst u naar de nieuwe portal-URL. Als de sjablonen in plaats daarvan de ingebouwde portal-URL-parameter gebruiken, zijn er geen wijzigingen vereist.

  • Problemen en toepassingen worden niet ondersteund in de nieuwe ontwikkelaarsportal.

  • Directe integratie met Facebook, Microsoft, Twitter en Google als id-providers wordt niet ondersteund in de nieuwe ontwikkelaarsportal. U kunt met deze providers integreren via Azure AD B2C.

  • Als u delegatie gebruikt, wijzigt u de retour-URL in uw toepassingen en gebruikt u het API-eindpunt Voor gedeelde toegangstoken ophalen in plaats van het eindpunt SSO-URL genereren.

  • Als u Microsoft Entra id als id-provider gebruikt:

    • Wijzig de retour-URL in uw toepassing zodat deze verwijst naar het nieuwe domein van de ontwikkelaarsportal.
    • Wijzig het achtervoegsel van de retour-URL in uw toepassing van /signin-aad in /signin.

  • Als u Azure AD B2C als id-provider gebruikt:

    • Wijzig de retour-URL in uw toepassing zodat deze verwijst naar het nieuwe domein van de ontwikkelaarsportal.
    • Wijzig het achtervoegsel van de retour-URL in uw toepassing van /signin-aad in /signin.
    • Neem voornaam, achternaam en object-id van de gebruiker op in de toepassingsclaims.

  • Als u OAuth 2.0 gebruikt in de interactieve testconsole, wijzigt u de retour-URL in uw toepassing zodat deze verwijst naar het nieuwe domein van de ontwikkelaarsportal en wijzigt u het achtervoegsel:

    • Van /docs/services/[serverName]/console/oauth2/authorizationcode/callback naar /signin-oauth/code/callback/[serverName] voor de stroom voor het verlenen van autorisatiecodes.
    • Van /docs/services/[serverName]/console/oauth2/implicit/callback naar /signin-oauth/implicit/callback voor de impliciete toekenningsstroom.

  • Als u OpenID Connect gebruikt in de interactieve testconsole, wijzigt u de retour-URL in uw toepassing zodat deze verwijst naar het nieuwe domein van de ontwikkelaarsportal en wijzigt u het achtervoegsel:

    • Van /docs/services/[serverName]/console/openidconnect/authorizationcode/callback naar /signin-oauth/code/callback/[serverName] voor de stroom voor het verlenen van autorisatiecodes.
    • Van /docs/services/[serverName]/console/openidconnect/implicit/callback naar /signin-oauth/implicit/callback voor de impliciete toekenningsstroom.

Volgende stappen

Meer informatie over de ontwikkelaarsportal: