Die Teilnehmenden lernen die Grundlagen des API-First-Ansatzes kennen und erstellen API-Spezifikationen als verbindliche Grundlage für Design, Dokumentation, Abstimmung und Implementierung von APIs. Sie können wesentliche Designentscheidungen, Versionierung, Sicherheitsanforderungen und Fehlerbehandlung in einer OpenAPI-Spezifikation berücksichtigen, die Spezifikation mit einem Mock-Server und automatischen Regelprüfungen absichern und den API-Lebenszyklus einordnen.
Überblick und Ziele: Was ist API First Design und warum ist es wichtig? Historische Entwicklung und Hauptmerkmale.
Anwendungsbereiche: Typische Anwendungsbereiche und Szenarien, in denen API First Design eingesetzt wird.
Vorteile des API First Ansatzes: Vergleich mit anderen Entwicklungsansätzen und deren Vorteile.
Grundlegende Konzepte und Prinzipien
API-Design-Prinzipien: Einführung in die Prinzipien des API-Designs (REST, GraphQL, etc.).
Dokumentation und Spezifikation: Bedeutung von gut dokumentierten APIs und gängige Spezifikationssprachen (OpenAPI, RAML, etc.).
API-Lebenszyklus: Überblick über den Lebenszyklus einer API von der Planung bis zur Stilllegung.
Werkzeuge und Technologien
API Design Tools: Vorstellung gängiger Werkzeuge wie Swagger Editor, Postman, Prism und Spectral.
API-Gateways: Einführung in die Rolle von API-Gateways und deren Nutzen.
Mocking und Testing: Werkzeuge und Techniken zur Erstellung von Mock-APIs und automatisierten Tests.
Erstellung einer API-Spezifikation
OpenAPI-Spezifikation: Erstellung einer API-Spezifikation mit OpenAPI.
Versionierung und Rückwärtskompatibilität: Umgang mit API-Versionierung und Sicherstellung der Rückwärtskompatibilität.
Security und Authentifizierung: Einführung in Sicherheitsmechanismen und Authentifizierungsstrategien (OAuth, JWT, etc.).
Praktische Übung 1: Erstellung einer API-Spezifikation
Problemstellung: Erstellung einer API-Spezifikation für einen einfachen Anwendungsfall.
Lösung: Nutzung von OpenAPI zur Erstellung der Spezifikation, Definition von Endpunkten, Datenmodellen und Sicherheitsmechanismen.
Ergebnis: Eine vollständige API-Spezifikation, die alle grundlegenden Aspekte abdeckt.
Erweiterte API-Design-Techniken
GraphQL: Einführung in GraphQL und Vergleich mit REST.
API-Komposition: Techniken zur Komposition mehrerer APIs.
API-Governance und Best Practices
API-Governance: Einführung in API-Governance und deren Bedeutung.
Design Reviews und Feedback-Schleifen: Etablierung von Design-Reviews und Feedback-Schleifen im API-Entwicklungsprozess.
Best Practices und Styleguide: Gemeinsame Designregeln festlegen und die Spezifikation automatisch dagegen prüfen.
Automatisierung und API-Management
CI/CD für APIs: Automatische Tests und Regelprüfungen der Spezifikation in CI/CD-Pipelines.
API-Management: Gateway, Developer Portal und Monitoring als Bausteine des API-Betriebs.
Sicherheitsaspekte und Fehlerbehandlung
API-Security: Authentifizierung, Autorisierung, Rate Limiting und die OWASP API Security Top 10.
Fehlerbehandlung und Statuscodes: Best Practices für Fehlerbehandlung und Nutzung von HTTP-Statuscodes.
Datenschutz und Compliance: Einführung in Datenschutz- und Compliance-Themen im Kontext von APIs.
Praktische Übung 2: Mocking und automatische Prüfung der API-Spezifikation
Problemstellung: Die Spezifikation aus Übung 1 ohne fertiges Backend nutzbar machen und gegen gemeinsame Designregeln prüfen.
Lösung: Mock-Server aus der Spezifikation starten, eigene Designregeln festlegen, die Spezifikation automatisch prüfen und die gefundenen Verstöße als Bericht für ein Ticketsystem ausgeben.
Ergebnis: Eine Spezifikation, mit der Frontend und Tests ohne fertiges Backend arbeiten können, sowie ein Regelwerk, das Designfehler automatisch meldet.
Synchronisation von Frontend und Backend
Contract-First: Die Spezifikation entsteht zuerst, der Code leitet sich davon ab.
Gemeinsame Datenmodelle als Single Source of Truth.
Code-Generierung: Modelle und Clients mit dem OpenAPI Generator aus der Spezifikation erzeugen.
Dauer/zeitlicher Ablauf:
2 Tage
Zielgruppe:
Dieses Seminar richtet sich an Softwareentwickler, API-Designer, Systemarchitekten und IT-Experten, die ihre Kenntnisse im API First Design zur Erstellung und Verwaltung von APIs erweitern möchten.
Teilnahmevoraussetzungen
Grundlegende Kenntnisse in der Webentwicklung und im Umgang mit APIs sind hilfreich
Wir setzen Analyse-Cookies ein, um Ihre Zufriedenheit bei der Nutzung unserer Webseite zu verbessern.
Diese Cookies werden nicht automatisiert gesetzt.
Wenn Sie mit dem Einsatz dieser Cookies einverstanden sind, klicken Sie bitte auf Akzeptieren.
Weitere Informationen finden Sie hier.
