Anpassen Ihres API Center-Portals

In diesem Artikel werden die Einstellungen erläutert, die Sie im API Center-Portal (Vorschau) anpassen können. Das API Center-Portal ist eine von Azure verwaltete Website, die Entwickler und andere Projektbeteiligte in Ihrer Organisation verwenden, um die APIs in Ihrem API Center zu ermitteln.

Informationen zum Einrichten des API Center-Portals für die anfängliche Verwendung und Anmeldung finden Sie unter Einrichten des API Center-Portals.

Hinweis

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

Seite "Portaleinstellungen"

Konfigurieren Von API Center-Portaleinstellungen im Azure-Portal. So greifen Sie auf die Einstellungsseite zu:

1. Navigieren Sie im Azure-Portal zum API-Center.
2. Wählen Sie im API Center-Portal"Einstellungen" aus.
3. Klicken Sie auf die Registerkarten, um die Einstellungen anzuzeigen und anzupassen.
4. Wählen Sie "Speichern+ Veröffentlichen " aus, um Ihre Änderungen anzuwenden.

Von Bedeutung

Wählen Sie jedes Mal Speichern + Veröffentlichen aus, wenn Sie Änderungen an den Einstellungen vornehmen. Bis Sie die Veröffentlichung vornehmen, werden Ihre Änderungen nicht im API Center-Portal angezeigt.

Siteprofil

Geben Sie auf der Registerkarte "Websiteprofil " optional einen benutzerdefinierten Namen an, der in der oberen Leiste des veröffentlichten Portals angezeigt wird.

API-Sichtbarkeit

Steuern Sie auf der Registerkarte "API-Sichtbarkeit ", welche APIs für API Center-Portalbenutzer auffindbar (sichtbar) sind. Sichtbarkeitseinstellungen gelten für alle Benutzer des API Center-Portals.

Das API Center-Portal verwendet die Azure API Center-Datenebenen-API zum Abrufen und Anzeigen von APIs im API Center und zeigt standardmäßig alle APIs für angemeldete Benutzer mit Azure RBAC-Berechtigungen an.

Um nur bestimmte APIs sichtbar zu machen, fügen Sie Filterbedingungen für APIs basierend auf integrierten Eigenschaften hinzu. Wählen Sie z. B. die Anzeige von APIs nur für bestimmte Typen (z. B. REST oder GraphQL) oder basierend auf bestimmten Spezifikationsformaten (z. B. OpenAPI) aus.

Anonymer Zugriff

Aktivieren Sie optional auf der Registerkarte " API-Sichtbarkeit " den anonymen Lesezugriff auf die Azure API Center-Datenebenen-API, mit der nicht authentifizierte Benutzer das API-Inventar durch direkte API-Aufrufe ermitteln können. Aktivieren Sie diese Einstellung beispielsweise, um APIs für nicht authentifizierte Benutzer auffindbar zu machen, wenn Sie das API Center-Portal selbst hosten .

Vorsicht

Achten Sie beim Aktivieren des anonymen Zugriffs darauf, vertrauliche Informationen in API-Definitionen oder -Einstellungen nicht verfügbar zu machen.

Semantische Suche

Wenn diese Option auf der Registerkarte " Semantiksuche " aktiviert ist, ergänzt das API Center-Portal die grundlegende namensbasierte API-Suche mit DER KI-unterstützten semantischen Suche , die auf API-Namen, Beschreibungen und optional benutzerdefinierten Metadaten basiert. Die semantische Suche ist nur im Standardplan verfügbar.

Benutzer können mithilfe von Abfragen in natürlicher Sprache nach APIs suchen, wodurch die Suche nach APIs auf der Grundlage ihrer Absicht erleichtert wird. Wenn ein Entwickler beispielsweise nach "Ich benötige eine API für die Bestandsverwaltung" sucht, kann das Portal relevante APIs vorschlagen, auch wenn die API-Namen oder Beschreibungen diese genauen Wörter nicht enthalten.

Tipp

Wenn Sie den kostenlosen Plan von Azure API Center verwenden, können Sie problemlos auf den Standardplanaktualisieren, um Volldienstfeatures einschließlich semantischer Suche im API Center-Portal zu aktivieren.

Wenn Sie kigestützte Suche verwenden möchten, wenn Sie beim API Center-Portal angemeldet sind, klicken Sie in das Suchfeld, wählen Sie "Suchen mit KI" aus, und geben Sie eine Abfrage ein.

Benutzerdefinierte Metadaten

Wählen Sie auf der Registerkarte "Metadaten " optional benutzerdefinierte Metadateneigenschaften aus, die Sie in API-Details und der semantischen Suche verfügbar machen möchten.

Aktivieren des Zugriffs auf die Testkonsole für APIs

Sie können Benutzereinstellungen so konfigurieren, dass der Zugriff auf APIs und deren spezifische Versionen im API Center präzise autorisiert wird. Konfigurieren Sie beispielsweise bestimmte API-Versionen für die Verwendung von API-Schlüsseln für die Authentifizierung, und erstellen Sie eine Zugriffsrichtlinie, die nur bestimmten Benutzern die Authentifizierung mit diesen Schlüsseln zulässt.

Zugriffsrichtlinien gelten auch für die Funktion "Diese API testen" für APIs im API Center-Portal, um sicherzustellen, dass nur Portalbenutzer mit der entsprechenden Zugriffsrichtlinie die Testkonsole für diese API-Versionen verwenden können. Weitere Informationen zum Autorisieren des Zugriffs auf APIs

Verwandte Inhalte

• Einrichten des API Center-Portals
• Aktivieren und Anzeigen des Azure API Center-Portals in Visual Studio Code
• Selbsthosten des API Center-Portals