Was ist das Azure API Center?
Azure API Center ist ein neuer Dienst in Azure, der ein strukturiertes und zentralisiertes Repository aller Organisations-APIs bietet und einheitliche Nachverfolgung, Ermittlung, Wiederverwendung und Governance ermöglicht. API Center ist eine sichere Lösung, die alle APIs konsolidiert und organisiert, unabhängig vom Typ, der Entwicklungslebenszyklusphase oder dem Bereitstellungsort für Ihre API-Laufzeit zusammen mit metadaten- oder API-bezogenen Informationen.
Vorteile des API Center
| Kundenproblem | Vorteile des API Center |
|---|---|
| Schlechte API-Auffindbarkeit und Wiederverwendung | Einfache API-Auffindbarkeit und -nutzung. API-Manager können einen vollständigen Bestand aller APIs im Azure-Portal anzeigen. API-Verbraucher können das webbasierte API Center-Portal verwenden, um APIs zu ermitteln und zu nutzen, oder die API Center-Erweiterung für Visual Studio Code verwenden, um APIs zu erstellen, zu ermitteln und zu nutzen. |
| Schatten, nicht geregelte APIs | Zentrales Inventar der APIs. API Center ermöglicht Organisationen das Erstellen eines zentralen Repositorys von APIs aus verschiedenen Teams und Abteilungen, die als konsolidierte Quelle der Wahrheit und Vertrauensstellung für alle APIs fungieren. |
| Potenzielle Sicherheitsbedrohungen | Einfache API-Governance. Wenn APIs an einem Zentralen konsolidiert sind, wird die Verwaltung dieser APIs zum Erzwingen von Organisationssicherheitsrichtlinien für API-Plattformteams einfacher. |
| Inkonsistentes API-Design | Automatisierte API-Entwurfskonformitätsprüfungen. API Center ermöglicht Administratoren das Erzwingen von Designstandards für alle APIs und implementiert einen Lintenworkflow, der APIs anhand eines definierten Stilleitfadens überprüft und einen API-Compliancebericht generiert, auf den im API Center zugegriffen werden kann. |
API-Ökosystemrollen und Verantwortlichkeiten
Das API-Ökosystem einer Organisation besteht häufig aus verschiedenen Rollen mit unterschiedlichen Verantwortlichkeiten, die für den erfolgreichen Betrieb von wesentlicher Bestandteil sind. Werfen wir einen genaueren Blick auf einige der Rollen.
API-Ersteller – Dies können einzelne Entwickler oder Teams sein, deren Hauptverantwortung folgendes umfasst:
- Konsolidieren von Systemspezifikationen und -anforderungen
- Entwerfen der API-Architektur, die den definierten Zielen entspricht
- Entwickeln, Sichern und Veröffentlichen der APIs
- Testen und Sicherstellen, dass APIs sowohl Funktions- als auch Leistungsanforderungen erfüllen
- Dokumentieren der APIs
- API-Wartungsvorgänge, die das Verwalten von Versionen und Updates umfassen
API-Ersteller bemühen sich, sicherzustellen, dass sie die bewährten Methoden, Sicherheits- und Compliancerichtlinien und Organisations-API-Standards für Konsistenz befolgen. Außerdem müssen sie sicherstellen, dass sie den Aufwand früherer/ anderer Teams innerhalb der Organisation nicht duplizieren.
API-Verbraucher – Dies können interne oder externe Benutzer der APIs sein, die:
- Private APIs in ihren internen Geschäftsworkflows und -diensten nutzen (interne Verbraucher)
- Eingeschränkte API-Endpunkte zur Integration in strategische Geschäftspartnerschaften verwenden (Partnerkunden)
- Öffentlich verfügbare APIs zum Erstellen externer Systeme verwenden, die von der Organisation bereitgestellte Dienste verwenden (Verbraucher von Drittanbietern)
API-Verbraucher müssen sicherstellen, dass sie schnell die am besten geeigneten APIs für ihre Workloads ermitteln, um wertvolle Entwicklungsressourcen und Anstrengungen bei Duplizierungen zu vermeiden. Um dies zu erreichen, ist es wichtig, dass sie gute und einfach zu verwendende Dokumentation erhalten, um die APIs zu validieren, die ihre jeweiligen Anforderungen lösen und dass sie nahtlos in ihre Anwendungen integriert werden können.
API-Plattformteam: API-Plattformtechniker kümmern sich um das Erstellen und Verwalten skalierbarer, sicherer und hochleistungsfähiger API-Architekturen für ihre Organisation. Einige ihrer Aufgaben können folgendes umfassen:
- Entwurf und Entwicklung der API-Architektur
- Einrichten und Durchsetzen bewährter API-Methoden und Designstandards in der gesamten Organisation
- Durchsetzen von Überwachung, Analyse und Berichterstellung zur Generierung umsetzbarer Erkenntnisse
- Implementieren und Verwalten der API-Sicherheit durch Authentifizierungs-, Autorisierungs- und Verschlüsselungsprotokolle
- Vereinfachen der Zusammenarbeit und des Feedbacks zwischen Produktmanagern, API-Produzenten und Verbrauchern zur Ausrichtung an API-Strategien
- Unterstützen der Integration und Problembehandlung von APIs sowohl intern als auch extern
API-Plattformexperten bei Contoso arbeiten zusammen, um eine einfach zu übernehmende Strategie bereitzustellen, die verhindert, dass die Organisation API-Überschreitungen erlebt.
Funktionsweise des API Center
API-Plattformexperten in einer Organisation benötigen eine schnelle und einfache Möglichkeit, ein zentrales Repository aller APIs (sowohl intern als auch extern) zusammen mit anderen Metadaten wie API-Versionen, Definitionen und mehr zu konfigurieren. Mit API Center können Sie einen Katalog von APIs erstellen, die auf verschiedenen API-Verwaltungslösungen gehostet und verwaltet werden, und sie über ihre verschiedenen Design-, Entwicklungs-, Test- und Produktionslebenszyklus hinweg verwalten.
Funktionen des Azure API Center
API-Inventar
Auf der Grundlage des API Center wird ein vollständiges und aktuelles Inventar aller APIs erstellt, die in der gesamten Organisation erstellt und verwendet werden. Diese Inventur ist entscheidend, um API-Governance, Ermittlung und Verbrauch im großen Maßstab zu ermöglichen.
Mit API Center können Sie Ihrem Bestand APIs hinzufügen, unabhängig von:
- API-Technologie und Sprache: ASP.NET Core Web API, Express, FastAPI, serverlos API usw.
- API-Typ: REST, GraphQL, SOAP, gRPC, WebSocket, WebHook, etc.
- Laufzeitumgebung: Kubernetes-Cluster, Web App, API Management, Apigee API Management, Azure Functions usw.
API-Governance
Mit einer vollständigen API-Inventur müssen wir nun prüfen, wie wir sicherstellen können, dass diese APIs konsistent, standardisiert, verwendbar und sicher sind. API-Governance wird als Praxis für die Definition und Anwendung von Standards, Richtlinien und Prozessen in allen Organisations-APIs definiert.
Diese Funktion im API Center vereinfacht die Nachverfolgung von APIs mithilfe von Metadaten wie Versionen, Besitzern, Lebenszyklus und Nachverfolgen von Prozessen wie Complianceüberprüfungen, Breaking Change Erkennung usw.
API Center bietet außerdem Tools rund um die API-Designgovernance, die Linten unterstützt, implementiert mit dem Spektral-JSON/YAML-Linter, mit dem sichergestellt wird, dass registrierte APIs den Stilregeln der Organisation entsprechen und eine Analysefunktionalität für Ihre APIs bereitstellt. Wenn Sie dies für Ihre Organisation aktivieren, können Sie Fehler und Inkonsistenzen frühzeitig erkennen, indem Sie einen Compliancebericht generieren, der im API Center angezeigt werden kann.
Die Bemühungen der API-Plattform sind am erfolgreichsten, wenn sie über entwicklerbasiertes Buy-In verfügen. Die API Center-Erweiterung für Visual Studio Code bietet Shift-Left-API-Governance-Funktionen zur Erkennung bahnbrechender Änderungen und API-Design-Governance, um sicherzustellen, dass APIs gleich beim ersten Mal richtig erstellt werden.
API-Ermittlung und -Verbrauch
API Center optimiert den gesamten Lebenszyklus der API-Entwicklung und verbessert die Entwicklererfahrung, indem sie in beliebte Entwicklertools wie Visual Studio Code integriert wird. Mit der API Center-Erweiterung können API-Verbraucher APIs direkt in Visual Studio Code im Kontext ihrer bisherigen Funktionsweise entdecken, ausprobieren und nutzen. Eine weitere Funktion des API Center ist ein herkömmliches webbasiertes API Center-Portal, das es API-Verbrauchern ermöglicht, auf einfache Weise in Dokumentationen zu navigieren, auf APIs zuzugreifen und APIs aus Ihrem API-Katalog zu nutzen.
In der nächsten Einheit erfahren Sie, wie Sie Ihr API-Inventar mit API Center über das Azure-Portal erstellen und verwalten können, lokal mithilfe der Azure CLI oder im VS Code mithilfe der API Center-Erweiterung.