API-Produktlebenszyklusmanagement einfach machen

Bobur Umurzokov

Bobur Umurzokov

March 28, 2023

Technology

Moderne APIs werden oft als Produkte entworfen, gebaut und betrieben, die sowohl von internen Systemen als auch von Drittanbietern genutzt werden, und sie müssen ähnlich verwaltet werden. Viele große Organisationen betrachten APIs als eine kritische und strategische Komponente und erstellen daher eine API-Programmstrategie mit klaren Geschäftszielen, Einschränkungen und Ressourcen. Mit einer festgelegten Strategie konzentriert sich der tägliche taktische Ansatz oft auf das API-Lebenszyklusmanagement.

Full Lifecycle API Management (APIM) umfasst die gesamte Lebensdauer einer API, die in der Planungsphase beginnt und endet, wenn eine API außer Betrieb genommen wird. Viele der Phasen innerhalb des Lebenszyklus sind in ein API-Gateway integriert (die Hauptkomponente des API-Management-Systems). Dieser Beitrag führt Sie durch die 3 Schlüsselphasen des API-Produktlebenszyklus: Erstellen, Steuern und Nutzen und untersucht, warum API-Gateways in jeder Lebenszyklusphase wichtig sind.

10 typische Phasen des API-Lebenszyklus

Der API-Lebenszyklus ist ein Modell, das Ihnen helfen kann, den Fortschritt Ihrer API zu verfolgen und Ihr Management anzupassen, während sie reift. Im Allgemeinen kann das API-Lebenszyklusmanagement in mehrere verschiedene Phasen unterteilt werden:

  1. Entwicklung - Entwerfen und bauen Sie Ihre API.
  2. Testen - Überprüfen Sie die Funktionalität, Leistung und Sicherheitsanforderungen.
  3. Veröffentlichung - Machen Sie Ihre APIs für Entwickler zugänglich.
  4. Sicherung - Minimieren Sie Sicherheitsrisiken und Bedenken.
  5. Verwaltung - Pflegen und verwalten Sie APIs, um sicherzustellen, dass sie funktionsfähig, aktuell und den Geschäftsanforderungen entsprechend sind.
  6. Onboarding - Ermöglichen Sie Entwicklern, schnell zu lernen, wie sie die verfügbaren APIs nutzen können. Zum Beispiel durch Bereitstellung von OpenAPI- oder AsyncAPI-Dokumentation und eines Portals sowie einer Sandbox.
  7. Analyse - Ermöglichen Sie Beobachtbarkeit und analysieren Sie Überwachungsdaten, um die Nutzung zu verstehen und Probleme zu erkennen.
  8. Bewerbung - Bewerben Sie APIs bei Entwicklern – zum Beispiel durch Auflistung in einem API-Marktplatz.
  9. Monetarisierung - Ermöglichen Sie die Berechnung und Erhebung von Einnahmen für die Nutzung einer API. Wir behandeln diesen Aspekt des API-Lebenszyklusmanagements als separate Phase im nächsten Abschnitt.
  10. Außerbetriebnahme - Unterstützen Sie die Einstellung und Entfernung von APIs, die aus verschiedenen Gründen erfolgt, einschließlich Verschiebungen der Geschäftsprioritäten, technologischen Veränderungen und Sicherheitsbedenken.

API-Produktlebenszyklusmanagement

Es gibt vier allgemein anerkannte Phasen im Lebenszyklus eines Produkts, wie Entwicklung, Wachstum, Reife und Rückgang, die alle Produkte aus der Perspektive der Marktnachfrage durchlaufen. Wenn wir das Konzept des Produktlebenszyklus auf APIs anwenden, um einen API-Produktlebenszyklus zu erstellen, der aus 5 Phasen besteht: Erstellen, Veröffentlichen, Realisieren, Pflegen und Außerbetriebnahme. Sie können diese Liste weiter auf 3 primäre Phasen eingrenzen: Erstellen, Steuern und Nutzen, indem Sie das API-Gateway integrieren, um den gesamten API-Produktlebenszyklus zu verwalten.

Das folgende Diagramm zeigt, wie das API-Lebenszyklusmanagement mit einem API-Gateway und Backend-Diensten integriert wird:

API-Lebenszyklusmanagement integriert mit einem API-Gateway

Bevor wir uns jede dieser 3 Phasen ansehen, lassen Sie uns zunächst verstehen, welche Probleme ein API-Gateway tatsächlich lösen kann.

API-Gateway löst Schlüsselprobleme

Wenn Sie sich mit APIs, Verkehrsmanagement und der Auswahl verwandter Technologien befassen, müssen Sie sowohl kurzfristige Implementierung als auch langfristige Wartbarkeit in Einklang bringen. Es gibt viele API-bezogene übergreifende Anliegen, einschließlich Wartbarkeit, Erweiterbarkeit, Sicherheit, Beobachtbarkeit, Produktlebenszyklusmanagement und Monetarisierung. Ein API-Gateway kann bei all diesen helfen!

Hier ist eine Übersicht über die Schlüsselprobleme, die ein API-Gateway lösen kann, wie zum Beispiel:

  • Reduzierung der Kopplung durch Verwendung eines Adapters/Fassade zwischen Frontends und Backends.
  • Vereinfachung der Nutzung durch Aggregation/Übersetzung von Backend-Diensten.
  • Schutz von APIs vor Übernutzung und Missbrauch durch Bedrohungserkennung und -minderung.
  • Verständnis, wie APIs genutzt werden (Beobachtbarkeit).
  • Verwaltung von APIs als Produkte mit API-Lebenszyklusmanagement.
  • Monetarisierung von APIs durch Nutzung von Kontoverwaltung, Abrechnung und Bezahlung.

API-Erstellungsphase

Die API-Erstellungsphase ist die erste Stufe im API-Produktlebenszyklusmanagementprozess, in der Sie Ihre API entwerfen, orchestrieren, transformieren, dokumentieren und testen. In dieser Phase können moderne API-Gateways wie Apache APISIX hilfreich sein, um Ihre API von Grund auf zu erstellen oder API-Definitionen aus einer Reihe von Quellen wie OpenAPI YAML/JSON-Strukturen zu importieren, um Route und Upstreams zu registrieren.

Möglicherweise möchten Sie eine neue API verfügbar machen, die Informationen aus anderen bestehenden APIs kombiniert. Mit der Fähigkeit des API-Gateways zur Antwortzusammensetzung können Sie dies erreichen. Oder Sie verbinden interne und externe Systeme über eine neue API, bei der sie unterschiedliche Formate verwenden, um von XML/SOAP zu JSON REST und umgekehrt zu kommunizieren. Sie haben eine bestehende REST-API, aber Sie bauen eine neue GraphQL-API. Zum Beispiel ermöglicht Apache APISIX Ihnen, die GraphQL-API in eine REST-API umzuwandeln.

Vor der Veröffentlichung ist es wichtig, API-Tests abzuschließen, um sicherzustellen, dass sie die festgelegten API-Verträge mit Ihren Client-Anwendungen erfüllen. In einem solchen Fall können Sie Ihre API-Antworten mit dem API-Gateway simulieren, um die Integration zu testen.

API-Steuerungsphase

In der Steuerungsphase wenden Sie Sicherheitsrichtlinien an, stellen bereit, verwalten, überwachen und skalieren Ihre API. Nachdem Sie getestet haben, ist es an der Zeit, Ihre API zu sichern, um sicherzustellen, dass nur autorisierte Benutzer und Anwendungen auf die API zugreifen können und um unbefugten Zugriff oder Missbrauch zu verhindern. Dies kann Techniken wie Eingabevalidierung, OAuth oder API-Schlüssel umfassen und die Einrichtung von Kontrollen zur Verwaltung des Zugriffs auf die API, wie die Konfiguration von Nutzungslimits oder Kontingenten mit dem API-Gateway. Außerdem überwachen Sie Ihre API-Metriken, Traces und Protokolle und optimieren dann die API-Leistung basierend auf Analysedaten.

In derselben Phase können Sie verschiedene API-Freigabestrategien mit dem API-Gateway nutzen, um die API sofort in der Zielumgebung (Entwicklung, Test, Staging und Produktion) bereitzustellen, ohne Aufwand und ohne Ausfallzeiten. Sie integrieren die API mit DevOps-Tools, um die Zeit für die Bereitstellung effizient zu reduzieren, indem Sie Best Practices für Continuous Integration/Continuous Development (CI/CD) anwenden.

In dieser Phase verwalten Sie auch Änderungen an der API im Laufe der Zeit, um sicherzustellen, dass Aktualisierungen oder Modifikationen ordnungsgemäß getestet werden und keine unbeabsichtigten Folgen haben. Sie können mehrere API-Versionen hinzufügen, um Aktualisierungen zu verwalten.

API-Nutzungsphase

In der API-Nutzungsphase wird die API Entwicklern und anderen externen Benutzern zur Verfügung gestellt, um sie zu entdecken. Dies beinhaltet die Ermöglichung für Entwickler, die verfügbaren APIs zu nutzen, die Bereitstellung von OpenAPI-Dokumentation und die Bereitstellung einer Sandbox-Umgebung für Entwickler, um ihre Integrationen zu testen.

API-Nutzer sind die tatsächlichen Benutzer von APIs. Mit Hilfe einer API-Management-Lösung können Sie einzelne und mehrere API-Nutzer registrieren und verschiedene Regeln für unterschiedliche Nutzer (private, Partner- oder öffentliche API-Nutzer) konfigurieren.

In dieser Phase können Sie verschiedene API-Bewerbungsstrategien nutzen, um APIs bei Entwicklern zu bewerben und sie in einem API-Marktplatz aufzulisten. Darüber hinaus möchten Sie möglicherweise die Berechnung und Erhebung von Einnahmen für die Nutzung einer API zur Monetarisierung Ihrer API in Betracht ziehen.

Zusammenfassung

Insgesamt besteht das API-Produktlebenszyklusmanagement aus drei primären Phasen – Erstellen, Steuern und Nutzen. Die API-Erstellungsphase ist eine kritische Stufe im API-Lebenszyklusmanagementprozess, da sie die Grundlage für den Erfolg der API legt, in der Sie Ihre API entwerfen und bauen. Die API-Steuerungsphase hilft sicherzustellen, dass APIs sicher, leistungsfähig und für autorisierte Benutzer und Anwendungen verfügbar sind. Die API-Nutzungsphase repräsentiert den Punkt, an dem Entwickler und andere Benutzer beginnen, Wert aus der API zu ziehen. Indem sichergestellt wird, dass die API gut dokumentiert, einfach zu verwenden und leistungsfähig ist, können Organisationen die Akzeptanz fördern und den Wert ihrer API-Investitionen maximieren.

Ein API-Gateway ist ein Tool, das vor einer API sitzt und als Einstiegspunkt für eine definierte Gruppe von Diensten fungiert. Es beteiligt sich am gesamten Lebenszyklus des API-Managements, der den Prozess der Erstellung, Bereitstellung und Verwaltung Ihrer APIs abdeckt. Einige Vorteile der Verwendung eines API-Gateways sind die Bereitstellung der optimalen API für jeden Nutzer, die Reduzierung der Anzahl der Anfragen und die Durchsetzung von Sicherheitsrichtlinien.

Verwandte Ressourcen

Empfohlene Inhalte

Tags: