Dmitry Nikolaev - stock.adobe.co

Tipp

Vier unverzichtbare Komponenten des API-Managements

Entwickler sollten sich mit diesen vier kritischen Komponenten des API-Managements vertraut machen, um sicherzustellen, dass Ihre Anwendungen richtig funktionieren.

Fred Churchville
von
Zuletzt aktualisiert:29 Sept. 2022

Es ist kein Geheimnis, dass Unternehmen ihre APIs wie das Lebenselixier ihres Unternehmens behandeln müssen. Dazu gehört auch die Entwicklung einer umfassenden, zuverlässigen API-Managementstrategie.

Unternehmen benötigen ein Tool, das alle Anfragen und Antworten nachverfolgt, die Leistung überwacht, für eine schnelle Fehlerbehebung sorgt und sicherstellt, dass alle Entwickler, die Ihre API nutzen, diese problemlos einsetzen können.

In diesem Beitrag erörtern wir vier unverzichtbare Komponenten des API-Managements und untersuchen Praktiken und Tools, die für die Umsetzung jeder einzelnen Komponente erforderlich sind.

1. API-Testumgebung

Eine geeignete Testumgebung ist ein wesentlicher Bestandteil des API-Managements. Im Idealfall sollte es sich dabei um eine lokalisierte Version der Produktionsumgebung der API handeln.

Es gibt drei Haupttypen von API-Tests, die zu priorisieren sind:

  • Funktionstests prüfen, ob alle API-Merkmale und -Funktionen wie vorgesehen laufen. Funktionstests sollten auch auf die Sicherheit und die Fehlerbehandlungsmechanismen abzielen, die die API schützen.
  • Leistungstests bewerten, wie gut eine API die erforderlichen Arbeitslasten bewältigt, insbesondere in Zeiten starker Nutzung. Simulieren Sie unregelmäßigen Datenverkehr und unvorhersehbare Lastbedingungen, um Schwachstellen in der Leistung zu untersuchen.
  • Mit Akzeptanztests wird geprüft, ob eine API ihren Zweck angemessen erfüllt. Diese Tests können aufzeigen, ob sich Änderungen an der API auf die beabsichtigte Nutzung auswirken und mögliche Änderungen identifizieren, die die API nützlicher machen.

2. API-Gateway

Ein API-Gateway steht im Zentrum der API-Kommunikation. Ähnlich wie ein Enterprise Service Bus fungiert das Gateway als Messaging-Administrator, der einen API-Aufruf abfängt, ihn an die entsprechende API weiterleitet und dann die Antwort bearbeitet. Anstatt ein komplexes Netz von API-Integrationen einzeln zu verwalten, bietet diese API-Managementkomponente eine abstrahierte, aber zentralisierte Anlaufstelle für Aufrufe und Antworten.

Abbildung 1: Modell eines verteilten API-Gateway.
Abbildung 1: Modell eines verteilten API-Gateway.

In Fällen, in denen APIs mit externen Systemen integriert werden, die eine andere Sprache sprechen, fungiert das API-Gateway als Übersetzer. So sind Gateways in der Regel in der Lage, webbasierte Protokollformate in solche zu konvertieren, die SOAP-basierte APIs verstehen, wie zum Beispiel XML. Viele Gateway-Produkte umfassen auch automatische Überwachungs- und Tracking Tools, die die Bewegung von APIs durch das Gateway verfolgen und alle Call/Response-Transaktionen aufzeichnen.

3. API-Dokumentation

Eine gute Dokumentation ist ein wesentlicher Bestandteil des API-Managements und ist wohl genauso wichtig wie der zugrunde liegende Code. Das Fehlen einer angemessenen Dokumentation verlangsamt den Entwicklungsprozess und beeinträchtigt die Funktionalität Ihrer API und erschwert die Einführung und Änderung. Ohne gute Dokumentation ist die Übernahme oder Änderung der API ein frustrierender und zeitaufwendiger Prozess. Außerdem sorgt die Dokumentation dafür, dass der Code intakt bleibt und Änderungen zwischen den Entwicklern verfolgt werden können.

Es gibt drei große Kategorien der API-Dokumentation:

  • Die Referenzdokumentation deckt die detaillierten Einzelheiten einer API ab, einschließlich einer vollständigen Syntax aller von ihr unterstützten Aufrufe und Anfragen.
  • Die Beispieldokumentation veranschaulicht die Anwendungsfälle der APIs. Wenn eine bestimmte API zum Beispiel metrische und imperiale Formate von Messdaten lesen kann, sollte die Beispieldokumentation Codezeilen enthalten, die zeigen, wie die API die verschiedenen Formate verarbeitet.
  • Eine Tutorial-Dokumentation liefert den Kontext für die API. Sie besteht in der Regel aus Anleitungen und Tutorials zur Verwendung der API.

4. API-Entwicklerportal

Das Entwicklerportal fungiert als Schaufenster zwischen APIs und Entwicklern. Ein geeignetes Entwicklerportal sollte menschenlesbare Leitfäden, welche die Funktionsweise der API beschreiben, Tutorials mit schrittweisen Anleitungen und SDKs, die Entwickler bei der Integration mit den APIs unterstützen, bereitstellen.

Das Portal muss einen API-Katalog enthalten, der leicht zugänglich und einfach zu navigieren ist. Dieser sollte Beispiele für mögliche API-Antworten enthalten, die den Entwicklern helfen, das Verhalten und die Möglichkeiten, die sie damit haben, zu verstehen. Ein Portal sollte auch die in Ihrer API-Dokumentation enthaltenen Informationen bereitstellen, einschließlich Referenzen für HTTP-Routen, Anfragen und Antworten. Schließlich sollten Sie Änderungsprotokolle zur Verfügung stellen, die Aktualisierungen und Fehler aufzeichnen, sowie einen Echtzeit-Tracker, der den aktuellen Status einer bestimmten API anzeigt.

Erfahren Sie mehr über Softwareentwicklung