API Design First
mit dem OpenAPI Code Generator
Ein 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.
Quellcode
Für die Generierung verwende ich das spring-Template des Generators.
openapi-generator generate -g spring -i artikel-api-v1.yml -o artikel-impl \
--additional-properties=apiFirst=true,delegatePattern=true,useSpringBoot3=true
Das OpenAPI Beispiel für den Generator ist hier als YAML-Datei verlinkt.
Links
- API First (Youtube)
- API First Kritik (Youtube)
- OpenAPI Generator (github)