Abfrageparameter

Abfrageparameter sind der Teil einer URL nach dem Fragezeichen – z. B. ?status=open&sort=-created&limit=20. Sie identifizieren keine andere Ressource, sondern modifizieren die Anfrage für die Ressource, deren Pfadnamen angegeben werden. Daher sind sie der übliche Ort für Filter-, Sortier-, Paginierungs-, Suchbegriffs- und Ausgabeoptionen.

So funktioniert es

Die Wertepaare werden durch ein &-Zeichen getrennt, und jeder Wert wird prozentkodiert, sodass ein Leerzeichen zu %20 und ein kaufmännisches Und-Zeichen innerhalb eines Wertes zu %26 wird. Wiederholte Schlüssel (?tag=a&tag=b) sind zulässig, haben aber keine einheitliche Bedeutung – Frameworks speichern je nach Kontext den ersten, den letzten oder alle Schlüssel. Da sie Teil der URL sind, werden sie in Protokollen, Browserverlauf und Cache gespeichert.

Das Missverständnis

Die unbekannten Abfrageparameter sind harmlos. Viele APIs ignorieren stillschweigend einen falsch geschriebenen Filter – z. B. „?status=open“ – und geben alles zurück, was wie ein Erfolg aussieht, aber ein Fehler im Client ist. Eine strikte API antwortet stattdessen mit dem Statuscode 400; ein Test sollte prüfen, welchen Statuscode Ihre API hat.

Probieren Sie es hier aus

Die Search & Facets API lehnt unbekannte Abfrageparameter bei GET /search/v1/items ab, ebenso wie die Charakterliste von Friends v1. Die Movies API kombiniert Filterung, Sortierung und Paginierung bei GET /movies/v1/movies.

Quellen

Weitere Begriffe

Diese Seite auf Englisch lesen

Alle Glossarbegriffe · Testtechniken · Alle 39 Mock-REST-APIs

Zuletzt aktualisiert