Overzicht van de ontwikkelaarsportal

Ontwikkelaarsportal is een automatisch gegenereerde, volledig aanpasbare website met de documentatie van uw API's. Hier kunnen API-gebruikers uw API's detecteren, leren hoe ze kunnen worden gebruikt, toegang kunnen aanvragen en ze kunnen uitproberen.

Zoals u in dit artikel hebt geïntroduceerd, kunt u de ontwikkelaarsportal aanpassen en uitbreiden voor uw specifieke scenario's.

API Management developer portal

Beschikbaarheid

Belangrijk

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

Migratie vanuit de verouderde portal

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.

Migratie naar de nieuwe ontwikkelaarsportal wordt beschreven in het specifieke documentatieartikel.

Aanpassing en stijl van de beheerde portal

Uw API Management-service bevat een ingebouwde, altijd up-to-date, beheerde ontwikkelaarsportal. U kunt deze openen via de Azure Portal interface.

Pas de beheerde portal aan met behulp van de ingebouwde visuele editor voor slepen en neerzetten:

  • Gebruik de visuele editor om pagina's, media, indelingen, menu's, stijlen of website-instellingen te wijzigen.

  • Profiteer van ingebouwde widgets om tekst, afbeeldingen, knoppen en andere objecten toe te voegen die in de portal kant-en-klare ondersteuning bieden.

  • Aangepaste HTML toevoegen , bijvoorbeeld HTML voor een formulier toevoegen of een videospeler insluiten. De aangepaste code wordt weergegeven in een inlineframe (iframe).

Zie deze zelfstudie voor voorbeelden van aanpassingen.

Notitie

De beheerde ontwikkelaarsportal ontvangt en past updates automatisch toe. Wijzigingen die u hebt opgeslagen, maar niet in de ontwikkelaarsportal zijn gepubliceerd, blijven tijdens een update in die status.

Uitbreidbaarheid

In sommige gevallen hebt u mogelijk functionaliteit nodig naast de aanpassings- en stijlopties die worden ondersteund in de beheerde ontwikkelaarsportal. Als u aangepaste logica wilt implementeren, die niet standaard wordt ondersteund, kunt u de codebasis van de portal wijzigen die beschikbaar is op GitHub. U kunt bijvoorbeeld een nieuwe widget maken om te integreren met een ondersteuningssysteem van derden. Wanneer u nieuwe functionaliteit implementeert, kunt u een van de volgende opties kiezen:

  • Zelf de resulterende portal buiten uw API Management-service hosten. Wanneer u de portal zelf host, wordt u de onderhouder en bent u verantwoordelijk voor de upgrades. De ondersteuning van Azure-ondersteuning is alleen beperkt tot de basisinstallatie van zelf-hostende portals.
  • Open een pull-aanvraag voor het API Management-team om nieuwe functionaliteit samen te voegen met de codebasis van de beheerde portal.

Raadpleeg de GitHub opslagplaats en de zelfstudie voor het implementeren van een widget voor uitbreidbaarheidsdetails en instructies. In de zelfstudie voor het aanpassen van de beheerde portal wordt u begeleid bij het beheervenster van de portal. Dit is gebruikelijk voor beheerde en zelf-hostende versies.

Volgende stappen

Meer informatie over de ontwikkelaarsportal:

Door andere resources bladeren: