API Design First mit dem OpenAPI Code Generator

Der #OpenAPI Generator erzeugt aus einer #API Beschreibung Quellcode für Client und Server. Im Video wird gezeigt, wie mit dem #openapi-generator ein Spring Boot Projekt erzeugt werden kann. Das Projekt kann später durch ein erneutes Ausführen des Generators erweitert und modifiziert werden. Das Werkzeug unterstützt den Design First Ansatz, der auch mit API Design First oder Contract First bezeichnet wird. In CI/CD Pipelines kann die Code Generierung integriert werden.

00:00 Einleitung
01:03 OpenAPI
02:08 JSON Schema
03:03 openapi-generator
05:52 Spring Boot 3
06:36 Code Generator Maven Plugin
08:11 Test in der Swagger UI
08:47 Generierter Code
11:41 Endpoint Implementierung
14:25 Erneutes Generieren

Quellcode der OpenAPI, Links und die Kommandozeile findest du hier:

Schulungen Online, in Bonn oder als Firmenseminar:

APIs mit REST, OpenAPI & GraphQL für Einsteiger

OpenAPI - Design, Dokumentation und Qualitätssicherung im API Lifecycle

Intensivkurs Softwarearchitektur: Paradigmen, Technik und Praxis

Für jeden eurer Kommentare unter dem Video spendet die predic8 5 € an das openapi-generator Projekt. Ausgenommen sind Kommentare die von Bots oder über ein API eingestellt wurden. Eine Person kann mehrere Kommentare abgeben, diese sollten zur Diskussion beitragen.

Mich, Thomas Bayer findet ihr auf:

Twitter: @thomasub

[mirageman]

Na das ist ja sehr großzügig von euch, äußerst lobenswert.

[__-xele]

Mehr :D Sehr gute Videos, sehr informativ, hilfreich und vor allem praxisnah. vielen Dank!

[stg]

Wie immer methodisch super aufgebaut. Und klasse Aktion.

[yasinicdeniz]

Danke für den Content. Habe täglich darauf gewartet.

[Tkwe]

Erst einmal finde ich es richtig cool wie schnell und einfach das ganze funktioniert. Man kann sich allerdings darüber streiten wie sinnvoll dieser Ansatz auf einer höheren Ebene ist. Software sollte immer einen Wert schaffen und dieser Wert ist üblicherweise nicht die Api. Die Api ist Mittel zum Zweck, damit man eine Verbindung zwischen Frontend und Backend hinbekommt. Wenn ich allerdings zuerst die Api schreibe und dann erst die Logik dahinter, dann lenke ich den Fokus sehr auf die Daten, die ausgetauscht werden sollen. Dabei sollte meiner Meinung nach eher das Domänenmodell und die dahinter stehende Logik die Änderungen treiben. Also zuerst Domänenmodell anpassen, herausfinden was sich jetzt eigentlich wirklich ändert und angepasst werden muss und dann die Api an die Änderungen in der Domäne anpassen.

[artursp.]

Super Video. Ein Vergleich mit gRPC wäre interessant.