Teilen über

Einrichten Ihres API Center-Portals

In diesem Artikel erfahren Sie, wie Sie das API Center-Portal (Vorschau), eine von Azure verwaltete Website einrichten, die Entwickler und andere Projektbeteiligte in Ihrer Organisation verwenden, um die APIs in Ihrem API Center zu ermitteln. Angemeldete Benutzer können APIs durchsuchen und filtern und API-Details anzeigen, z. B. API-Definitionen und Dokumentation. Der Benutzerzugriff auf API-Informationen basiert auf der Microsoft Entra-ID und der rollenbasierten Azure-Zugriffssteuerung.

Screenshot des API Center-Portals nach der Benutzeranmeldung.

Hinweis

Das API Center-Portal befindet sich derzeit in der Vorschau.

Tipp

Sowohl Azure API Management als auch Azure API Center bieten API-Portalerfahrungen für Entwickler. Vergleichen der Portale

Voraussetzungen

  • Ein API-Center in Ihrem Azure-Abonnement. Wenn Sie noch keins erstellt haben, lesen Sie die Schnellstartanleitung: Erstellen Ihres API-Centers.

  • Berechtigungen zum Erstellen einer App-Registrierung in einem Microsoft Entra-Mandanten, der Ihrem Azure-Abonnement zugeordnet ist, und Berechtigungen zum Gewähren des Zugriffs auf Daten in Ihrem API Center.

Erstellen der Microsoft Entra-App-Registrierung

Konfigurieren Sie zunächst eine App-Registrierung in Ihrem Microsoft Entra ID-Mandanten. Die App-Registrierung ermöglicht es dem API Center-Portal, im Namen eines angemeldeten Benutzers auf Daten aus Ihrem API-Center zuzugreifen.

DAS API Center kann die App-Registrierung automatisch einrichten, oder Sie können die App-Registrierung manuell erstellen.

Automatisches Einrichten der App-Registrierung

Führen Sie die folgenden Schritte aus, um die App-Registrierung automatisch einzurichten:

  1. Navigieren Sie im Azure-Portal zu Ihrem API Center.
  2. Wählen Sie im linken Menü die Api Center-Portaleinstellungen> aus.
  3. Wählen Sie auf der Registerkarte "Identitätsanbieter " die Option "Einrichten starten" aus.
  4. Wählen Sie auf der Registerkarte "Schnelleinrichtung " die Option "Speichern + Veröffentlichen" aus.

Wenn Sie später auf die App-Registrierung zugreifen müssen, finden Sie sie im Portal unter App-Registrierungen. Die Anwendung wird mit dem folgenden Format benannt: <api-center-name-apic-aad>.

Manuelles Einrichten der App-Registrierung

Wenn Sie die App-Registrierung manuell erstellen möchten, führen Sie die folgenden Schritte aus:

  1. Navigieren Sie im Azure-Portal zu Microsoft Entra ID>Manage>App-Registrierungen.

  2. Wählen Sie + Neue Registrierung aus.

  3. Legen Sie auf der Seite Anwendung registrieren folgende Werte fest:

    1. Festlegen des Namens auf einen aussagekräftigen Namen wie api-center-portal
    2. Wählen Sie unter "Unterstützte Kontotypen" nur "Konten" in diesem Organisationsverzeichnis (<Verzeichnisname> – Einzelner Mandant) aus.
    3. Wählen Sie im Umleitungs-URIdie Einzelseitenanwendung (Single Page Application, SPA) aus, und legen Sie den URI fest. Geben Sie den URI Ihrer API Center-Portalbereitstellung in das folgende Formular ein: https://<service-name>.portal.<location>.azure-apicenter.ms Ersetzen Sie <service name> und <location> durch den Namen Ihres API-Centers und den Ort, an dem es bereitgestellt wird. Beispiel: https://myapicenter.portal.eastus.azure-apicenter.ms.
    4. Wählen Sie Registrieren aus.

Konfigurieren zusätzlicher Umleitungs-URIs für die VS-Codeerweiterung

Konfigurieren Sie beim Aktivieren der API Center-Portalansicht in der Visual Studio Code-Erweiterung für API Center auch die folgenden Umleitungs-URIs in der App-Registrierung:

  1. Navigieren Sie im Azure-Portal zu Ihrer App-Registrierung.

  2. Wählen Sie auf der Seite "Authentifizierung>" die Option "Plattform hinzufügen" und dann "Mobile" und "Desktopanwendungen" aus.

  3. Konfigurieren Sie die folgenden drei benutzerdefinierten Umleitungs-URIs:
    https://vscode.dev/redirect
    http://localhost
    ms-appx-web://Microsoft.AAD.BrokerPlugin/<application-client-id>

    Ersetzen Sie <application-client-id> durch die Anwendungs-ID (Client-ID) dieser App. Sie finden diesen Wert auf der Seite "Übersicht" der App-Registrierung.

Konfigurieren und Veröffentlichen des API Center-Portals

Nach dem Erstellen der API Center-Portal-App-Registrierung können Sie Einstellungen anpassen und Ihr API Center-Portal veröffentlichen. Führen Sie die folgenden Schritte im Azure-Portal aus.

  1. Navigieren Sie im Azure-Portal zu Ihrem API Center.

  2. Wählen Sie im linken Menü unter API Center-Portal"Einstellungen" aus.

    Screenshot der EINSTELLUNGEN des API Center-Portals im Azure-Portal.

  3. Wenn Sie eine App-Registrierung manuell einrichten, wählen Sie auf der Registerkarte "Identitätsanbieter " die Option "Einrichten starten" aus. Wenn Sie die Schnelleinrichtung verwendet haben, ist dieser Schritt bereits abgeschlossen, und Sie können die Einstellungen auf anderen Registerkarten fortsetzen.

    1. Geben Sie auf der Registerkarte "Manuell " in der Client-ID die Anwendungs-ID (Client-ID) aus der App-Registrierung ein, die Sie im vorherigen Abschnitt erstellt haben.
    2. Vergewissern Sie sich, dass der Umleitungs-URI der Wert ist, den Sie in der App-Registrierung konfiguriert haben.
    3. Wählen Sie "Speichern+ Veröffentlichen" aus.

  4. Passen Sie auf den verbleibenden Registerkarten optional die Einstellungen für Ihr API Center-Portal an. Informationen zu den Einstellungen finden Sie unter Anpassen Ihres API Center-Portals.

  5. Wählen Sie "Speichern+ Veröffentlichen" aus.

Zugriff auf das Portal

Nach der Veröffentlichung können Sie im Browser auf das API Center-Portal zugreifen.

  • Wählen Sie auf der Seite "Einstellungen" des Portals die Option "API Center-Portal anzeigen " aus, um das Portal auf einer neuen Registerkarte zu öffnen.
  • Oder geben Sie die folgende URL in Ihrem Browser ein und ersetzen Sie <service-name> durch den Namen Ihres API-Centers und <location> durch den Ort, an dem es bereitgestellt wird.
    https://<service-name>.portal.<location>.azure-apicenter.ms

Standardmäßig ist die Portalstartseite öffentlich erreichbar, erfordert jedoch die Anmeldung für den Zugriff auf APIs. Ausführliche Informationen zum Konfigurieren des Benutzerzugriffs auf das Portal finden Sie unter Aktivieren des Anmeldeportals durch Microsoft Entra-Benutzer und -Gruppen .

Aktivieren der Anmeldung beim Portal durch Microsoft Entra-Benutzer und -Gruppen

Um die Anmeldung beim API Center-Portal für den Zugriff auf APIs zu ermöglichen, weisen Sie benutzern oder Gruppen in Ihrer Organisation die Rolle " Azure API Center Data Reader " zu, die auf Ihr API Center ausgerichtet ist.

Von Bedeutung

Standardmäßig müssen Sie und andere Administratoren des API Center sich anmelden, um auf APIs im API Center-Portal zuzugreifen. Stellen Sie sicher, dass Sie die Rolle Azure API Center-Datenleser sich selbst und anderen Administratoren zuweisen.

Ausführliche Voraussetzungen und Schritte zum Zuweisen einer Rolle zu Benutzern und Gruppen finden Sie unter Zuweisen von Azure-Rollen mithilfe des Azure-Portals. Kurze Schritte:

  1. Navigieren Sie im Azure-Portal zu Ihrem API Center.
  2. Wählen Sie im linken Menü die Option Access Control (IAM)>+ Rollenzuweisung hinzufügen aus.
  3. Legen Sie im Bereich " Rollenzuweisung hinzufügen " die Werte wie folgt fest:
    1. Suchen und wählen Sie auf der Seite Rolle den Azure API Center-Datenleser aus. Wählen Sie Weiteraus.
    2. Wählen Sie auf der Seite Mitglieder unter Zugriff zuweisen die Option Benutzer, Gruppe oder Dienstprinzipal>+ Mitglieder auswählen aus.
    3. Suchen Sie auf der Seite Mitglieder auswählen nach den Benutzern oder Gruppen, denen die Rolle zugewiesen werden soll, und wählen Sie diese aus. Klicken Sie auf Auswählen und dann auf Weiter.
    4. Überprüfen Sie die Rollenzuweisung, und wählen Sie Überprüfen + zuweisen aus.

Hinweis

Um die Zugriffskonfiguration für neue Benutzer zu optimieren, empfiehlt es sich, die Rolle einer Microsoft Entra-Gruppe zuzuweisen und eine dynamische Gruppenmitgliedschaftsregel zu konfigurieren. Weitere Informationen finden Sie unter Erstellen oder Aktualisieren einer dynamischen Gruppe in microsoft Entra ID.

Nachdem Sie den Zugriff auf das Portal konfiguriert haben, können sich konfigurierte Benutzer beim Portal anmelden und die APIs in Ihrem API Center anzeigen.

Hinweis

Der erste Benutzer, der sich beim Portal anmeldet, wird aufgefordert, den Berechtigungen zuzustimmen, die von der API Center-Portal-App-Registrierung angefordert werden. Danach werden andere konfigurierte Benutzer nicht zur Zustimmung aufgefordert.

API-Ermittlung und -Nutzung im API Center-Portal

Das API Center-Portal unterstützt und optimiert die Arbeit von Entwicklern, die APIs innerhalb Ihrer Organisation verwenden und erstellen. Angemeldete Benutzer können:

  • Suchen nach APIs nach Namen oder mithilfe der KI-unterstützten semantischen Suche

  • Filtern von APIs nach Typ oder Lebenszyklusstufe

  • Anzeigen von API-Details und Definitionen , einschließlich Endpunkten, Methoden, Parametern und Antwortformaten

  • Herunterladen von API-Definitionen auf einen lokalen Computer oder Öffnen in Visual Studio Code

  • Testen von APIs , die die API-Schlüsselauthentifizierung oder OAuth 2.0-Autorisierung unterstützen

API-Verwaltungs- und API Center-Portale

Die Azure API Management- und Azure API Center-Dienste bieten sowohl Portale für Entwickler zum Ermitteln und Nutzen von APIs:

  • Das API Management-Entwicklerportal ermöglicht Es Benutzern, verwaltete APIs zu finden, zu erfahren, wie Sie sie verwenden, Zugriff anfordern und testen können.
  • Das API Center-Portal (Vorschau) ist ein Portal mit mehreren Gateways, in dem Benutzer das vollständige API-Inventar der Organisation ermitteln und filtern können.

Während die beiden Portale einige Features teilen, weisen sie auch unterschiedliche Unterschiede auf. In der folgenden Tabelle werden die aktuellen Funktionen verglichen, um zu bestimmen, welches Portal verwendet werden soll. Einige Organisationen bevorzugen möglicherweise ein Portal, während andere beides benötigen.

Merkmal API-Verwaltungsentwicklerportal API Center-Portal (Vorschau)
Such- und Filter-API-Inventar Nur API-Verwaltungsinstanz Alle APIs1
Api-Details und -Definitionen anzeigen ✔️ ✔️
Anzeigen der API-Dokumentation ✔️ ✔️
Anpassen mit Branding ✔️ Nur Name
Integration mit Microsoft Entra ID ✔️ ✔️
Hinzufügen von benutzerdefinierten Widgets ✔️ ❌
Anpassen mit WordPress ✔️ ❌
Testen von APIs in der Testkonsole ✔️ ✔️
Abonnieren von APIs ✔️ ❌
Anzeigen von API-Nutzungsanalysen ✔️ ❌

1 Das API Center-Portal kann alle APIs in Ihrer Organisation enthalten, einschließlich der apIs, die in Azure API Management und anderen Plattformen verwaltet werden, sowie nicht verwaltete APIs und APIs in der Entwicklung.

Verwandte Inhalte

  • Last updated on