API Management und erstklassige Betriebsprozesse
Hier erfahren Sie, wie Sie APIs mithilfe von API Management sicher und skalierbar für externe und interne Entwickler sowie für Entwicklungspartner veröffentlichen. Dieser Netzwerkdienst ist eine hybride Multi-Cloud-Verwaltungsplattform für APIs in allen Umgebungen.
Die Komponenten umfassen:
Weitere Informationen finden Sie unter Informationen zu API Management.
In den folgenden Themen erfahren Sie, wie API Management erstklassige Betriebsprozesse unterstützt:
Checkliste
Haben Sie API Management unter Berücksichtigung erstklassiger Betriebsprozesse konfiguriert?
- Schützen Sie die Kommunikation zwischen API Management und Ihrem Back-End.
- Stellen Sie sicher, dass jede Partei über eigene Anmeldeinformationen verfügt, wenn Sie APIs für Dritte verfügbar machen.
- Legen Sie Kontingente und Ratenbegrenzungen fest, wenn Sie APIs für Dritte verfügbar machen.
- Machen Sie sich mit dem Entwurfs- und Architekturleitfaden für die REST-API von Microsoft vertraut.
- Aktivieren Sie die Versionsverwaltung von APIs, um Abwärtskompatibilität beim Hinzufügen weiterer Features zu gewährleisten.
- Nutzen Sie die Versionsverwaltungs- und Revisionsfeatures von API Management, um die API-Versionsverwaltung zu implementieren.
- Machen Sie sich mit den API-Importeinschränkungen in API Management vertraut.
- Machen Sie sich mit dem Ereignisprotokollierungsfeature vertraut.
- Verfolgen Sie Aufrufe in Azure API Management nach, um das Debuggen und Testen zu vereinfachen.
- Konfigurieren Sie die Protokollierung mit Azure Monitor für den API Management-Dienst.
- Wählen Sie die richtigen Modi für den Zugriff auf private Websiteverbindungen aus.
- Werten Sie Firewallregeln und Listen zugelassener IP-Adressen basierend auf der öffentlichen IP-Adresse von API Management aus.
Konfigurationsempfehlungen
Berücksichtigen Sie beim Konfigurieren Ihres API Management-Diensts die folgenden Empfehlungen zu erstklassigen Betriebsprozessen:
| Empfehlung | BESCHREIBUNG |
|---|---|
| Legen Sie Kontingente und Ratenbegrenzungen fest, wenn Sie APIs für Dritte verfügbar machen. | Schützen Sie Back-End-Dienste, und entlasten Sie API Management-Skalierungseinheiten. Ratenbegrenzungsrichtlinien können auf globaler Ebene sowie auf Produkt-, API- und Vorgangsebene angewendet werden, um eine Anpassung des Ratenlimits für API-Benutzer zu ermöglichen. |
| Machen Sie sich mit dem Entwurfs- und Architekturleitfaden für die REST-API von Microsoft vertraut. | Nutzen Sie Standards und bewährte Methoden bei der Verwendung der REST-API. Die Nutzung bewährter Methoden ermöglicht maximale Kompatibilität zwischen Plattformen und Implementierungen. Sehen Sie sich die REST-API-Richtlinien und den API-Entwurfsleitfaden an. |
| Machen Sie sich mit den API-Importeinschränkungen in API Management vertraut. | Es wird alles dafür getan, dass der API-Importprozess reibungslos verläuft. Dazu gehört auch, dass keine Anpassungen erforderlich sind. In einigen Szenarien gelten Einschränkungen, die Änderungen an der Importquelle erforderlich machen. Gilt sowohl für REST- als auch für SOAP-Dienste. Informationen zu aktuellen API-Importeinschränkungen finden Sie unter Richtlinieneinschränkungen. |
| Machen Sie sich mit dem Ereignisprotokollierungsfeature vertraut. | Unterstützt die Ereignisprotokollierung in einem Azure Event Hub, um Analysen in Quasi-Echtzeit zu ermöglichen. Dieses Feature lässt sich in die externe Protokollierung, in SIEM-Lösungen (Security Information & Event Management) oder in die Analyse der API-Nutzung in Quasi-Echtzeit integrieren. |
| Verfolgen Sie Aufrufe in Azure API Management nach, um das Debuggen und Testen zu vereinfachen. | Die Ablaufverfolgung muss für das Abonnement aktiviert sein, das für die Anforderung verwendet wird. Die Ablaufverfolgung wird auf Anforderungsbasis mithilfe des Headerwerts Ocp-Apim-Trace aktiviert. Die API-Ablaufverfolgung ist auch in das Verwaltungsportal integriert und standardmäßig aktiviert, wenn APIs über das Portal getestet werden. |
| Konfigurieren Sie die Protokollierung mit Azure Monitor für den API Management-Dienst. | Protokolle können an einen Log Analytics-Arbeitsbereich gesendet werden, um komplexe Abfragen und Analysen zu ermöglichen. Metriken können für die längerfristige Analyse erfasst werden. Alle Daten werden dann über Azure Monitor verfügbar gemacht. Application Insights kann für die Anwendungsleistungsverwaltung integriert werden. |
| Wählen Sie die richtigen Modi für den Zugriff auf private Websiteverbindungen aus. | Unterstützt die VNET-Integration im internen und externen Modus. |
| Werten Sie Firewallregeln und Listen zugelassener IP-Adressen basierend auf der öffentlichen IP-Adresse von API Management aus. | Mit den Plänen „Basic“, „Developer“, „Standard“ und „Premium“ ist für die Lebensdauer des Diensts eine feste öffentliche IP-Adresse für API Management verfügbar. |