Die Webapplikation stellt eine Rest API mit CRUD Methoden zur Userverwaltung zur Verfügung. Die Applikation wird innerhalb der Semesterarbeit im Modul DevOps verwendet. Die Applikation ist in Java mit Javalin implementiert.
| Endpoint | Methode | Beschreibung |
|---|---|---|
| /api/users | GET | Liefert alle User |
| /api/users/{id} | GET | Liefert den User mit der entsprechenden ID |
| /api/users | POST | Erstellt einen neuen User |
| /api/users/{id} | PUT | Aktualisiert den User mit der entsprechenden ID |
| /api/users/{id} | DELETE | Löscht den User mit der entsprechenden ID |
| Attribut | Typ | Beschreibung |
|---|---|---|
| id | Integer | ID des Users |
| name | String | Name des Users |
| String | E-Mail Adresse des Users | |
| birthYear | Integer | Geburtsjahr des Users |
Das Projekt wird mittels Gradle gebaut. Dazu muss das Projekt lokal ausgecheckt werden und im Terminal folgender Befehl ausgeführt werden:
./gradlew buildDie Applikation kann lokal gestartet werden. Dazu muss das Projekt lokal ausgecheckt werden und im Terminal folgender Befehl ausgeführt werden:
./gradlew runDie Applikation ist dann unter http://localhost:7000 erreichbar. Die Rest API ist unter http://localhost:7000/api/users erreichbar. Die Prometheus Metriken sind unter http://localhost:7000/metrics erreichbar.
Die Applikation kann auch als lokaler Docker Container gestartet werden. Dazu muss das Projekt lokal ausgecheckt werden und im Terminal folgender Befehl ausgeführt werden:
./gradlew jibDockerBuildDie Applikation wird als Docker Container via Google Cloud Registry auf Google Cloud Run deployed. Sie ist unter https://devops-d4bqj7s2iq-ez.a.run.app erreichbar.
Die Dokumentation zur Semesterarbeit wird im Ordner /Documentation versioniert.