Compare commits

...
4 Commits
Author SHA1 Message Date
Technoir d8b5c64cf7 update docu 2026-10-19 22:22:52 +02:00
Technoir 1d155c25fd Constraint für LÄnge der Eingabe eingefÜgt 2026-10-19 22:22:47 +02:00
Technoir a6e77fc107 wsp 2026-10-19 22:22:35 +02:00
Technoir c9132be067 update d-a.md 2026-10-19 22:22:28 +02:00
9 changed files with 45 additions and 19 deletions

No files matched your search

+4 -2
View File
@@ -30,6 +30,8 @@ Die Webseite selbst ist so ziemlich im Frontend benutzbar.
Ein Neuladen der Seite ist nicht nötig, mit Ausnahme wenn man
zwischen Listen und der Listenübersicht wechselt.
Mehr über die Architektur findet sich unter [`docs/`](docs/DATENMODELL-ARCHITEKTUR.md)
### Backend
Für das Backend wurde Spring mit Thymeleaf für das Bereitstellen von Seiten genutzt (`src/main/java/de/timaldinger/einkaufsliste`).
@@ -48,7 +50,7 @@ Hinweis: Kategorien und Gegenstände können bearbeitet werden indem man auf sie
| `/api/categories` | GET, POST, DELETE, PATCH | Kategorien |
| `/api/items` | GET, POST, DELETE, PATCH | Gegenstände |
Die vollständige API-Dokumentation befindet sich unter [`/docs/`](/docs/API.md)
Die vollständige API-Dokumentation befindet sich unter [`docs/`](/docs/API.md)
## Aufsetzen
@@ -67,7 +69,7 @@ Nun kann man im Browser `localhost:8080` aufrufen.
### Weitere Dokumentation
Weitere Dokumentation befindet sich unter [`/docs/`](/docs)
Weitere Dokumentation befindet sich unter [`docs/`](/docs)
### Nutzung von KI
+2 -1
View File
@@ -8,7 +8,8 @@ Die API versucht möglichst RESTful zu sein. Es hat:
Die Schnittstelle erfolgt vollständig über JSON.
Es wurde auf Cache-fähigkeit verzichtet aus Zeitgründen. HATEOAS ist auch nicht vorhanden, da Zeitgründe und fragwürdig, ob es für ein Projekt diesen Umfang nötig ist.
Es wurde auf Cache-fähigkeit verzichtet aus Zeitgründen. HATEOAS ist auch nicht vorhanden,
da Zeitgründe und fragwürdig, ob es für ein Projekt diesen Umfangs nötig ist.
## API Pfade
+11 -6
View File
@@ -1,7 +1,7 @@
# Datenmodell und Architektur
Das Projekt nutzt die Modelle `ShoppingList`, `ShoppingItem` und `ShoppingCategory`.
Neben den Spring und Thymeleaf Bibliotheken wurde noch zusätzlich lombok genutzt.
Neben den Spring und Thymeleaf Bibliotheken wurde noch zusätzlich `lombok` genutzt.
Lombok stellt Annotationen bereit um Boilerplatecode zu vermeiden.
## Diagramm
@@ -17,12 +17,12 @@ erDiagram
### ShoppingList
Eine ShoppingList hat beliebige ShoppingCategory und ShoppingItem.
Eine ShoppingList hat beliebig viele ShoppingCategory und ShoppingItem.
Der Name darf nicht leer sein.
### ShoppingCategory
Eine ShoppingCategory hat beliebige ShoppingItem.
Eine ShoppingCategory hat beliebig viele ShoppingItem.
Der Name darf nicht leer sein.
### ShoppingItem
@@ -39,6 +39,7 @@ ausfüllen muss.
### Controller (`Controller/`)
Hier liegen die Controller welche HTTP-Anfragen abwickeln.
`PageController` ist zuständig für das Bereitstellen von den einzelnen Seiten.
Die restlichen Controller sind RESTController, welche die API-Schnittstelle
behandeln. Sie sind nach der betroffenen Ressource aufgeteilt.
@@ -82,7 +83,8 @@ so abgebildet wie sie in der Klasse definiert sind. Auch sind Relationen
der Entities wie sie in der Datenbank seien sollen abgebildet mit
Annotationen wie `@ManyToOne`. Es gibt eine abstrakte Klasse `ShoppingElement`,
von welcher alle anderen Entities erben. Die Klasse hat eine Variable `id`,
welche ihre Unterklassen dann auch haben.
welche ihre Unterklassen dann auch haben. Die Klasse selbst wird nicht
in der Datenbank abgebildet.
### Repository (`Repository/`)
@@ -133,7 +135,8 @@ Hier liegen nötige Javascriptdateien für die Seite `/list/{id}`.
Unter `/api` liegen die API Methoden, unter `/frontend` UI Methoden.
Da die Seite sowohl Kategorien als auch Gegenstände
behandelt sind in den Ordnern jeweils API und UI Dateien für die beiden Elemente.
Diese sind dann in den jeweilen `listUI.js` und `listAPI.js` gebündelt.
Die Imports sind dann in den jeweilen `listUI.js` und `listAPI.js` gebündelt
welche dann in die `list.js` importiert wird.
### Shared Module (`static/js/shared`)
@@ -145,7 +148,9 @@ Zusammen mit `sharedUI.js` bildet sie den Ablauf ab.
Die beiden Dateien sind bewusst getrennt,
da die Funktion `editElement()` eine Mischung aus UI und API Aufrufe hat.
Das Muster, dass API und UI Funktionen in getrennten Dateien leben,
sollte beibehalten werden.
sollte beibehalten werden. Es wurde nur die editElement() Funktion
generalisiert, da die Bearbeitung eines Elementes für alle drei Models
gleich abläuft im Gegensatz zu dem Hinzufügen und Löschen dieser.
#### error.js
@@ -1,6 +1,9 @@
package de.timaldinger.einkaufsliste.Dto.Patch;
import jakarta.validation.constraints.NotBlank;
import jakarta.validation.constraints.Size;
public record ShoppingCategoryPatchDTO(@NotBlank(message = "Kategoriename darf nicht leer sein!") String categoryName) {
public record ShoppingCategoryPatchDTO(@NotBlank(message = "Kategoriename darf nicht leer sein!")
@Size(max = 50, message = "Kategoriename darf nicht länger als 50 Zeichen sein!")
String categoryName) {
}
@@ -1,10 +1,13 @@
package de.timaldinger.einkaufsliste.Dto.Patch;
import jakarta.validation.constraints.AssertTrue;
import jakarta.validation.constraints.Size;
import java.util.UUID;
public record ShoppingItemPatchDTO(String itemName, String itemAmount, Boolean isDone, UUID categoryID) {
public record ShoppingItemPatchDTO(@Size(max = 50, message = "Name darf nicht länger als 50 Zeichen sein!") String itemName,
@Size(max = 50, message = "Menge darf nicht länger als 50 Zeichen sein!") String itemAmount,
Boolean isDone, UUID categoryID) {
@AssertTrue(message = "Wenigstens eines der Felder muss ausgefüllt sein!")
private boolean isAtleastOneNotBlank(){
@@ -1,6 +1,9 @@
package de.timaldinger.einkaufsliste.Dto.Patch;
import jakarta.validation.constraints.NotBlank;
import jakarta.validation.constraints.Size;
public record ShoppingListPatchDTO(@NotBlank(message = "Listenname darf nicht leer sein!") String listName) {
public record ShoppingListPatchDTO(@NotBlank(message = "Listenname darf nicht leer sein!")
@Size(max = 50, message = "Listenname darf nicht länger als 50 Zeichen sein!")
String listName) {
}
@@ -1,8 +1,11 @@
package de.timaldinger.einkaufsliste.Dto.Post;
import jakarta.validation.constraints.NotBlank;
import jakarta.validation.constraints.Size;
import java.util.UUID;
public record ShoppingCategoryPostDTO(@NotBlank(message = "Kategoriename darf nicht leer sein!") String categoryName, UUID listID) {
public record ShoppingCategoryPostDTO(@NotBlank(message = "Kategoriename darf nicht leer sein!")
@Size(max = 50, message = "Kategoriename darf nicht länger als 50 Zeichen sein!")
String categoryName, UUID listID) {
}
@@ -2,14 +2,17 @@ package de.timaldinger.einkaufsliste.Dto.Post;
import jakarta.validation.constraints.AssertTrue;
import jakarta.validation.constraints.NotNull;
import jakarta.validation.constraints.Size;
import java.util.UUID;
public record ShoppingItemPostDTO(String itemName,
String itemAmount,
UUID categoryID,
@NotNull(message = "listID must not be empty!")
UUID listID){
public record ShoppingItemPostDTO( @Size(max = 50, message = "Kategoriename darf nicht länger als 50 Zeichen sein!")
String itemName,
@Size(max = 50, message = "Kategoriename darf nicht länger als 50 Zeichen sein!")
String itemAmount,
UUID categoryID,
@NotNull(message = "listID must not be empty!")
UUID listID){
@AssertTrue(message = "Wenigstens eines der Felder muss ausgefüllt sein!")
private boolean isAtleastOneNotBlank(){
@@ -1,6 +1,9 @@
package de.timaldinger.einkaufsliste.Dto.Post;
import jakarta.validation.constraints.NotBlank;
import jakarta.validation.constraints.Size;
public record ShoppingListPostDTO(@NotBlank(message = "Listenname darf nicht leer sein!") String listName) {
public record ShoppingListPostDTO(@NotBlank(message = "Listenname darf nicht leer sein!")
@Size(max = 50, message = "Listenname darf nicht länger als 50 Zeichen sein!")
String listName) {
}