Tutorial: Zugreifen auf und Anpassen des Entwicklerportals

GILT FÜR: Developer | Basic | Basic v2 | Standard | Standard v2 | Premium

Das Entwicklerportal ist eine automatisch generierte und vollständig anpassbare Website mit der Dokumentation Ihrer APIs. Dort können API-Consumer Ihre APIs entdecken, erfahren, wie diese verwendet werden, und Zugriff anfordern.

In diesem Tutorial lernen Sie Folgendes:

• Zugreifen auf die verwaltete Version des Entwicklerportals
• Navigieren durch die Administratoroberfläche
• Anpassen des Inhalts
• Veröffentlichen der Änderungen
• Anzeigen des veröffentlichten Portals

Weitere Informationen zu den Features und Optionen des Entwicklerportals finden Sie in der Übersicht über das Azure API Management-Entwicklerportal.

Voraussetzungen

• Bearbeiten Sie den folgenden Schnellstart: Erstellen einer neuen Azure API Management-Dienstinstanz
• Importieren und Veröffentlichen einer API

Zugreifen auf das Portal als Administrator

Führen Sie die folgenden Schritte aus, um auf die verwaltete Version des Entwicklerportals zuzugreifen.

1. Navigieren Sie im Azure-Portal zu Ihrer API Management-Instanz.

2. Wenn Sie Ihre Instanz in einer v2-Serviceebene erstellt haben, die das Entwicklerportal unterstützt, aktivieren Sie zunächst das Entwicklerportal.

   1. Wählen Sie im Menü auf der linken Seite unter Entwicklerportal die Option Portaleinstellungen aus.
   2. Wählen Sie im Fenster Portaleinstellungen Aktiviertaus. Wählen Sie Speichern aus.

   Es kann einige Minuten dauern, bis das Entwicklerportal aktiviert wird.

3. Wählen Sie im Menü auf der linken Seite unter Entwicklerportal die Option Portalübersicht aus. Wählen Sie dann in der oberen Navigationsleiste die Schaltfläche Entwicklerportal aus. Eine neue Browserregisterkarte mit einer administrativen Version des Portals wird geöffnet.

Grundlegendes zur Administratoroberfläche des Portals

Als Administrator können Sie den Inhalt des Portals mithilfe des visuellen Editors anpassen.

• Verwenden Sie die Menüoptionen auf der linken Seite um Seiten, Medien, Layouts, Menüs, Formatvorlagen oder Websiteeinstellungen zu erstellen oder zu ändern.

• Wechseln Sie oben zwischen Anzeigebereichen (für Bildschirme unterschiedlicher Größe), oder zeigen Sie die Elemente des Portals an, die für Benutzer in verschiedenen Gruppen sichtbar sind. Zeigen Sie beispielsweise bestimmte Seiten nur für Gruppen an, die bestimmten Produkten zugeordnet sind, oder für Benutzer, die auf bestimmte APIs zugreifen können.

• Außerdem können Sie Änderungen speichern oder rückgängig machen oder die Website veröffentlichen.

Tipp

Für noch mehr Flexibilität beim Anpassen des Portals können Sie ein Open-Source-Plug-In für das Entwicklerportal für Wordpress verwenden. Nutzen Sie die Websitefunktionen in WordPress, um Inhalte zu lokalisieren, Menüs anzupassen, benutzerdefinierte Stylesheets anzuwenden und vieles mehr.

Hinzufügen eines Bilds zur Medienbibliothek

Sie sollten eigene Bilder und andere Medieninhalte im Entwicklerportal verwenden, um das Branding Ihrer Organisation widerzuspiegeln. Wenn sich ein Bild, das Sie verwenden möchten, noch nicht in der Medienbibliothek des Portals befindet, fügen Sie es im Entwicklerportal hinzu:

1. Wählen Sie im linken Menü des visuellen Editors Medien aus.
2. Führen Sie eines der folgenden Verfahren aus:
   • Wählen Sie Datei hochladen und dann eine lokale Bilddatei auf Ihrem Computer aus.
   • Wählen Sie Datei verknüpfen aus. Geben Sie eine Referenz-URL für die Bilddatei und weitere Details ein. Wählen Sie anschließend Herunterladen.
3. Wählen Sie Schließen aus, um die Medienbibliothek zu beenden.

Tipp

Sie können der Medienbibliothek auch ein Bild hinzufügen, indem Sie es direkt per Drag & Drop im Fenster des visuellen Editors ablegen.

Ersetzen des Standardlogos auf der Startseite

In der oberen linken Ecke der Navigationsleiste wird ein Platzhalterlogo bereitgestellt. Sie können es durch Ihr eigenes Logo ersetzen, um das Branding Ihrer Organisation widerzuspiegeln.

1. Wählen Sie im Entwicklerportal oben links auf der Navigationsleiste das Contoso-Logo aus.
2. Wählen Sie Bearbeiten aus.
3. Wählen Sie im Popupmenü Bild unter Übergeordnet die Option Quelle aus.
4. Wählen Sie im Popupmenü Medien eine der folgenden Optionen aus:
   • Ein bereits in Ihre Medienbibliothek hochgeladenes Bild
   • Datei hochladen, um eine neue Bilddatei in Ihre Medienbibliothek hochzuladen
   • Keine, wenn Sie kein Logo verwenden möchten
5. Das Logo wird in Echtzeit aktualisiert.
6. Klicken Sie auf eine Stelle außerhalb der Popupfenster aus, um die Medienbibliothek zu schließen.
7. Wählen Sie auf der oberen Leiste Speichern aus.

Bearbeiten von Inhalten auf der Startseite

Die standardmäßige Startseite und andere Seiten werden mit Platzhaltertext und anderen Bildern bereitgestellt. Sie können entweder ganze Abschnitte mit diesem Inhalt entfernen oder die Struktur beibehalten und die Elemente einzeln anpassen. Ersetzen Sie die generierten Texte und Bilder durch eigene, und stellen Sie sicher, dass Links zu den gewünschten Speicherorte führen.

Es gibt verschiedene Möglichkeiten, die Struktur und den Inhalt der generierten Seiten zu bearbeiten. Zum Beispiel:

• Wählen Sie vorhandene Text- und Überschriftenelemente zum Bearbeiten und Formatieren von Inhalten aus.

• Fügen Sie einer Seite einen Abschnitt hinzu, indem Sie mit dem Mauszeiger auf einen leeren Bereich zeigen und dann auf das blaue Symbol mit dem Pluszeichen klicken. Sie können zwischen mehreren Abschnittslayouts wählen.

  

• Fügen Sie ein Widget (z. B. Text, Bild, benutzerdefiniertes Widget oder API-Liste) hinzu, indem Sie auf einen leeren Bereich zeigen und dann auf das graue Symbol mit dem Pluszeichen klicken.

  

• Ordnen Sie Elemente auf einer Seite per Drag & Drop neu an.

Bearbeiten der primären Farbe der Website

Um Farben, Farbverläufe, Typografie, Schaltflächen und andere Benutzeroberflächenelemente im Entwicklerportal zu ändern, müssen Sie die Websiteformatvorlagen bearbeiten. Ändern Sie beispielsweise die primäre Farbe, die für die Navigationsleiste, Schaltflächen und andere Elemente verwendet wird, um das Branding Ihrer Organisation widerzuspiegeln.

1. Wählen Sie im Entwicklerportal im linken Menü des visuellen Editors Formatvorlagen aus.
2. Wählen Sie im Abschnitt Farben das Farbstilelement aus, das Sie bearbeiten möchten. Wählen Sie beispielsweise Primär aus.
3. Wählen Sie Farbe bearbeiten aus.
4. Wählen Sie mithilfe des Farbwählers eine Farbe aus, oder geben Sie den Hexadezimalcode der gewünschten Farbe an.
5. Wählen Sie auf der oberen Leiste Speichern aus.

Die aktualisierte Farbe wird in Echtzeit auf die Website angewendet.

Tipp

Fügen Sie bei Bedarf ein weiteres Farbelement hinzu, und benennen Sie es, indem Sie auf der Seite Formatvorlagen die Option + Farbe hinzufügen auswählen.

Ändern des Hintergrundbilds auf der Startseite

Sie können den Hintergrund auf der Startseite Ihres Portals in ein Bild oder eine Farbe ändern, das bzw. die dem Branding Ihrer Organisation entspricht. Wenn Sie noch kein anderes Bild in die Medienbibliothek hochgeladen haben, können Sie es hochladen, bevor oder während Sie das Hintergrundbild ändern.

1. Klicken Sie auf der Startseite des Entwicklerportals auf die obere rechte Ecke, sodass die Ecken des oberen Abschnitts hervorgehoben sind und ein Popupmenü angezeigt wird.

2. Wählen Sie rechts neben Artikel bearbeiten im Popupmenü den Pfeil nach oben/unten (Zum übergeordneten Element wechseln) aus.

3. Wählen Sie Abschnitt bearbeiten aus.

4. Wählen Sie im Popupmenü Abschnitt unter Hintergrund eins der Symbole aus:

   

   • Hintergrund löschen, um ein Hintergrundbild zu löschen
   • Hintergrundbild, um ein Bild aus der Medienbibliothek auszuwählen oder ein neues Bild hochzuladen
   • Hintergrundfarbe, um eine Farbe über den Farbwähler auszuwählen oder eine Farbe zu löschen
   • Hintergrundfarbverlauf, um einen Farbverlauf auf der Seite mit den Websiteformatvorlagen auszuwählen oder um einen Farbverlauf zu löschen

5. Treffen Sie unter Hintergrundgröße eine für den Hintergrund geeignete Auswahl.

6. Wählen Sie auf der oberen Leiste Speichern aus.

Ändern des Standardlayouts

Das Entwicklerportal verwendet Layouts, um allgemeine Inhaltselemente wie Navigationsleisten und Fußzeilen für Gruppen verwandter Seiten festzulegen. Jede Seite wird automatisch mit einem Layout basierend auf einer URL-Vorlage abgeglichen.

Standardmäßig enthält das Entwicklerportal zwei Layouts:

• Start: Wird für die Startseite verwendet (URL-Vorlage /)

• Standard: Wird für alle anderen Seiten verwendet (URL-Vorlage /*)

Sie können das Layout für eine beliebige Seite im Entwicklerportal ändern und neue Layouts definieren, die auf Seiten angewendet werden, die anderen URL-Vorlagen entsprechen.

So ändern Sie beispielsweise das Logo, das auf der Navigationsleiste des Standardlayouts verwendet wird, sodass es dem Branding Ihrer Organisation entspricht

1. Wählen Sie im linken Menü des visuellen Editors Seiten aus.
2. Wählen Sie die Registerkarte Layouts und dann Standard aus.
3. Wählen Sie das Logobild in der oberen linken Ecke und dann Bearbeiten aus.
4. Wählen Sie unter Übergeordnet die Option Quelle aus.
5. Wählen Sie in den Popupfenstern Medien eine der folgenden Optionen aus:
   • Ein bereits in Ihre Medienbibliothek hochgeladenes Bild
   • Datei hochladen, um eine neue Bilddatei in Ihre Mediendatei hochzuladen, die Sie auswählen können
   • Keine, wenn Sie kein Logo verwenden möchten
6. Das Logo wird in Echtzeit aktualisiert.
7. Klicken Sie auf eine Stelle außerhalb der Popupfenster aus, um die Medienbibliothek zu schließen.
8. Wählen Sie auf der oberen Leiste Speichern aus.

Bearbeiten von Navigationsmenüs

Sie können die Navigationsmenüs oben auf den Entwicklerportalseiten bearbeiten, um die Reihenfolge von Menüelementen zu ändern, Elemente hinzuzufügen oder Elemente zu entfernen. Sie können auch den Namen der Menüelemente und die URL oder andere Inhalte ändern, auf die sie verweisen.

Beispielsweise werden in den Layouts Standard und Start für das Entwicklerportal zwei Menüs für Gastbenutzer des Entwicklerportals angezeigt:

• ein Hauptmenü mit Links zu Start, APIs und Produkte
• ein Menü für anonyme Benutzer mit Links zu Seiten für Anmeldung und Registrierung

Vielleicht möchten Sie sie jedoch anpassen. Wenn Sie beispielsweise Benutzer unabhängig zu Ihrer Website einladen möchten, können Sie den Link Registrieren im Menü für anonyme Benutzer deaktivieren.

1. Wählen Sie im linken Menü des visuellen Editors Websitemenü aus.
2. Erweitern Sie auf der linken Seite Menü für anonyme Benutzer.
3. Wählen Sie „Einstellungen“ (Zahnradsymbol) neben Registrieren und dann Löschen aus.
4. Wählen Sie Speichern.

Bearbeiten der Websiteeinstellungen

Bearbeiten Sie die Websiteeinstellungen für das Entwicklerportal, um den Websitenamen, die Beschreibung und andere Details zu ändern.

1. Wählen Sie im linken Menü des visuellen Editors Einstellungen aus.
2. Geben Sie im Popupmenü Einstellungen die Websitemetadaten ein, die Sie ändern möchten. Richten Sie optional ein Favicon für die Website aus einem Bild in Ihrer Medienbibliothek ein.
3. Wählen Sie auf der oberen Leiste Speichern aus.

Tipp

Wenn Sie den Domänennamen der Website ändern möchten, müssen Sie zuerst eine benutzerdefinierte Domäne in Ihrer API Management-Instanz einrichten. Hier erfahren Sie mehr über benutzerdefinierte Domänennamen in API Management.

Veröffentlichen des Portals

Um Ihr Portal mit den neuesten Änderungen für Besucher zur Verfügung zu stellen, müssen Sie es veröffentlichen.

So veröffentlichen Sie über die Verwaltungsschnittstelle des Entwicklerportals

1. Stellen Sie sicher, dass Ihre Änderungen durch Auswählen der Schaltfläche Speichern gespeichert wurden.

2. Wählen Sie im Menü oben die Option Website veröffentlichen aus. Dieser Vorgang kann einige Minuten dauern.

   

Tipp

Eine weitere Option besteht darin, die Website über das Azure-Portal zu veröffentlichen. Wählen Sie auf der Seite Portalübersicht der API Management-Instanz im Azure-Portal die Option Veröffentlichen aus.

Besuchen des veröffentlichten Portals

Wenn Sie Ihre Änderungen nach der Veröffentlichung des Portals anzeigen möchten, können Sie über die gleiche URL wie für den Verwaltungsbereich darauf zugreifen, z. B. über https://contoso-api.developer.azure-api.net. Sie können es in einer separaten Browsersitzung (Inkognito oder privater Modus) als externer Besucher anzeigen.

Anwenden der CORS-Richtlinie auf APIs

Aktivieren Sie ggf. CORS (Cross-Origin Resource Sharing, Ressourcenfreigabe zwischen verschiedenen Ursprüngen) für Ihre APIs, damit die Besucher Ihres Portals die APIs über die integrierte interaktive Konsole testen können. Wählen Sie auf der Seite Portalübersicht Seite Ihrer API Management-Instanz im Azure-Portal die Option CORS aktivieren aus. Weitere Informationen

Nächste Schritte

In diesem Tutorial haben Sie Folgendes gelernt:

• Zugreifen auf die verwaltete Version des Entwicklerportals
• Navigieren durch die Administratoroberfläche
• Anpassen des Inhalts
• Veröffentlichen der Änderungen
• Anzeigen des veröffentlichten Portals

Fahren Sie mit dem nächsten Tutorial fort:

Importieren und Verwalten von APIs mit Visual Studio Code

Verwandte Inhalte zum Entwicklerportal finden Sie hier:

• Übersicht über das Azure API Management-Entwicklerportal
• Konfigurieren Sie die Authentifizierung beim Entwicklerportal mit Benutzernamen und Kennwörtern, Microsoft Entra ID oder Azure AD B2C.
• Weitere Informationen zum Anpassen und Erweitern der Funktionalität des Entwicklerportals.