Seminar Micronaut – API-Entwicklung mit REST, OpenAPI und HTTP-Clients

Stabile APIs benötigen mehr als Controller und JSON. Das Seminar führt von einem fachlich belastbaren Vertrag über REST-Endpunkte, Validierung, Fehlerbehandlung und deklarative HTTP-Clients bis zu OpenAPI-Dokumentation, Versionierung, Sicherheit und automatisierten Vertragstests.

Inhaltsübersicht

• Zielsetzung
• Zielgruppe
• Voraussetzungen
• Seminarinhalte
• Praxisübungen
• Methodik

Zielsetzung

• Ressourcenorientierte HTTP-APIs mit eindeutigen Verträgen entwerfen
• Controller, Bindung, Validierung, Serialisierung und Fehlerantworten konsistent umsetzen
• Deklarative HTTP-Clients mit Timeouts, Resilienz und nachvollziehbarer Diagnose entwickeln
• OpenAPI, Versionierung und automatisierte API-Tests in den Lieferprozess integrieren

Zielgruppe

Backend- und API-Entwickler, Integrationsentwickler, Softwarearchitekten und technische Leads.

Voraussetzungen

Gute Java- oder Kotlin-Kenntnisse, Micronaut-Grundlagen sowie sicheres Verständnis von HTTP, JSON und automatisierten Tests.

Seminarinhalte

1. Schritt 1: Fachliche API-Grenzen bestimmen

   Anwendungsfälle, Ressourcen, Zuständigkeiten, Konsistenzgrenzen und externe Abhängigkeiten werden beschrieben. Endpunkte werden erst nach der fachlichen Abgrenzung festgelegt.

2. Schritt 2: HTTP-Vertrag modellieren

   Methoden, Pfade, Statuscodes, Header, Medienformate, Idempotenz und Nebenwirkungen werden für typische Lese- und Schreibvorgänge definiert.

3. Schritt 3: Projekt und Controller strukturieren

   Pakete, Controller, Services, DTOs und Mapper werden getrennt aufgebaut. Routen, Pfadparameter, Query-Parameter und Headerbindung werden umgesetzt.

4. Schritt 4: Eingaben binden und validieren

   Request Bodies, Formate, optionale Werte, Bean Validation, Validierungsgruppen und fachliche Prüfungen werden in einer eindeutigen Reihenfolge angewendet.

5. Schritt 5: Serialisierung kontrollieren

   DTOs, Datums- und Zahlenformate, Nullwerte, Enums, Polymorphie und unbekannte Felder werden so konfiguriert, dass der Vertrag stabil und prüfbar bleibt.

6. Schritt 6: Fehlerantworten vereinheitlichen

   Technische und fachliche Ausnahmen werden getrennt. Fehlercodes, Meldungen, Feldfehler, Korrelationskennungen und Protokollierung werden über zentrale Handler erzeugt.

7. Schritt 7: Filter und Querschnittsfunktionen einsetzen

   Request- und Response-Filter übernehmen Korrelation, Protokollierung, Headerregeln und ausgewählte Sicherheitskontrollen, ohne Fachlogik in die Transportschicht zu verlagern.

8. Schritt 8: Deklarative HTTP-Clients entwickeln

   Client-Schnittstellen, Basisadressen, Bindung, Fehlerabbildung und Authentifizierungsheader werden eingerichtet. Synchroner und reaktiver Aufruf werden passend zum Anwendungsfall gewählt.

9. Schritt 9: Timeouts und Resilienz festlegen

   Verbindungs- und Lesetimeouts, Wiederholungen, Circuit Breaker, Fallbacks und Bulkheads werden auf idempotente Vorgänge und fachliche Fehlergrenzen abgestimmt.

10. Schritt 10: OpenAPI-Beschreibung erzeugen

    Operationen, Schemas, Beispiele, Fehlerantworten, Sicherheitsanforderungen und Tags werden aus dem Code und ergänzenden Metadaten zu einer konsistenten Spezifikation zusammengeführt.

11. Schritt 11: Versionierung und Kompatibilität planen

    Additive Änderungen, Deprecation, Pfad- und Header-Versionierung, Medienformate und Übergangsfristen werden anhand konkreter Änderungsfälle bewertet.

12. Schritt 12: API automatisiert testen

    Controller-, Client-, Integrations- und Vertragstests prüfen Statuscodes, Header, Payloads, Validierung, Fehlerfälle und Abwärtskompatibilität.

13. Schritt 13: Bereitstellung und Betrieb absichern

    Health-Prüfungen, Metriken, Trace-Kontext, sichere Konfiguration, Limits und eine kontrollierte Veröffentlichung der Spezifikation werden in den Betriebsablauf integriert.

Praxisübungen

• Versionierbare Ressourcen-API
• Deklarativer Client mit Timeout-, Retry- und Fehlerregeln
• Erzeugung und Qualitätsprüfung einer OpenAPI-Spezifikation
• Vertragstests für kompatible und inkompatible Änderungen

Methodik

Kurze fachliche Einordnungen wechseln mit Demonstrationen und schrittweisen Übungen. Jeder Arbeitsstand wird gebaut, ausgeführt und durch automatisierte oder betriebliche Prüfungen abgesichert. Fehlerfälle werden bewusst einbezogen, damit Diagnose und Wiederanlauf nicht erst im Produktivbetrieb entstehen.