API Design mit OpenAPI

-- Beschreibung

In diesem zweitägigen Training lernst du, wie HTTP APIs entworfen und mit Hilfe von OpenAPI dokumentiert werden. Am Ende wirst du in der Lage sein, die erlernten Konzepte in eigenen Projekten anzuwenden und gelungene HTTP APIs zu entwerfen.

Ein Schwerpunkt des Trainings liegt auf dem Einsatz von Best Practices beim Design der Schnittstelle und der Einhaltung wichtiger Qualitätsmerkmale, wie Konsistenz, Verständlichkeit und Erweiterbarkeit. Zudem werden weitere wichtige Themen für API-Anbieter diskutiert, wie etwa Strategien für die Versionierung von APIs, Dokumentation und API Design Guidelines.

Warum API Design wichtig ist: HTTP APIs haben sich in den vergangenen Jahren als eines der wichtigsten Werkzeuge zur Systemintegration etabliert. Früher oder später steht jede(r) Entwickler:in vor der Aufgabe, eine solche Schnittstelle zu implementieren. Da der reine Programmieraufwand überschaubar ist, kommt in der Hektik des Projektalltags leider häufig das Design der Schnittstelle zu kurz. Dies führt dann mittelfristig zu allerlei unschönen Herausforderungen, etwa wenn die Schnittstelle sich als schlecht verständlich erweist oder nur schwierig erweiterbar ist. Daher ist es wichtig, sich bereits vor Inbetriebnahme einer Schnittstelle eingehende Gedanken über das API Design zu machen. In diesem Training lernst du, worauf hierbei zu achten ist.

-- Agenda

Das 2-tägige Training findet remote von 09:00-17:00 Uhr statt.

• Kurze Einführung in die Welt der APIs
• Warum ist API Design wichtig?
• Qualitätsmerkmale von APIs
• Konsequenzen von schlechtem API Design
• APIs für Außenstehende verständlich machen (Endpunkte, Attribute, Fehler)
• API Spezifikation mit OpenAPI und JSON Schema
• Typische Fragestellungen beim API Design, Lösungsansätze, Best Practices
• Anti-Patterns: Was sollte man beim API Design vermeiden?
• Rückwärtskompatibilität und Breaking Changes
• API Versionierung: Strategien und technische Umsetzungsmöglichkeiten
• Sicherheitsaspekte beim API Design
• Existierende Standards & Vorschläge für API Design: OData, JSON:API, JSON-HAL
• API Design Guidelines bekannter Unternehmen
• API Design Reviews
• Wie erschaffe ich eine großartige Developer Experience für API Client Developer?
• Über den Tellerrand: Asynchrone APIs und AsyncAPI

-- Zielgruppe

Diese Schulung richtet sich an Software-Entwickler:innen, die HTTP APIs erstellen möchten, aber bislang noch wenig Erfahrung mit dem Design solcher Schnittstellen sammeln konnten, oder aber ihre bisherigen Kenntnisse vertiefen möchten. Ebenso eignet sie sich für API-Beauftragte von Unternehmen, die etwa einen API Styleguide entwickeln und hierzu für unterschiedliche Aspekte des API Designs etwaige Design-Alternativen kennenlernen und diskutieren möchten.