Delen via

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 de v2-lagen (preview) voor de beschikbaarheid van functies in de v2-lagen.

Verbeteringen in de nieuwe ontwikkelaarsportal

De nieuwe ontwikkelaarsportal heeft betrekking op veel beperkingen van de afgeschafte portal. Het bevat een visuele slepen-en-neerzetten-editor voor het bewerken van inhoud en een speciaal paneel voor ontwerpers om de website vorm te geven. Pagina's, aanpassingen en configuratie worden opgeslagen als Azure Resource Manager-resources in uw API Management-service, waarmee u portalimplementaties kuntautomatiseren. Ten slotte is de codebasis van de portal opensource, dus 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 variëren, afhankelijk van de aanpassingen en complexiteit van uw portal. Raadpleeg de tutorial voor het ontwikkelaarsportaal voor hulp. De resterende configuratie, zoals de lijst met API's, producten, gebruikers, id-providers, wordt automatisch gedeeld in beide portals.

Belangrijk

Als u de nieuwe ontwikkelaarsportal eerder hebt gestart, maar u nog 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, een domein toewijzen aan de nieuwe ontwikkelaarsportal. Gebruik de optie Developer Portal in de vervolgkeuzelijst in Azure Portal.

  • Een CORS-beleid toepassen op uw API's om de interactieve testconsole in te schakelen.

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

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

  • Als uw API Management zich in een virtueel netwerk bevindt en beschikbaar is voor internet via Application Gateway, raadpleegt dit documentatieartikel voor nauwkeurige configuratiestappen. U moet het volgende doen:

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

  • Als u de standaardsjablonen voor e-mailmeldingen hebt gewijzigd zodat deze een expliciet gedefinieerde afgeschafte portal-URL bevatten, moet u deze aanpassen om of gebruik te maken van de portal-URL parameter, of naar de nieuwe portal-URL te verwijzen. Als de sjablonen in plaats daarvan de ingebouwde URL-parameter van de portal gebruiken, zijn er geen wijzigingen vereist.

  • Problemen en Toepassingen worden niet ondersteund in de nieuwe ontwikkelaarsportaal.

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

  • Als u delegatie gebruikt, wijzigt u de retour-URL in uw toepassingen en gebruikt u het Get Shared Access Token API endpoint in plaats van de Generate SSO URL endpoint.

  • 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, achternaamen object-id van de gebruiker op in de toepassingsclaims.

  • Als u OAuth 2.0 in de interactieve testconsole gebruikt, 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 tot /signin-oauth/code/callback/[serverName] voor de autorisatiecode-verleningsstroom.
    • Van /docs/services/[serverName]/console/oauth2/implicit/callback tot /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 tot /signin-oauth/code/callback/[serverName] voor de autorisatiecode-verlening.
    • Van /docs/services/[serverName]/console/openidconnect/implicit/callback tot /signin-oauth/implicit/callback voor de impliciete toekenningsstroom.

Volgende stappen

Meer informatie over de ontwikkelaarsportal: