48 lines
1.8 KiB
Markdown
48 lines
1.8 KiB
Markdown
<!-- /docs/services/README.md -->
|
||
|
||
# ⚙️ `services/` – Backend-Services & API-Logik
|
||
|
||
Dieses Verzeichnis enthält alle Funktionen zur Anbindung von Backend-Systemen, API-Endpunkten und Datenquellen (z. B. Datenbank, POIs, Geräte, Polylinien).
|
||
Die Dateien sind nach Anwendungsbereich gegliedert.
|
||
|
||
---
|
||
|
||
## 📂 Strukturübersicht
|
||
|
||
```bash
|
||
services/
|
||
├── poi/ # Services für Points of Interest
|
||
├── devices/ # Geräte- und Standort-Services
|
||
├── gis/ # Linien- und Stationsdaten aus GIS
|
||
├── system/ # Rechte, Konfiguration, Benutzerzugriff
|
||
├── helpers/ # Hilfsfunktionen wie fetchWithTimeout
|
||
```
|
||
|
||
---
|
||
|
||
## 🧭 Kategorien & Beispiele
|
||
|
||
| Bereich | Beispiel-Service | Beschreibung |
|
||
|-------------|--------------------------------------|-------------------------------------|
|
||
| `poi/` | `fetchPoiMarkersService.js` | Holt Marker für POIs |
|
||
| `devices/` | `fetchLocationDevicesService.js` | Ruft alle Standort-Geräte ab |
|
||
| `gis/` | `fetchGisLinesService.js` | Holt Polylinien aus der Datenbank |
|
||
| `system/` | `fetchUserRightsService.js` | Lädt Benutzerrechte |
|
||
| `helpers/` | `fetchWithTimeout.js` | Fetch mit automatischem Timeout |
|
||
|
||
---
|
||
|
||
## 🔗 Dokumentation
|
||
|
||
Für jeden Service existiert eine `.md`-Datei mit Beschreibung, Parametern und Beispielen.
|
||
Beispiel: [`poi/fetchPoiMarkersService.md`](./poi/fetchPoiMarkersService.md)
|
||
|
||
---
|
||
|
||
## 👨💻 Zielgruppe
|
||
|
||
Frontend- und Backend-Entwickler, die:
|
||
|
||
- API-Aufrufe integrieren
|
||
- Daten aus der DB anzeigen oder manipulieren
|
||
- Redux oder Thunks mit Services koppeln |