Seminar Gravitee API Management – Kompaktseminar Architektur, APIs und Betrieb

Das dreitägige Kompaktseminar vermittelt einen belastbaren Querschnitt durch Gravitee API Management. Architektur, Einsatzplanung, API-Erstellung, Plans, Policies, Security, Portal, Analytics und Betriebsgrundlagen werden in einer kompakten Praxisstrecke verbunden, ohne die Tiefe der spezialisierten Fachseminare vollständig zu ersetzen.

Seminarprofil

Die Inhalte werden als zusammenhängende Arbeitsstrecke aufgebaut. Jedes Modul verbindet Einordnung, Konfiguration, kontrollierte Tests und betriebliche Dokumentation. Entscheidungen werden nicht als Einzeloptionen betrachtet, sondern in Bezug auf API-Lifecycle, Security, Consumer und Betrieb bewertet.

Zielgruppe

Projektteams, technische Entscheider, API- und Plattformverantwortliche, Entwickler sowie Administratoren mit breitem Orientierungsbedarf

Voraussetzungen

Allgemeine API-, Infrastruktur- und Security-Grundkenntnisse; keine tiefen Gravitee-Vorkenntnisse erforderlich

Lernziele

• Plattformbild, Rollen und Kernkomponenten fachlich einordnen, zielgerichtet konfigurieren und mit überprüfbaren Kriterien absichern
• Anforderungsaufnahme und Einsatzplanung fachlich einordnen, zielgerichtet konfigurieren und mit überprüfbaren Kriterien absichern
• API-Design, Spezifikationen und API-Produkte fachlich einordnen, zielgerichtet konfigurieren und mit überprüfbaren Kriterien absichern
• APIs erstellen, importieren, testen und bereitstellen fachlich einordnen, zielgerichtet konfigurieren und mit überprüfbaren Kriterien absichern
• Plans, Applications und Subscriptions fachlich einordnen, zielgerichtet konfigurieren und mit überprüfbaren Kriterien absichern
• Policies, Flows und Ausführungsphasen fachlich einordnen, zielgerichtet konfigurieren und mit überprüfbaren Kriterien absichern
• Security-Architektur und Defense in Depth fachlich einordnen, zielgerichtet konfigurieren und mit überprüfbaren Kriterien absichern
• die zusätzlichen Vertiefungsmodule zu einer konsistenten Gravitee-Arbeitsstrecke verbinden
• Änderungen, Tests, Risiken und Betriebsanforderungen nachvollziehbar dokumentieren

Inhaltsübersicht

1. Plattformbild, Rollen und Kernkomponenten
2. Anforderungsaufnahme und Einsatzplanung
3. API-Design, Spezifikationen und API-Produkte
4. APIs erstellen, importieren, testen und bereitstellen
5. Plans, Applications und Subscriptions
6. Policies, Flows und Ausführungsphasen
7. Security-Architektur und Defense in Depth
8. Developer Portal, Katalog und API-Dokumentation
9. Analytics, Dashboards und Nutzungsanalyse
10. Tagesbetrieb, Wartung und Betriebsorganisation
11. Durchgängiges Praxisprojekt und Betriebsübergabe
12. Durchgängiges Praxisprojekt, Abnahme und Transfer in den Betriebsprozess

Seminarinhalte

1. Plattformbild, Rollen und Kernkomponenten

Dieses Modul ordnet plattformbild, rollen und kernkomponenten in die Gravitee-Plattform ein und überführt die fachlichen Anforderungen in einen reproduzierbaren technischen Ablauf. Konfiguration, Sicherheitswirkung, Fehlerverhalten und Betriebsrelevanz werden gemeinsam geprüft.

• Gateway, Management API, Management Console und Developer Portal im Zusammenspiel
• Organisationen, Environments, APIs, Applications, Plans und Subscriptions
• Control Plane, Data Plane, Self-Hosted-, Cloud- und Hybrid-Betriebsmodelle
• Abgrenzung von API Gateway, API Management, Developer Experience und Governance

Schrittweise Umsetzung

1. Ein Zielbild mit Produzenten, Konsumenten, Plattformdiensten und Verantwortlichkeiten zeichnen.
2. Control-Plane- und Data-Plane-Komponenten den benötigten Sicherheitszonen zuordnen.
3. Ein Environment mit Namens-, Rollen- und Mandantenvorgaben strukturieren.
4. Die Entscheidung für Self-Hosted, Cloud oder Hybrid anhand nachvollziehbarer Kriterien dokumentieren.

2. Anforderungsaufnahme und Einsatzplanung

Dieses Modul ordnet anforderungsaufnahme und einsatzplanung in die Gravitee-Plattform ein und überführt die fachlichen Anforderungen in einen reproduzierbaren technischen Ablauf. Konfiguration, Sicherheitswirkung, Fehlerverhalten und Betriebsrelevanz werden gemeinsam geprüft.

• API-Portfolio, Protokolle, Datenflüsse und Schutzbedarfe erfassen
• Nichtfunktionale Anforderungen wie Verfügbarkeit, Latenz, Durchsatz und Wiederanlauf
• Lizenz-, Edition-, Integrations- und Betriebsabhängigkeiten
• Einführungsphasen, Pilotumfang, Akzeptanzkriterien und Verantwortungsmatrix

Schrittweise Umsetzung

1. Bestehende Schnittstellen und geplante API-Produkte in einer Portfolio-Matrix erfassen.
2. Pro API-Klasse Verfügbarkeit, Authentisierung, Datenklassifikation und Lastprofil festlegen.
3. Muss-, Soll- und Kann-Anforderungen in eine priorisierte Einführungsplanung überführen.
4. Pilot, Produktionsfreigabe und Betriebsübergabe mit messbaren Abnahmekriterien planen.

3. API-Design, Spezifikationen und API-Produkte

Dieses Modul ordnet api-design, spezifikationen und api-produkte in die Gravitee-Plattform ein und überführt die fachlichen Anforderungen in einen reproduzierbaren technischen Ablauf. Konfiguration, Sicherheitswirkung, Fehlerverhalten und Betriebsrelevanz werden gemeinsam geprüft.

• OpenAPI-, AsyncAPI- und Gravitee-API-Definitionen einordnen
• Ressourcen, Operationen, Events, Fehler, Versionen und Kompatibilität
• API als Produkt mit Zielgruppe, Serviceversprechen und Lebenszyklus
• Designregeln für Benennung, Pfade, Payloads, Pagination und Fehlerformate

Schrittweise Umsetzung

1. Eine fachliche Fähigkeit in Ressourcen, Operationen und Ereignisse zerlegen.
2. Eine Spezifikation mit Beispielen, Fehlern, Sicherheitsanforderungen und Versionierung erstellen.
3. Die Definition gegen Organisationsregeln und Rückwärtskompatibilität prüfen.
4. Aus der Spezifikation eine veröffentlichungsfähige API mit Produktbeschreibung ableiten.

4. APIs erstellen, importieren, testen und bereitstellen

Dieses Modul ordnet apis erstellen, importieren, testen und bereitstellen in die Gravitee-Plattform ein und überführt die fachlichen Anforderungen in einen reproduzierbaren technischen Ablauf. Konfiguration, Sicherheitswirkung, Fehlerverhalten und Betriebsrelevanz werden gemeinsam geprüft.

• V4-APIs anlegen und passende API-Typen, Entrypoints und Endpoints wählen
• Definitionen importieren, exportieren, duplizieren und versionieren
• Deployment, Synchronisation, Start, Stop und Rollback
• Smoke Tests, Fehlerbilder und technische Freigabe

Schrittweise Umsetzung

1. Eine API anhand einer vorhandenen Spezifikation importieren und die erzeugte Konfiguration prüfen.
2. Entrypoint, Endpoint, Context Path, Timeouts und Backend-Zugriff konfigurieren.
3. Eine kontrollierte Änderung speichern, deployen und mit einem Smoke Test validieren.
4. Ein fehlerhaftes Deployment erkennen, zurücknehmen und mit Auditdaten dokumentieren.

5. Plans, Applications und Subscriptions

Dieses Modul ordnet plans, applications und subscriptions in die Gravitee-Plattform ein und überführt die fachlichen Anforderungen in einen reproduzierbaren technischen Ablauf. Konfiguration, Sicherheitswirkung, Fehlerverhalten und Betriebsrelevanz werden gemeinsam geprüft.

• Keyless-, API-Key-, OAuth2-, JWT- und weitere Planvarianten
• Applications als technische Identität von Konsumenten
• Subscription-Antrag, Genehmigung, Schlüsselverwaltung und Beendigung
• Quotas, Rate Limits, Consumer-spezifische Regeln und Vertragsbezug

Schrittweise Umsetzung

1. Für öffentliche, interne und partnerbezogene Nutzung jeweils einen geeigneten Plan entwerfen.
2. Eine Application registrieren und fachliche sowie technische Verantwortliche hinterlegen.
3. Eine Subscription beantragen, genehmigen und den Zugriff am Gateway testen.
4. Schlüsselrotation, Ablauf, Sperrung und Offboarding als wiederholbaren Prozess prüfen.

6. Policies, Flows und Ausführungsphasen

Dieses Modul ordnet policies, flows und ausführungsphasen in die Gravitee-Plattform ein und überführt die fachlichen Anforderungen in einen reproduzierbaren technischen Ablauf. Konfiguration, Sicherheitswirkung, Fehlerverhalten und Betriebsrelevanz werden gemeinsam geprüft.

• Request-, Response-, Publish-, Subscribe- und Message-Phasen
• API-, Plan- und Plattform-Flows sowie Bedingungen und Selektoren
• Transformations-, Routing-, Filter-, Cache-, Quota- und Security-Policies
• Policy-Reihenfolge, Fehlerbehandlung, Ausdruckssprache und Seiteneffekte

Schrittweise Umsetzung

1. Einen Flow mit eindeutiger Zielsetzung und passender Ausführungsphase modellieren.
2. Policies in fachlich nachvollziehbarer Reihenfolge konfigurieren und Bedingungen ergänzen.
3. Normalfall, Grenzwert und Fehlerfall mit reproduzierbaren Requests testen.
4. Auswirkung, Laufzeitkosten und Fehlerverhalten im Betriebsnachweis dokumentieren.

7. Security-Architektur und Defense in Depth

Dieses Modul ordnet security-architektur und defense in depth in die Gravitee-Plattform ein und überführt die fachlichen Anforderungen in einen reproduzierbaren technischen Ablauf. Konfiguration, Sicherheitswirkung, Fehlerverhalten und Betriebsrelevanz werden gemeinsam geprüft.

• Bedrohungsmodell für Gateway, Management, Portal, Backends und Konsumenten
• TLS, mTLS, Netzwerksegmentierung, Trust Stores und Zertifikatslebenszyklen
• Least Privilege, Secrets, technische Konten und administrative Trennung
• Schutz gegen Missbrauch, Injection, Datenabfluss und Fehlkonfiguration

Schrittweise Umsetzung

1. Assets, Vertrauensgrenzen, Angriffswege und Schutzmaßnahmen in einem Bedrohungsmodell festhalten.
2. TLS- und mTLS-Beziehungen zwischen Client, Gateway, Management und Backend planen.
3. Secrets und Zertifikate mit Eigentümer, Ablage, Rotation und Ablaufüberwachung erfassen.
4. Ein Hardening-Backlog priorisieren und mit überprüfbaren Kontrollen versehen.

8. Developer Portal, Katalog und API-Dokumentation

Dieses Modul ordnet developer portal, katalog und api-dokumentation in die Gravitee-Plattform ein und überführt die fachlichen Anforderungen in einen reproduzierbaren technischen Ablauf. Konfiguration, Sicherheitswirkung, Fehlerverhalten und Betriebsrelevanz werden gemeinsam geprüft.

• API Discovery, Kategorien, Suche, Sichtbarkeit und Zielgruppen
• Dokumentation, Guides, Spezifikationen, Beispiele und Changelog
• Applications, Subscriptions, Credentials und Self-Service
• Branding, Navigation, Content-Governance und redaktionelle Verantwortung

Schrittweise Umsetzung

1. Eine API mit Zielgruppe, Nutzen, Voraussetzungen und Einstiegspfad katalogfähig beschreiben.
2. Dokumentation, Spezifikation und Beispielaufrufe für die Portalnutzung bereitstellen.
3. Application- und Subscription-Prozess aus Consumer-Sicht vollständig testen.
4. Redaktionsregeln, Review, Aktualisierung und Stilllegung von Portal-Inhalten festlegen.

9. Analytics, Dashboards und Nutzungsanalyse

Dieses Modul ordnet analytics, dashboards und nutzungsanalyse in die Gravitee-Plattform ein und überführt die fachlichen Anforderungen in einen reproduzierbaren technischen Ablauf. Konfiguration, Sicherheitswirkung, Fehlerverhalten und Betriebsrelevanz werden gemeinsam geprüft.

• Gateway-Metriken, API- und Application-Sichten sowie Zeitreihen
• Statuscodes, Latenzen, Durchsatz, Consumer und Endpoint-Verhalten
• Message-Level- und Event-Daten in geeigneter Granularität
• Datenschutz, Aufbewahrung, Sampling und aussagekräftige Dashboards

Schrittweise Umsetzung

1. Fragen von Betrieb, Product Owner und Security in konkrete Kennzahlen übersetzen.
2. Dashboard-Sichten für Traffic, Fehler, Latenz und Top Consumer aufbauen.
3. Normalbereiche und auffällige Abweichungen anhand einer Testlast bestimmen.
4. Aufbewahrung, Zugriff, Sampling und personenbezogene Felder kontrolliert festlegen.

10. Tagesbetrieb, Wartung und Betriebsorganisation

Dieses Modul ordnet tagesbetrieb, wartung und betriebsorganisation in die Gravitee-Plattform ein und überführt die fachlichen Anforderungen in einen reproduzierbaren technischen Ablauf. Konfiguration, Sicherheitswirkung, Fehlerverhalten und Betriebsrelevanz werden gemeinsam geprüft.

• Betriebsrollen, Servicezeiten, Kontrollen, Wartungsfenster und Bereitschaft
• Kapazität, Repository-Gesundheit, Zertifikate und Lizenzzustand
• Backup, Restore, Konfigurationssicherung und Wiederanlauf
• Patch-, Change-, Incident- und Problem-Management

Schrittweise Umsetzung

1. Tägliche, wöchentliche und monatliche Kontrollen in einer Betriebscheckliste strukturieren.
2. Backup- und Restore-Objekte mit RPO, RTO und Verantwortlichkeit festlegen.
3. Ein Wartungsfenster mit Vorprüfung, Umsetzung, Nachtest und Rückfallplan vorbereiten.
4. Betriebskennzahlen und offene Risiken in ein wiederkehrendes Service-Review überführen.

11. Durchgängiges Praxisprojekt und Betriebsübergabe

Dieses Modul ordnet durchgängiges praxisprojekt und betriebsübergabe in die Gravitee-Plattform ein und überführt die fachlichen Anforderungen in einen reproduzierbaren technischen Ablauf. Konfiguration, Sicherheitswirkung, Fehlerverhalten und Betriebsrelevanz werden gemeinsam geprüft.

• API-Produkt von Design über Security und Policies bis Veröffentlichung
• Automatisierte Bereitstellung und kontrollierte Promotion
• Analytics, Alerting, Diagnose und Wiederanlauf
• Dokumentation, Rollen, Abnahme und Übergabe

Schrittweise Umsetzung

1. Ein realistisches API-Produkt mit Zielgruppe, Spezifikation und Schutzbedarf planen.
2. API, Plan, Policies, Portalinhalt und Consumerzugriff implementieren.
3. Deployment, Monitoring, Alerting und ein definiertes Fehlerbild praktisch durchführen.
4. Abnahmeunterlagen, Betriebscheckliste und Verantwortungsübergabe fertigstellen.

Praxisprojekt

Die Übungen werden in einem zusammenhängenden Szenario durchgeführt. Das Szenario beginnt mit Anforderungen und Verantwortlichkeiten und endet mit einer technisch sowie organisatorisch prüfbaren Übergabe.

1. Ausgangslage, Zielgruppe, Schutzbedarf, Lastprofil und Akzeptanzkriterien erfassen.
2. Gravitee-Struktur, API- oder Plattformobjekte und benötigte Rollen modellieren.
3. Konfiguration in kleinen, nachvollziehbaren Änderungen umsetzen und versionieren.
4. Normalfall, Grenzwert, Sicherheitsfehler und technischen Ausfall reproduzierbar testen.
5. Metriken, Logs, Auditdaten und fachliche Prüfpunkte zur Bewertung heranziehen.
6. Betriebs-, Support- und Änderungsverfahren mit Zuständigkeiten und Rückfalloptionen dokumentieren.

Weiterführende Vertiefung

• API-Design, Import und Lifecycle
• Installation, Konfiguration und Administration