docs: Webservice fetchGisSystemStatic dokumentiert mit Portlogik und URL-Parameter

- .env-Variable NEXT_PUBLIC_API_PORT_MODE beschrieben
- Beispielaufruf und URL-Mapping ergänzt
- Pfadstruktur /docs/frontend/redux/api/... übernommen
This commit is contained in:
ISA
2025-05-16 10:24:04 +02:00
parent 69830a1185
commit 21205d0981
13 changed files with 129 additions and 54 deletions

View File

@@ -4,18 +4,12 @@ In diesem Verzeichnis befinden sich alle Webservice-Fetch-Funktionen für die Ko
---
## Aktueller Stand
Jede Funktion liest `idMap` und `idUser` **ausschließlich aus der URL**, wie sie von TALAS.web übergeben werden.
---
## Übergabe der Parameter über URL (`m`, `u`)
TALAS.web ruft die Kartenansicht in der Regel so auf:
```
http://localhost:3000/?m=10&u=484
http://[SERVER]:3000/?m=10&u=484
```
Daraus ergeben sich folgende Zuweisungen:
@@ -25,14 +19,12 @@ Daraus ergeben sich folgende Zuweisungen:
| `m` | `idMap` | `const idMap = params.get("m")` |
| `u` | `idUser` | `const idUser = params.get("u")` |
🔔 Achtung: Diese Kurzform (`m`, `u`) ist systembedingt durch TALAS.web vorgegeben und **soll nicht durch `idMap` oder `idUser` ersetzt werden**, da die Parameter sonst nicht erkannt werden.
### Beispiel:
```ts
const params = new URLSearchParams(window.location.search);
const idMap = params.get("m"); // statt "idMap"
const idUser = params.get("u"); // statt "idUser"
const idMap = params.get("m");
const idUser = params.get("u");
```
---
@@ -49,11 +41,26 @@ Das wurde entfernt, um folgende Ziele zu erreichen:
- ❌ Keine fest eingetragenen Defaults im Browser sichtbar
- ✅ Verbindlichkeit: TALAS.web übergibt die Werte immer korrekt via URL
- 🔐 Sicherheit: Kein versehentliches Verwenden eines falschen Users (z.B. ID 484)
- 🔐 Sicherheit: Kein versehentliches Verwenden eines falschen Users
- 🔍 Fehler leichter erkennbar (Parameter nicht gefunden = echter Fehler)
---
## Hinweis zur Webservice-Konfiguration
Die Webservice-Basisadresse wird **nicht mehr über `.env.local` gesteuert**.
Stattdessen wird sie dynamisch im Client anhand des aktuellen Hostnamens bestimmt:
```js
const baseUrl = `${window.location.origin}/talas5/ClientData/WebServiceMap.asmx`;
```
➡ Dadurch ist kein Rebuild mehr nötig bei IP-Wechseln oder Serverumzügen.
Die Build-Version kann auf jedem Server wiederverwendet werden.
---
## Optional: Validierung einbauen
Falls gewünscht, kann ein expliziter Fehler ausgelöst werden:
@@ -80,12 +87,4 @@ Diese Änderung betrifft alle Funktionen in:
---
## Hinweis zur Konfiguration
Die Webservice-Basisadresse wird weiterhin über `.env.local` konfiguriert:
```env
NEXT_PUBLIC_API_BASE_URL=http://10.10.0.13/talas5/ClientData/WebServiceMap.asmx
```
Aber `idMap` und `idUser` werden **nicht** mehr über Umgebungsvariablen gesteuert.
Diese Konvention stellt sicher, dass Webservices unabhängig von IP und Serverkonfiguration aufgerufen werden können.