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

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

Mit dem exponentiellen Wachstum von APIs steigt auch die Notwendigkeit für qualitativ hochwertige API-Entwicklung. Leider sind viele APIs schlecht entwickelt, was zu einer ineffizienten Nutzung und schlechter Developer Experience führt. In unserem Workshop zeigen wir Ihnen, wie Sie effiziente und benutzerfreundliche APIs entwickeln.

Der erste Workshop-Tag widmet sich den Grundlagen und der Einführung in HTTP und REST. Dabei mischen wir grundsätzlich Theorie- und Praxisblöcke, in denen wir auf die wichtigsten Erkenntnisse und Antipatterns eingehen. Für das Design einer beispielhaften REST API arbeiten Sie in Kleingruppen.

Der zweite Workshop-Tag beinhaltet die Themen “gutes” API-Design und eine Einführung in die OpenAPI-Spezifikation. Auch hier vertiefen wir die Lerninhalte durch die Arbeit in Kleingruppen. Zusätzlich wenden wir einige Werkzeuge praktisch an, die helfen, qualitativ hochwertige OpenAPI-Beschreibungen zu erstellen.

Der Workshop ist interaktiv gestaltet und besteht aus Theorie- und Praxisblöcken. Anhand von Beispielen aus unserer langjährigen Praxiserfahrung und Übungen in Kleingruppen vermitteln wir nicht nur Wissen, sondern ermöglichen den Teilnehmenden, dieses 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

Die Schulung richtet sich an Entwickler und Entwicklerinnen, die HTTP, REST und OpenAPI noch nicht angewendet haben oder ihr Wissen bzgl. der Standards auffrischen möchten. Besonders wichtig sind diese Standards für Entwicklungsteams, deren APIs von anderen Teams oder sogar Externen verwendet werden.

Voraussetzungen

Für eine erfolgreiche Teilnahme an dem Workshop wird grundlegende Programmiererfahrung vorausgesetzt.

Um an den interaktiven Übungen teilnehmen zu können, benötigen Sie

• eine Kamera und ein Headset

• ein Browser nach Wahl

• eine IDE der Wahl (am besten jedoch Visual Studio Code)

• der Node Package Manager (npm)

• und Git.

Zur Workshop-Durchführung wird Zoom verwendet mittels eines DSGVO-konformen On-Premise-Connectors. Wir bitten Sie, ein Mikrofon oder Headset sowie einen aktuellen Browser zu nutzen.

Leistungen Ihres Workshoptickets

• Workshopunterlagen

• Teilnahmebescheinigung

Durchführung

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

Die Teilnehmerzahl ist auf max. 20 Personen begrenzt.