Ein Endpunkt ist die Kombination aus einer HTTP-Methode und einem URL-Pfad, auf den ein Server antwortet: GET /orders und POST /orders sind zwei Endpunkte für dieselbe Ressource. Dokumentation, Zugriffsregeln, Ratenbegrenzungen und Tests werden üblicherweise pro Endpunkt organisiert, weshalb dieser die maßgebliche Einheit bei der Dimensionierung einer API darstellt.
Der Pfad benennt die Ressource, Pfadparameter wählen eine Instanz aus ( /orders/{id} ), die Abfragezeichenfolge schränkt das Ergebnis ein oder formt es, und die Methode gibt an, was damit geschehen soll. Der Server leitet jede eingehende Anfrage an den für diese Methode und dieses Pfadmuster registrierten Handler weiter, und eine Anfrage, die einem Pfad, aber keiner Methode entspricht, wird mit dem Statuscode 405 anstatt 404 beantwortet.
Ein Endpunkt ist eine URL. Dieselbe URL, jedoch mit einer anderen Methode, stellt einen anderen Endpunkt mit anderen Regeln dar – GET /orders/7 kann öffentlich sein, während DELETE /orders/7 ein Administrator-Token erfordert. Indem man eine Methode testet und annimmt, dass sich die anderen gleich verhalten, werden Autorisierungslücken bei der Überprüfung unentdeckt gelassen.
Auf jeder Dokumentationsseite sind die Endpunkte mit Methode, Pfad und den Statuscodes aufgelistet, die jeder Endpunkt zurückgeben kann; der Pfad DELETE /menu der Pizza-API existiert für GET, beantwortet aber jede DELETE-Anfrage mit dem Statuscode 405.
Diese Seite auf Englisch lesen
Alle Glossarbegriffe · Testtechniken · Alle 39 Mock-REST-APIs
Zuletzt aktualisiert