chore: updated app

Author: chrootlogin

.gitignore

@@ -1,6 +1,8 @@
 HELP.md
 target/
 .mvn/wrapper/maven-wrapper.jar
+.mvn/wrapper/dists/
+.mvn/apache-maven-*/
 !**/src/main/**/target/
 !**/src/test/**/target/
 

README.md

@@ -1,6 +1,6 @@
 # DB-2 Ticket System Starter
 
-Dieses Projekt ist das kleine Spring-Boot-Starterprojekt fuer **Database Development**. Es ist bewusst kein fertiges Ticket-System. Die Anwendung zeigt die Layer-Struktur, laeuft gegen PostgreSQL und enthaelt gezielte Luecken, damit die Datenbanklogik im Unterricht selbst entwickelt wird.
+Dieses Projekt ist das kleine Spring-Boot-Starterprojekt für **Database Development**. Es ist bewusst kein fertiges Ticket-System. Die Anwendung zeigt die Layer-Struktur, läuft gegen PostgreSQL und enthält gezielte Lücken, damit die Datenbanklogik im Unterricht selbst entwickelt wird.
 
 ## Technischer Rahmen
 
@@ -10,24 +10,25 @@ Dieses Projekt ist das kleine Spring-Boot-Starterprojekt fuer **Database Develop
 - Flyway
 - PostgreSQL
 - Maven Wrapper
-- Lombok fuer DTOs, Entities und einfache Datenklassen
+- Lombok für DTOs, Entities und einfache Datenklassen
+- Swagger UI und OpenAPI über springdoc-openapi
 
 ## Code-Guidelines
 
 - Verwende in diesem Kursprojekt **keine Java Records**.
-- Verwende fuer einfache Datenklassen Lombok:
-  - `@Value` fuer unveraenderliche Antwort-DTOs und Value-Objekte
-  - `@Data` fuer JPA Entities, Request-DTOs und mutable Framework-Modelle
+- Verwende für einfache Datenklassen Lombok:
+  - `@Value` für unveränderliche Antwort-DTOs und Value-Objekte
+  - `@Data` für JPA Entities, Request-DTOs und mutable Framework-Modelle
 - Nutze Maven als Build-Werkzeug; der Maven Wrapper ist Teil des Projekts.
 - Schreibe modernen Java-24-Code. Nutze Streams dort, wo sie Lesbarkeit und Datenfluss verbessern, aber nicht als Selbstzweck.
-- Datenbankregeln gehoeren nicht nur in Java-Validierung. Zentrale Invarianten muessen auch in PostgreSQL sichtbar sein.
+- Datenbankregeln gehören nicht nur in Java-Validierung. Zentrale Invarianten müssen auch in PostgreSQL sichtbar sein.
 
 ## Start
 
 Die DB-2-PostgreSQL-Umgebung muss laufen:
 
 ```bash
-cd ../../postgres
+cd ../db-2/postgres
 podman compose up -d
 ```
 
@@ -37,16 +38,16 @@ Danach kann die Anwendung gestartet werden:
 ./mvnw spring-boot:run
 ```
 
-Die Anwendung verwendet die Datenbank `ticket_system` auf Port `5433`, schreibt aber in ein eigenes Schema `app_starter`. Dadurch bleibt das vollstaendige Unterrichtsschema aus `db-2/postgres` als Referenz erhalten.
+Die Anwendung verwendet die Datenbank `ticket_system` auf Port `5433`, schreibt aber in ein eigenes Schema `app_starter`. Dadurch bleibt das vollständige Unterrichtsschema aus `db-2/postgres` als Referenz erhalten.
 
 ## Guided Gaps
 
-Die erste Migration ist absichtlich schwach. Sie laesst Dinge offen, die Studierende fachlich entscheiden sollen:
+Die erste Migration ist absichtlich schwach. Sie lässt Dinge offen, die Studierende fachlich entscheiden sollen:
 
 - Welche Felder braucht ein minimales Ticket wirklich?
-- Welche Spalten duerfen nie `NULL` sein?
-- Welche Statuswerte gehoeren als `CHECK` Constraint in die Datenbank?
-- Welche Regeln gehoeren in PostgreSQL, welche in den Service-Layer?
+- Welche Spalten dürfen nie `NULL` sein?
+- Welche Statuswerte gehören als `CHECK` Constraint in die Datenbank?
+- Welche Regeln gehören in PostgreSQL, welche in den Service-Layer?
 - Welche Repository-Methode bleibt lesbar?
 
 Normale Tests laufen mit:
@@ -61,29 +62,29 @@ Ein Integrationstest mit Testcontainers startet eine frische PostgreSQL-Datenban
 ./mvnw -Ptestcontainers test
 ```
 
-Ein Docker-Compose-Test gegen die lokale DB-2-PostgreSQL-Umgebung laeuft mit:
+Ein Docker-Compose-Test gegen die lokale DB-2-PostgreSQL-Umgebung läuft mit:
 
 ```bash
-cd ../../postgres
+cd ../db-2/postgres
 podman compose up -d
-cd ../app/ticket-system-java
+cd ../../db-2-app
 ./mvnw -Pdocker-compose test
 ```
 
-Die aktivierbare Engineering-Aufgabe laeuft mit:
+Die aktivierbare Engineering-Aufgabe läuft mit:
 
 ```bash
 ./mvnw -Pguided-gaps test
 ```
 
-Dieser Test schlaegt am Anfang erwartbar fehl. Er wird erst gruen, wenn die Migration datenbankseitige Regeln enthaelt.
+Dieser Test schlägt am Anfang erwartbar fehl. Er wird erst grün, wenn die Migration datenbankseitige Regeln enthält.
 
 ## Teststrategie
 
 - `./mvnw test`: schnelle Tests ohne Docker.
 - `./mvnw -Ptestcontainers test`: echte PostgreSQL-Integration mit isolierter Testcontainers-Datenbank.
-- `./mvnw -Pdocker-compose test`: Pruefung gegen die Kursdatenbank aus `db-2/postgres/docker-compose.yml`.
-- `./mvnw -Pguided-gaps test`: bewusst fehlschlagende Engineering-Aufgabe fuer fehlende Datenbankregeln.
+- `./mvnw -Pdocker-compose test`: Prüfung gegen die Kursdatenbank aus `db-2/postgres/docker-compose.yml`.
+- `./mvnw -Pguided-gaps test`: bewusst fehlschlagende Engineering-Aufgabe für fehlende Datenbankregeln.
 
 ## Docker
 
@@ -95,19 +96,27 @@ podman compose up --build
 
 Danach ist die API unter `http://localhost:8080/api/tickets` erreichbar.
 
-## API fuer Block 2
+## Swagger und OpenAPI
+
+Die API-Dokumentation ist in der laufenden Anwendung verfügbar:
+
+- Root: `http://localhost:8080/` leitet auf Swagger UI weiter.
+- Swagger UI: `http://localhost:8080/swagger-ui.html`
+- OpenAPI JSON: `http://localhost:8080/v3/api-docs`
+
+## API für Block 2
 
 ```http
 GET /api/tickets
 GET /api/tickets?status=open
 POST /api/tickets
 ```
 
-Beispiel fuer `POST /api/tickets`:
+Beispiel für `POST /api/tickets`:
 
 ```json
 {
-  "title": "Datenbankverbindung pruefen",
+  "title": "Datenbankverbindung prüfen",
   "status": "open"
 }
 ```

compose.yml

@@ -1,6 +1,6 @@
 services:
   postgres:
-    image: postgres:17-alpine
+    image: postgres:17
     environment:
       POSTGRES_DB: ticket_system
       POSTGRES_USER: ticket_user

pom.xml

@@ -39,6 +39,11 @@
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-flyway</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.springdoc</groupId>
+            <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
+            <version>3.0.3</version>
+        </dependency>
         <dependency>
             <groupId>org.flywaydb</groupId>
             <artifactId>flyway-database-postgresql</artifactId>

src/main/java/ch/hftm/db2/ticketsystem/OpenApiConfig.java

@@ -0,0 +1,16 @@
+package ch.hftm.db2.ticketsystem;
+
+import io.swagger.v3.oas.annotations.OpenAPIDefinition;
+import io.swagger.v3.oas.annotations.info.Info;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+@OpenAPIDefinition(
+        info = @Info(
+                title = "DB-2 Ticket System API",
+                version = "0.1.0",
+                description = "Spring-Boot-Starterprojekt für DB-2 mit bewusst offenen Guided Gaps in der Datenbanklogik."
+        )
+)
+class OpenApiConfig {
+}

src/main/java/ch/hftm/db2/ticketsystem/SwaggerRedirectController.java

@@ -0,0 +1,15 @@
+package ch.hftm.db2.ticketsystem;
+
+import io.swagger.v3.oas.annotations.Hidden;
+import org.springframework.stereotype.Controller;
+import org.springframework.web.bind.annotation.GetMapping;
+
+@Hidden
+@Controller
+class SwaggerRedirectController {
+
+    @GetMapping("/")
+    String redirectToSwagger() {
+        return "redirect:/swagger-ui.html";
+    }
+}

src/main/java/ch/hftm/db2/ticketsystem/ticket/CreateTicketRequest.java

@@ -1,5 +1,6 @@
 package ch.hftm.db2.ticketsystem.ticket;
 
+import io.swagger.v3.oas.annotations.media.Schema;
 import jakarta.validation.constraints.NotBlank;
 import lombok.AllArgsConstructor;
 import lombok.Data;
@@ -8,11 +9,14 @@
 @Data
 @NoArgsConstructor
 @AllArgsConstructor
+@Schema(description = "Eingabe für ein neues Starter-Ticket")
 class CreateTicketRequest {
 
     @NotBlank
+    @Schema(description = "Kurzer Tickettitel", example = "Datenbankverbindung prüfen")
     private String title;
 
     @NotBlank
+    @Schema(description = "Ticketstatus im Starterprojekt", example = "open")
     private String status;
 }

src/main/java/ch/hftm/db2/ticketsystem/ticket/TicketController.java

@@ -1,18 +1,17 @@
 package ch.hftm.db2.ticketsystem.ticket;
 
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.validation.Valid;
-import java.util.List;
 import org.springframework.http.HttpStatus;
-import org.springframework.web.bind.annotation.GetMapping;
-import org.springframework.web.bind.annotation.PostMapping;
-import org.springframework.web.bind.annotation.RequestBody;
-import org.springframework.web.bind.annotation.RequestMapping;
-import org.springframework.web.bind.annotation.RequestParam;
-import org.springframework.web.bind.annotation.ResponseStatus;
-import org.springframework.web.bind.annotation.RestController;
+import org.springframework.web.bind.annotation.*;
+
+import java.util.List;
 
 @RestController
 @RequestMapping("/api/tickets")
+@Tag(name = "Tickets", description = "Ticket Controller")
 class TicketController {
 
     private final TicketService ticketService;
@@ -22,14 +21,18 @@ class TicketController {
     }
 
     @GetMapping
-    List<TicketResponse> findTickets(@RequestParam(required = false) String status) {
+    @Operation(summary = "Tickets lesen", description = "Liest alle Tickets oder filtert nach einem Status.")
+    List<TicketResponse> findTickets(
+            @Parameter(description = "Optionaler Statusfilter, zum Beispiel open")
+            @RequestParam(required = false) String status
+    ) {
         return ticketService.findTickets(status);
     }
 
     @PostMapping
     @ResponseStatus(HttpStatus.CREATED)
+    @Operation(summary = "Ticket erstellen", description = "Erstellt ein minimales Ticket im Starter-Schema app_starter.")
     TicketResponse createTicket(@Valid @RequestBody CreateTicketRequest request) {
         return ticketService.createTicket(request);
     }
 }
-

src/main/java/ch/hftm/db2/ticketsystem/ticket/TicketEntity.java

@@ -1,16 +1,12 @@
 package ch.hftm.db2.ticketsystem.ticket;
 
-import jakarta.persistence.Column;
-import jakarta.persistence.Entity;
-import jakarta.persistence.GeneratedValue;
-import jakarta.persistence.GenerationType;
-import jakarta.persistence.Id;
-import jakarta.persistence.Table;
-import java.time.OffsetDateTime;
+import jakarta.persistence.*;
 import lombok.AccessLevel;
 import lombok.Data;
 import lombok.NoArgsConstructor;
 
+import java.time.OffsetDateTime;
+
 @Entity
 @Table(name = "tickets", schema = "app_starter")
 @Data

src/main/java/ch/hftm/db2/ticketsystem/ticket/TicketRepository.java

@@ -1,8 +1,9 @@
 package ch.hftm.db2.ticketsystem.ticket;
 
-import java.util.List;
 import org.springframework.data.jpa.repository.JpaRepository;
 
+import java.util.List;
+
 interface TicketRepository extends JpaRepository<TicketEntity, Long> {
 
     List<TicketEntity> findByStatusOrderByCreatedAtDesc(String status);