API-Beispiele und Response-Format zur Dokumentation hinzugefügt

This commit is contained in:
2025-03-17 20:19:45 +01:00
parent 2eddb3ad20
commit 83cedcc555

View File

@@ -100,6 +100,55 @@ Die Anwendung erwartet eine CSV-Datei (`spezexpo.csv`) mit folgenden Spalten:
- `q`: Allgemeine Suche über alle Felder - `q`: Allgemeine Suche über alle Felder
- Returns: JSON-Array mit gefundenen Kunden - Returns: JSON-Array mit gefundenen Kunden
#### API-Beispiele
1. Suche nach Namen:
```bash
curl "http://localhost:5001/search?name=Schmidt"
```
2. Suche nach Ort:
```bash
curl "http://localhost:5001/search?ort=Berlin"
```
3. Suche nach Kundennummer:
```bash
curl "http://localhost:5001/search?kundennummer=12345"
```
4. Suche nach Fachrichtung:
```bash
curl "http://localhost:5001/search?fachrichtung=Allgemeinmedizin"
```
5. Kombinierte Suche:
```bash
curl "http://localhost:5001/search?name=Schmidt&ort=Berlin&fachrichtung=Allgemeinmedizin"
```
6. Allgemeine Suche:
```bash
curl "http://localhost:5001/search?q=Schmidt"
```
#### Beispiel-Response
```json
[
{
"Nummer": "12345",
"Vorname": "Max",
"Nachname": "Schmidt",
"Fachrichtung": "Allgemeinmedizin",
"Strasse": "Hauptstraße 1",
"PLZ": "10115",
"Ort": "Berlin",
"Tel": "030-123456",
"mail": "max.schmidt@example.com"
}
]
```
## Frontend-Funktionen ## Frontend-Funktionen
### Suchfunktion ### Suchfunktion
@@ -107,6 +156,7 @@ Die Anwendung erwartet eine CSV-Datei (`spezexpo.csv`) mit folgenden Spalten:
- Spezifische Suchfelder für präzise Suche - Spezifische Suchfelder für präzise Suche
- Allgemeine Suche für breite Suche - Allgemeine Suche für breite Suche
- Kombinierbare Suchkriterien - Kombinierbare Suchkriterien
- Trefferzähler für jedes Suchfeld
### Link-Generierung ### Link-Generierung
- `createPhoneLink()`: Erstellt tel:-Links mit führender 0 - `createPhoneLink()`: Erstellt tel:-Links mit führender 0