From aa2c8a3ab44717ca01010fe8833c316456fe1d92 Mon Sep 17 00:00:00 2001 From: Marcel Schwarz Date: Sun, 17 Jan 2021 20:01:57 +0000 Subject: [PATCH] Update Vorgehensweise --- Projektarbeit-3/Vorgehensweise.md | 32 +++++++++++++++++++++---------- 1 file changed, 22 insertions(+), 10 deletions(-) diff --git a/Projektarbeit-3/Vorgehensweise.md b/Projektarbeit-3/Vorgehensweise.md index 4cb30ec..1fc5834 100644 --- a/Projektarbeit-3/Vorgehensweise.md +++ b/Projektarbeit-3/Vorgehensweise.md @@ -64,16 +64,28 @@ Zusätzlich dazu wurden noch die Accidents und die Bikepoints aus der Live API g * Python ## Endpunkterklärung -* upstream relay - * BikePoints -* "map" endpoints - * Accidents -* "dashbaord" endpoints - * from - * to - * / - * time - * duration + +Da unser Backend nur Daten bereitstellt, sind auch nur GET-Endpoints implementiert worden. Auch Authentifizierung gibt es nicht. Die Endpunkte sind in zwei Gruppen unterteilt, "Local" und "Upstream". Die "Local" Endpoints greifen auf die Lokale Datenbank zu, wohingegen die "Upstream" Gruppe nur eine interne Weiterleitung ist. Dies ist wichtig, sollte etwas nicht funktionieren. Denn wenn ein mit "Upstream" markierter Endpunkt nicht funktioniert, muss es nicht zwingend an unserer Implementation liegen. + +Die Upstream Endpoints sind: +1. **/api/latest/bikepoints** + Liefert alle Bikepoints in einer Liste zurück +2. **/api/latest/bikepoints/:id** + Liefert einen spezifischen Bikepoint zurück (reduziert Bandbreite und Ladezeit) + +Die Lokalen Endpoints sind: +1. **/api/latest/accidents** + Liefert alle Accidents zurück +2. **/api/latest/accidents/:year** + Liefert alle Accidents für ein bestimmtes Jahr zurück +3. **/api/latest/dashboard/:id** + Liefert eine generelle Übersicht über die lokal verfügbaren Daten für einen Bikepoint zurück +4. **/api/latest/dashboard/:id/to** und **/api/latest/dashboard/:id/from** + Liefert die Einträge für die From/To - Tabellen des Dashboards zurück. +5. **/api/latest/dashboard/:id/duration** + Liefert die Übersicht für die Ausleihdauer zurück +6. **/api/latest/dashboard/:id/time** + Liefert die Übersicht über die Ausleihzeit zurück # Frontend ## Architektur