OpenAPI (Swagger): REST APIs designen & dokumentieren

In der modernen Softwareentwicklung sind APIs das Bindeglied zwischen Systemen. Doch eine API ist nur so gut wie ihre Dokumentation. Hier kommt die OpenAPI Specification (OAS) ins Spiel.

Dieser Kurs ist ein umfassender Leitfaden, um REST-APIs professionell zu planen, zu strukturieren und für andere verständlich aufzubereiten. Wir starten bei den absoluten Grundlagen von REST und HTTP und arbeiten uns bis hin zur komplexen Definition von Schemata und dem Einsatz mächtiger Tools wie Swagger UI und dem OpenAPI Generator vor. Dabei ist es egal, ob ihr nach dem Design-First-Ansatz erst die Spezifikation schreibt oder bestehenden Code dokumentieren wollt.

In diesem Kurs lernt ihr das nötige Wissen für beide Ansätze. Das werdet ihr lernen: Fundament: HTTP-Methoden, HTTP-Statuscodes und Datenformate (JSON/YAML) verstehenStruktur: Das OpenAPI-Schema (Paths, Parameters, Components, Security etc.) beherrschenBest Practices: Den Unterschied zwischen Design-First und Code-First kennen und beide Ansätze anwendenTooling: Swagger Editor, Swagger UI und ReDoc für interaktive Dokumentationen nutzenAutomatisierung: Mit dem OpenAPI Generator Code aus Spezifikationen generierenFür wen ist dieser Kurs geeignet? Backend-Entwickler, die ihre Schnittstellen sauber dokumentieren und standardisieren möchten.

Frontend-Entwickler, die besser verstehen wollen, wie sie API-Definitionen lesen und nutzen. Software-Architekten, die moderne API-Standards in ihren Projekten etablieren wollen. Product Owner & Technical Writers, die eine Schnittstelle zwischen Technik und Business bilden.