Finden Sie die Anbindung von REST-APIs zu fragil?
Ihr Software-System nutzt immer mehr Schnittstellen zu eigenen und fremden Systemen. Bereits angebundene Schnittstellen ändern sich immer wieder mal. Fehler in den APIs gefährden die Verfügbarkeit Ihres Systems.
Sie schaffen zwar grundsätzlich jede Anbindung. Aber:
Die Anzahl und die Änderungs-Frequenz nehmen zu. Es fehlt der Überblick. Wartungs-Aufwände steigen. Das System droht instabil zu werden.
REST-API-Management mit
Virtual Developer ist eine Plattform zur Modellierung, Generierung (ohne KI) und Dokumentation von Software-Systemen.
Die REST-APIs werden modelliert: die APIs selbst und wer wen in welchem Kontext aufruft. Die Bereitstellung und Anbindung von REST-APIs wird durch Generatoren unterstützt, selbst über Unternehmensgrenzen hinweg. Die Generierung standardisiert den Umgang mit fachlichen und technischen Ausnahmesituationen. Sie macht das System damit robust. Anpassungen an API-Änderungen werden früh erkannt, kommuniziert und schnell umgesetzt.
Integrieren Sie REST-APIs mit einem standardisierten, automatisierten Verfahren
Alle Zusammenhänge sind in Diagrammen zu sehen.
Überblick behalten
In Diagrammen im Modeler sieht Ihr Team die Systemzusammenhänge:
- Wer ruft wen auf?
- Welche Anwendungen nutzen welches API?
- Welche Person ist für welche Anwendung verantwortlich?
- Verkettung von Aufrufen: Welchen Weg nehmen die Daten?
APIs absichern
Im Modell kann Ihr Team festlegen, ob und wie der Zugang zu einer API-Implementierung abgesichert werden soll, z.B. über einen API-Key. Generatoren erzeugen passenden Code und die nötige Konfiguration. Ihr Team kann dadurch schnell feststellen, welche APIs abgesichert sind und welche nicht. Durch diese Sichtbarkeit werden Sicherheitslücken vermieden.
Mit Fehlern umgehen
Ihr Team hält technische und fachliche Ausnahmesituationen im Modell fest. Der Code, um die Ausnahmesituationen von der API-Implementierung zum API-Client zu transportieren, wird generiert. Dadurch wird der Tendenz von Entwicklern entgegengewirkt, erst mal nur die Gut-Fälle zu implementieren und zu testen.
API-Änderungen bemerken
Wenn sich etwas in einem API ändert, wird die Änderung im Audit Log des Modelers protokolliert. Ein Hintergrundprozess überwacht diese Änderungen und informiert die Verantwortlichen der Anwendungen, die dieses API verwenden. Das funktioniert auch über Unternehmensgrenzen hinweg. Ihrem Team entgeht nichts mehr.
Verfügbarkeit überwachen
Virtual Developer kann mit Monitoring-Systemen integriert werden, z.B. mit Zabbix. Der aktuelle Zustand von API-Clients und API-Implementierungen im Produktivbetrieb wird dadurch im Modell sichtbar gemacht. Ihr Team sieht Ausfälle und Ausfallgründe, ohne selbst Zugang zum jeweiligen Monitoring-System haben zu müssen, selbst für APIs anderer Unternehmen.
Im Modell sind Ansprechpartner und Support-Adressen von API-Anbietern dokumentiert. Ihr Team kann dadurch bei Problemen schnell und direkt reagieren.
API-Implementierungen betreiben
Ihr Team modelliert für eine Application, die eine API-Implementierung beinhaltet, auch noch ein Deployment. Mit einem passenden DevOps-Generator wird Konfiguration erzeugt, mit der die Application betrieben werden kann. Das ist ein sicherer, schneller und vor allem nachvollziehbarer Weg von der Spezifikation bis zum Produktivbetrieb.
OpenAPI importieren
OpenAPI ist ein etablierter Standard, um APIs formal zu beschreiben. Ihr Team kann solche Beschreibungen in den Modeler importieren, um danach in den Genuss der Vorteile des Modelers zu kommen, z.B. zu sehen, wer wen aufruft und wie ein Deployment aussieht.
Client-Bibliotheken nutzen
Für eine API-Implementierung kann Ihr Team eine Client-Bibliothek generieren und bereitstellen. Dadurch muss nicht für jede Anwendung, die ein API aufrufen soll, ein eigener API-Client generiert werden. Für diese Anwendungen wird trotzdem ein API-Client modelliert, damit die Zusammenhänge sichtbar bleiben.
Spezialisierte Application für das Management von REST-APIs nutzen
Ihr Team kann mit der Virtual Developer Application „Services“ …
- … aus einem Katalog von API-Implementierungen auswählen
- … eine passende Client-Bibliothek herunterladen
- … selbst einen API-Client generieren
Das Management von REST-APIs wird dadurch für Ihr Team weiter vereinfacht. Alles was Ihr Team in „Services“ macht, ist auch im Modeler und für Generatoren sicht- und nutzbar.
In 3 Schritten zum hochgradig vernetzten Software-System
Sie behalten die volle Kontrolle über den Programm-Code und die Laufzeitumgebung.
REST-APIs modellieren
Ein modelliertes API-Interface ist das Minimum, das ein Generator benötigt, um einen Client und eine Implementierung zu erzeugen.
Sie können noch deutlich mehr für ein REST-API modellieren:
- API-Aufrufe
- Anwendungen, die APIs verwenden
- Deployments der Anwendungen
- Fachlogik, die bei einem API-Aufruf ausgeführt werden soll
API-Client und API-Implementierung generieren
Die Generierung erzeugt Code für den API-Client und für die API-Implementierung. Mit dem Client wird die Implementierung aufgerufen.
Die generierten API-Clients und API-Implementierungen selbst beinhalten keine Fachlogik.
API-Implementierung programmieren
In der generierten API-Implementierung fügen Sie Code ein, der Fachlogik aufruft. Diese kann komplett von Hand oder in einer generierten Fachlogik-Hülle mit oder ohne KI implementiert worden sein.
Ein generierter API-Client kann an beliebiger Stelle direkt verwendet werden. Er wird typischerweise von Fachlogik aus aufgerufen.
Wir sprechen gerne mit Ihnen darüber, wie Sie Ihr vernetztes System im Griff behalten können.
Ich bin Marcus, ein echter Mensch – schreiben Sie mir direkt, wenn Sie das Thema beschäftigt.