Update Dokumentation authored by Quadflieg Alexander's avatar Quadflieg Alexander
--- ---
title: Dokumentation title: Dokumentation
--- ---
# Dokumentation # Dokumentation
# Codedokumentation ## Codedokumentation
### JavaDoc ### JavaDoc
Um für zukünftige Features aber auch neue Mitglied, ist das Projekt durch eine JavaDoc dokumentiert. Um für zukünftige Features aber auch neue Mitglied, ist das Projekt durch eine JavaDoc dokumentiert.
# Dokumentation der Endpunkte ## Dokumentation der Endpunkte
### Zugang zur Dokumentation ### Zugang zur Dokumentation
Um einen Überblick über die Endpunkte des Backends zu gewinnen aber um es auch ohne das Frontend zu nutzen, besteht die Möglichkeit die Oberfläche von Swagger zu nutzen. Diese wird beim Starten der Anwendung automatisch hochgefahren und ermöglicht es alle Endpunkte auszuprobieren. Aufrufbar ist die Dokumentation unter: http://localhost:8080/swagger-ui/index.html , wenn die Anwendung auch auf dem Gerät betrieben wird beispielsweise mittels eines Docker Containers. Um einen Überblick über die Endpunkte des Backends zu gewinnen aber um es auch ohne das Frontend zu nutzen, besteht die Möglichkeit die Oberfläche von Swagger zu nutzen. Diese wird beim Starten der Anwendung automatisch hochgefahren und ermöglicht es alle Endpunkte auszuprobieren. Aufrufbar ist die Dokumentation unter: http://localhost:8080/swagger-ui/index.html , wenn die Anwendung auch auf dem Gerät betrieben wird beispielsweise mittels eines Docker Containers.
... ...
......