Seminar Gravitee API Management – Developer Portal, API-Katalog und Subscriptions

Das Seminar gestaltet den vollständigen Consumer-Pfad von API Discovery über Dokumentation und Application-Registrierung bis zur genehmigten Subscription und zum ersten erfolgreichen Request. Katalogstruktur, Sichtbarkeit, Content-Governance, Credential-Self-Service und Developer Experience werden gemeinsam optimiert.

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 Product Owner, Portal-Redaktion, Developer Relations, Plattformadministration, Support, Entwickler und Governance-Verantwortliche

Voraussetzungen

Grundkenntnisse in API Management und ein Verständnis der internen oder externen API-Konsumenten

Lernziele

• Developer Portal, Katalog und API-Dokumentation fachlich einordnen, zielgerichtet konfigurieren und mit überprüfbaren Kriterien absichern
• Developer Experience und Onboarding fachlich einordnen, zielgerichtet konfigurieren und mit überprüfbaren Kriterien absichern
• Plans, Applications und Subscriptions fachlich einordnen, zielgerichtet konfigurieren und mit überprüfbaren Kriterien absichern
• mTLS, API Keys und Credential Lifecycle 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
• Lifecycle, Versionierung und kontrollierte Änderungen fachlich einordnen, zielgerichtet konfigurieren und mit überprüfbaren Kriterien absichern
• Analytics, Dashboards und Nutzungsanalyse fachlich einordnen, zielgerichtet konfigurieren und mit überprüfbaren Kriterien absichern
• Änderungen, Tests, Risiken und Betriebsanforderungen nachvollziehbar dokumentieren

Inhaltsübersicht

1. Developer Portal, Katalog und API-Dokumentation
2. Developer Experience und Onboarding
3. Plans, Applications und Subscriptions
4. mTLS, API Keys und Credential Lifecycle
5. API-Design, Spezifikationen und API-Produkte
6. Lifecycle, Versionierung und kontrollierte Änderungen
7. Analytics, Dashboards und Nutzungsanalyse
8. Durchgängiges Praxisprojekt, Abnahme und Transfer in den Betriebsprozess

Seminarinhalte

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

2. Developer Experience und Onboarding

Dieses Modul ordnet developer experience und onboarding 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.

• Time to First Call als messbare Qualitätsgröße
• Sandbox, Testdaten, Beispielanwendungen und Fehlerhilfen
• Onboarding-Strecken für interne Teams, Partner und externe Entwickler
• Supportkanäle, Service Ownership und Feedbackschleifen

Schrittweise Umsetzung

1. Einen Consumer-Pfad von Discovery bis zum ersten erfolgreichen Request aufnehmen.
2. Hürden, Medienbrüche und unklare Zuständigkeiten markieren.
3. Ein geführtes Onboarding mit Sandbox, Credentials und validierbarem Beispiel gestalten.
4. Messpunkte für Durchlaufzeit, Abbruch, Supportaufwand und Zufriedenheit definieren.

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

4. mTLS, API Keys und Credential Lifecycle

Dieses Modul ordnet mtls, api keys und credential lifecycle 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.

• Client-Zertifikate, Trust Chains, Widerruf und Erneuerung
• API Keys, Rotation, Sperrung, Ablauf und sichere Zustellung
• Credential-Self-Service und Verantwortlichkeiten im Developer Portal
• Betriebliche Nachweise, Notfallwechsel und Offboarding

Schrittweise Umsetzung

1. Ein Credential-Modell nach Konsumententyp und Schutzbedarf auswählen.
2. mTLS- oder API-Key-Zugriff konfigurieren und mit gültigen Credentials prüfen.
3. Ablauf, Rotation, Sperrung und verlorene Credentials als Testfälle durchspielen.
4. Offboarding und Notfallwechsel mit Rollen, Fristen und Auditnachweis dokumentieren.

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

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

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

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
• API-Governance, API Score und Federation