API-Design und -Entwicklung mit HTTP, REST und OpenAPI

Mit dem exponentiellen Wachstum von APIs steigt auch die Notwendigkeit einer qualitativ hochwertigen API-Entwicklung. Leider sind viele APIs schlecht entwickelt, was zu einer ineffizienten Nutzung und einer schlechten Developer Experience führt. In diesem Workshop lernen Sie, wie Sie effiziente und benutzerfreundliche APIs entwickeln.

Dieser Workshop widmet sich folgenden Lerninhalten:

• Korrekte Anwendung der HTTP- und REST-Standards: Eine fehlerhafte Nutzung dieser Standards führt zu Zeitverlusten und erschwert die API-Nutzung. Nur wer die Standards gut kennt, kann sie einhalten und sinnvolle Abweichungen davon transparent kommunizieren.

• Standardisierte Referenzdokumentation: Fehlende oder schlechte Dokumentation beeinträchtigt die Nutzererfahrung und zwingt zu unnötigem Kontakt mit den Entwicklungsteams. Die Dokumentation von RESTful APIs mit OpenAPI ist weit verbreitet und wird von vielen Open-Source-Tools unterstützt, was Effizienz und Nutzererfahrung verbessert.

• Einheitlichkeit von APIs: Uneinheitliche APIs erschweren die Wissensübertragung von einer API auf eine andere. Durch die Einhaltung und automatische Überprüfung von Standards wird ein konsistentes Nutzererlebnis gefördert, das den Lernfortschritt auf andere APIs übertragbar macht.

Inhalte

Der Workshop startet mit den Grundlagen von HTTP und REST. Sie setzen sich intensiv mit den Kernkonzepten von HTTP und REST auseinander, lernen die wichtigsten Konzepte sowie häufige Fehlerquellen (Antipatterns) kennen und verstehen den Aufbau von HTTP-Nachrichten, Methoden und Statuscodes. Zudem erfahren Sie, wie Sie Ressourcen sinnvoll modellieren. In Kleingruppen erarbeiten Sie anschließend das Design einer beispielhaften REST-API und setzen das Gelernte direkt um.

Am zweiten Tag stehen „gutes“ API-Design und die OpenAPI-Spezifikation im Fokus. Sie lernen, wie Sie die Qualität Ihrer API-Beschreibungen mit Tools prüfen und automatisiert testen, um die Effizienz im Entwicklungsprozess zu steigern. Darüber hinaus werden weiterführende Themen wie Versionierung, Pagination und Fehlerbehandlung behandelt, die für den professionellen Betrieb von APIs unerlässlich sind. Auch hier vertiefen Sie die Lerninhalte durch praktische Gruppenarbeit.

Der Workshop ist interaktiv gestaltet und besteht aus Theorie- und Praxisblöcken. Anhand von Beispielen aus der langjährigen Praxiserfahrung der Trainer sowie durch Übungen in Kleingruppen haben Sie die Möglichkeit, das Gelernte direkt anzuwenden und zu vertiefen.

Themen in der Übersicht

• 1. Grundlagen

  • Was ist eine API (und was nicht)?

• 2. HTTP-Protokoll

  • Was ist HTTP?

  • Wie sind HTTP-Nachrichten aufgebaut?

  • Was ist eine URL?

  • HTTP-Methoden

  • HTTP-Statuscodes

• 3. REST

  • Was ist REST?

  • Welchen Prinzipien / Einschränkungen folgt REST?

  • Was ist eine Ressource?

  • Was ist für eine einheitliche Schnittstelle wichtig?

• 4. API-Design & OpenAPI

  • Was verbirgt sich hinter der API-First-Designphilosophie?

  • Wofür brauche ich eine gute API-Beschreibung?

  • Was ist die OpenAPI-Spezifikation?

  • Wie erstelle ich eine OpenAPI-Beschreibung für eine REST API?

• 5. OpenAPI Werkzeuge

  • Wie überprüfe ich die Qualität meiner OpenAPI-Definition?

  • Wie kann ich meine API automatisiert mit OpenAPI testen?

  • Was für andere hilfreiche Werkzeuge gibt es?

• 6. Weiterführende Themen für gutes API Design

  • Versionierung & Breaking Changes

  • Pagination

  • Fehlerbehandlung

Zielgruppe

Entwickler ohne Vorerfahrung mit HTTP, REST und OpenAPI, die eine grundlegende Einführung in diese Standards erhalten möchten

Entwickler mit ersten Erfahrungen in HTTP, REST und OpenAPI, die ihr Wissen auffrischen und vertiefen möchten und/oder deren APIs von anderen Teams oder externen Partnern genutzt werden

Voraussetzungen

• Vorkenntnisse

  • Grundlegende Programmiererfahrung

• Technische Voraussetzung

  • Entwicklungsumgebung (IDE), z. B. Visual Studio Code

  • Node Package Manager (npm)

  • Git

Leistungen Ihres Workshoptickets

• Sie erhalten Ihre Schulungsunterlagen in digitaler Form. So können Sie selbst entscheiden, ob Sie diese elektronisch bearbeiten und archivieren oder lieber ausdrucken möchten.

• Mit der Teilnahmebescheinigung unterstreichen Sie Ihr Weiterbildungsengagement und verbessern Ihre Perspektiven für interne Karriereschritte oder neue berufliche Wege.

Durchführung

Sie nehmen über Zoom am Workshop teil, wobei die Verbindung über einen lokal gehosteten, DSGVO-konformen On-Premises-Connector erfolgt.

Um einen intensiven Austausch zwischen dem Trainer und den Teilnehmenden zu gewährleisten, erfolgt die Schulung in Gruppen von höchstens 20 Personen.

Sollte die Durchführung der Veranstaltung aufgrund höherer Gewalt, der Verhinderung eines Referenten, von Störungen am Veranstaltungsort oder wegen zu geringer Teilnehmerzahl nicht möglich sein, werden die Teilnehmenden so früh wie möglich informiert.