Entdecken des API Management-Diensts

Abgeschlossen

API Management bietet die Kernfunktionen zur Sicherstellung eines erfolgreichen API-Programms in Form von Entwicklerengagement, geschäftlichen Erkenntnissen, Analysen, Sicherheit und Schutz. Jede API besteht aus einer oder mehreren Operationen, und jede API kann zu einem oder mehreren Produkten hinzugefügt werden. Um eine API zu nutzen, abonnieren Entwickler ein Produkt, das diese API enthält. Anschließend können sie die Vorgänge der API aufrufen und unterliegen dabei allen geltenden Nutzungsrichtlinien.

Komponenten von API Management

Azure API Management setzt sich aus einem API-Gateway, einer Verwaltungsebene und einem Entwicklerportal zusammen. Diese Komponenten werden in Azure gehostet und sind standardmäßig vollständig verwaltet. API Management ist in verschiedenen Tarifen mit unterschiedlichen Kapazitäten und Features verfügbar.

  • Das API-Gateway ist der Endpunkt, der folgende Aufgaben übernimmt:

    • Akzeptieren von API-Aufrufen und Weiterleiten dieser Aufrufe an geeignete Back-Ends
    • Überprüft API-Schlüssel und andere Anmeldeinformationen, die in Anforderungen präsentiert werden.
    • Es erzwingt Nutzungskontingente und Ratenbegrenzungen.
    • Transformiert in Richtlinienanweisungen angegebene Anforderungen und Antworten
    • Speichert Antworten zwischen, um die Antwortwartezeit zu verbessern und die Last auf Back-End-Dienste zu verringern
    • Es gibt Protokolle, Metriken und Ablaufverfolgungen für die Überwachung, Berichterstellung und Problembehandlung aus.
  • Die Verwaltungsebene ist die Verwaltungsoberfläche, über die Sie Ihr API-Programm einrichten. Verwenden Sie es zu folgenden Zwecken:

    • Bereitstellen und Konfigurieren von Einstellungen des API Management-Diensts
    • Definieren oder Importieren eines API-Schemas
    • Packen von APIs in Produkte
    • Einrichten von Richtlinien wie etwa Kontingenten oder Transformationen für die APIs
    • Gewinnen von Erkenntnissen mithilfe von Analysen
    • Verwalten von Benutzern
  • Das Entwicklerportal ist eine automatisch generierte, vollständig anpassbare Website mit der Dokumentation Ihrer APIs. Das Entwicklerportal bietet Entwicklern folgende Möglichkeiten:

    • Lesen der API-Dokumentation
    • Aufrufen einer API über die interaktive Konsole
    • Erstellen eines Kontos und Abonnieren von API-Schlüsseln
    • Zugreifen auf Analysen der eigenen Nutzung
    • Herunterladen von API-Definitionen
    • Verwalten von API-Schlüsseln

Produkte

APIs werden in Form von Produkten an Entwickler bereitgestellt. Produkte in API Management enthalten eine oder mehrere APIs und werden mit einem Titel, einer Beschreibung und Nutzungsbedingungen konfiguriert. Produkte können Offen oder Geschützt sein. Geschützte Produkte müssen abonniert werden, bevor Sie verwendet werden können, während offene Produkte ohne Abonnement genutzt werden können. Die Genehmigung von Abonnements wird auf der Produktebene konfiguriert. Abonnements können entweder eine Genehmigung eines Administrators erfordern oder automatisch genehmigt werden.

Gruppen

Gruppen dienen zur Verwaltung der Sichtbarkeit von Produkten für Entwickler. API Management umfasst folgende unveränderliche Systemgruppen:

  • Administratoren: Verwalten API Management-Dienstinstanzen und erstellen die APIs, Vorgänge und Produkte, die von Entwicklern verwendet werden. Azure-Abonnementadministratoren sind Mitglieder dieser Gruppe.
  • Entwickler: Authentifizierte Benutzer des Entwicklerportals, die Anwendungen mit Ihren APIs erstellen. Entwickler erhalten Zugriff zum Entwicklerportal und erstellen Anwendungen, die die Operationen einer API aufrufen.
  • Gäste: Nicht authentifizierte Benutzer des Entwicklerportals. Sie können diesen Benutzern schreibgeschützten Zugriff gewähren, z. B. um APIs anzuzeigen, sie aber nicht aufrufen zu können.

Zusätzlich zu diesen Systemgruppen können Administrator*inneen benutzerdefinierte Gruppen erstellen oder externe Gruppen in zugeordneten Microsoft Entra-Mandanten verwenden.

Entwickler

Entwickler stellen die Benutzerkonten in einer API Management-Dienstinstanz dar. Entwickler können von Administratoren erstellt oder eingeladen werden, oder sie können sich im Entwicklerportal anmelden. Jeder Entwickler ist Mitglied in einer oder mehreren Gruppen und kann die Produkte abonnieren, die für die entsprechenden Gruppen sichtbar sind.

Richtlinien

Richtlinien sind eine Sammlung von Anweisungen, die sequenziell bei Anfragen oder Antworten einer API ausgeführt werden. Häufig verwendete Anweisungen sind etwa Formatumwandlungen von XML nach JSON und Aufrufratenlimits, um die Anzahl eingehender Aufrufe von einem Entwickler zu beschränken. Darüber hinaus stehen noch viele weitere Richtlinien zur Verfügung.

Richtlinienausdrücke können als Attributwerte oder Textwerte in einer beliebigen API Management-Richtlinie verwendet werden, sofern in der Richtlinie nicht anders angegeben. Einige Richtlinien, beispielsweise Ablaufsteuerung und Variable festlegen, basieren auf Richtlinienausdrücken.

Richtlinien können abhängig von Ihren Anforderungen auf unterschiedliche Bereiche angewendet werden: global (alle APIs), auf ein bestimmtes Produkt, auf eine bestimmte API oder auf einen API-Vorgang.