Ein Pfadparameter ist ein Platzhalter in der Pfadvorlage eines Endpunkts – /orders/{id} –, den der Client ausfüllt, um eine bestimmte Instanz zu adressieren. Im Gegensatz zu einem Abfrageparameter ist er Teil der Identität der Ressource: /orders/42 und /orders/43 sind unterschiedliche Ressourcen, während /orders ?status=open eine Ansicht derselben Ressource darstellt.
Der Server gleicht den Pfad mit seinen Vorlagen ab, extrahiert das Segment und validiert es: Eine nicht-numerische ID, wo eine Zahl erwartet wird, führt zu einem 400-Fehler, eine korrekte ID ohne nachfolgende Zeichen zu einem 404-Fehler. Werte müssen prozentkodiert sein – ein Schrägstrich innerhalb eines Wertes würde den Pfad sonst in eine andere Route aufteilen.
Ein 404-Fehler bedeutet immer einen Tippfehler in der URL. Bei einem Pfadparameter bedeutet er häufiger, dass die Ressource gelöscht wurde, nie existierte oder zwar existiert, der Aufrufer dies aber möglicherweise nicht weiß – manche APIs geben absichtlich 404 statt 403 zurück, um die Gültigkeit einer ID nicht bestätigen zu müssen.
Jede API benötigt IDs im Pfad. Die Voxel Worlds API erwartet drei IDs gleichzeitig bei GET /voxel/v1/worlds/{id}/blocks/{x}/{y}/{z} , und die World Cup API verwendet einen Buchstaben anstelle einer Zahl bei GET /worldcup/v1/groups/{letter}/standings.
Diese Seite auf Englisch lesen
Alle Glossarbegriffe · Testtechniken · Alle 39 Mock-REST-APIs
Zuletzt aktualisiert