Seminar Gravitee API Management – API-Design, Import und Lifecycle

Das Seminar führt von der fachlichen API-Idee über eine belastbare Spezifikation bis zur importierten, getesteten, veröffentlichten und versionierten API. Designregeln, V4-Konfiguration, kontrollierte Änderungen, Kompatibilität und Stilllegung werden in einem zusammenhängenden Arbeitsablauf behandelt.

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

API Designer, Architekten, Entwickler, technische Product Owner, Plattformteams und Review-Verantwortliche

Voraussetzungen

Grundkenntnisse in HTTP, REST, JSON und API-Spezifikationen; praktische Erfahrung mit Schnittstellen ist hilfreich

Lernziele

• Plattformbild, Rollen und Kernkomponenten 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
• Lifecycle, Versionierung und kontrollierte Änderungen fachlich einordnen, zielgerichtet konfigurieren und mit überprüfbaren Kriterien absichern
• Plans, Applications und Subscriptions fachlich einordnen, zielgerichtet konfigurieren und mit überprüfbaren Kriterien absichern
• Developer Portal, Katalog und API-Dokumentation fachlich einordnen, zielgerichtet konfigurieren und mit überprüfbaren Kriterien absichern
• Tests, Abnahme und Qualitätsnachweis 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. API-Design, Spezifikationen und API-Produkte
3. APIs erstellen, importieren, testen und bereitstellen
4. Lifecycle, Versionierung und kontrollierte Änderungen
5. Plans, Applications und Subscriptions
6. Developer Portal, Katalog und API-Dokumentation
7. Tests, Abnahme und Qualitätsnachweis
8. Durchgängiges Praxisprojekt und Betriebsübergabe
9. 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. 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.

3. 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.

4. Lifecycle, Versionierung und kontrollierte Änderungen

Dieses Modul ordnet lifecycle, versionierung und kontrollierte änderungen 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.

• Statusmodelle von Entwurf über Review und Veröffentlichung bis Stilllegung
• Versionierungsstrategien für Definition, Produkt und Backend
• Deprecation, Consumer-Kommunikation und Migrationsfenster
• Änderungsnachweis, Audit, Freigaben und Rollback-Fähigkeit

Schrittweise Umsetzung

1. Für eine Beispiel-API zulässige Zustände und Übergangskriterien definieren.
2. Breaking und Non-Breaking Changes anhand konkreter Änderungen klassifizieren.
3. Eine neue Version parallel bereitstellen und Consumer schrittweise migrieren.
4. Stilllegung, Nachweispflichten und technische Bereinigung vollständig planen.

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. 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.

7. Tests, Abnahme und Qualitätsnachweis

Dieses Modul ordnet tests, abnahme und qualitätsnachweis 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.

• Smoke-, Contract-, Security-, Last-, Resilienz- und Regressionstests
• Testdaten, Environments, Mocking und reproduzierbare Requests
• Akzeptanzkriterien für API, Gateway, Portal und Betrieb
• Automatisierung, Nachweise und Freigabeentscheidung

Schrittweise Umsetzung

1. Risiken und Anforderungen in eine priorisierte Testmatrix überführen.
2. Reproduzierbare Tests für Zugriff, Policies, Fehler und Backend-Verhalten erstellen.
3. Last- und Ausfalltests mit klaren Grenzwerten und Messpunkten ausführen.
4. Befunde, Restrestrisiken und Freigabeentscheidung nachvollziehbar dokumentieren.

8. 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

• Policies, Flows und Gateway-Logik
• Developer Portal, API-Katalog und Subscriptions