Wie verwendet man ein Query Parameter Array in Postman?
- Grundlagen von Query Parametern
- Darstellung eines Query Parameter Arrays
- Query Parameter Array in Postman angeben
- Wichtige Hinweise zum Testing in Postman
- Zusammenfassung
In der Webentwicklung und API-Tests ist es oft notwendig, mehrere Werte für denselben Abfrageparameter (Query Parameter) zu übergeben. Dies wird häufig als "Array" von Query-Parametern bezeichnet. Postman, ein beliebtes Tool zum Testen von APIs, bietet verschiedene Möglichkeiten, solche Parameter zu senden. Im Folgenden wird ausführlich erläutert, wie man ein Query Parameter Array in Postman korrekt angeben kann.
Grundlagen von Query Parametern
Query Parameter sind Schlüssel-Wert-Paare, die an eine URL angehängt werden und zusätzliche Informationen an den Server übermitteln. Sie folgen auf das Fragezeichen (?) in einer URL und werden mit dem kaufmännischen Und-Zeichen (&) voneinander getrennt. Ein Beispiel für eine URL mit einem einzelnen Query Parameter wäre:
Möchte man nun mehrere Werte für einen Parameter übergeben, entsteht die Frage, wie man das Array formatiert, damit der Server alle Werte korrekt erkennt und verarbeitet.
Darstellung eines Query Parameter Arrays
Für Arrays in Query Parametern existieren keine einheitlichen Standards, aber einige gängige Konventionen haben sich etabliert. Dazu gehört zum Beispiel das Wiederholen desselben Parameters mit verschiedenen Werten:
?farbe=rot&farbe=blau&farbe=grün
Alternativ nutzen manche APIs eine durch Kommas getrennte Liste:
?farbe=rot,blau,grün
Andere verwenden eine Array-Syntax mit eckigen Klammern:
?farbe =rot&farbe =blau&farbe =grün
Welcher Stil zu verwenden ist, hängt von der API ab, die man anspricht.
Query Parameter Array in Postman angeben
In Postman kann man Query Parameter einfach im Reiter "Params" hinzufügen. Für ein Array legt man mehrfach den gleichen Schlüssel mit unterschiedlichen Werten an. Beispiel:
Schlüssel: farbe, Wert: rot
Schlüssel: farbe, Wert: blau
Schlüssel: farbe, Wert: grün
Postman generiert daraus automatisch die URL mit:
?farbe=rot&farbe=blau&farbe=grün
Alternativ kann man auch einen einzelnen Parameter mit einem durch Kommas getrennten Wert angeben, dann muss man nur einmal den Parameter eintragen:
Schlüssel: farbe, Wert: rot,blau,grün
Ob die API dies unterstützt, sollte man der Dokumentation entnehmen.
Wichtige Hinweise zum Testing in Postman
Damit das Query Parameter Array korrekt interpretiert wird, ist es essenziell, die Funktionsweise der Ziel-API zu kennen. Manche APIs erwarten explizit die Wiederholung des Parameters, andere das Array in eckigen Klammern oder als CSV-String. Es empfiehlt sich daher, in Postman verschiedene Varianten auszuprobieren und im Response-Body zu prüfen, ob die Parameter wie gewünscht verarbeitet werden.
Außerdem ist sicherzustellen, dass die URL richtig codiert ist. Postman übernimmt das URL-Encoding in der Regel automatisch.
Zusammenfassung
Das Senden eines Query Parameter Arrays in Postman ist über verschiedene Möglichkeiten realisierbar. Die gängigste Methode besteht darin, den gleichen Parameter mehrere Male unter "Params" mit unterschiedlichen Werten zu definieren. Alternativ kann man Werte auch als durch Kommas getrennte Liste in einem einzelnen Parameter angeben. Wichtig ist dabei immer, die Erwartungen und Vorgaben der Ziel-API zu beachten, um eine korrekte Übertragung sicherzustellen.