Schnittstellendefinition
Allgemeine Festlegungen
Standard-Anfragen (Default Requests)
Der Webserver bietet Webclients die Möglichkeit, durch standardisierte HTTP-Methoden gespeicherte Ressourcen beziehungsweise Entitäten abzurufen und/oder zu bearbeiten.
GET
GET ruft eine oder mehrere Entitäten/Ressourcen vollständig oder teilweise ab.
Der GET-Anfrage können zusätzliche Informationen mitgegeben werden, die der Webserver
verarbeiten soll. Diese URL-Parameter werden an die URL angehängt.
POST
Per POST können große Datenmengen zum Webserver gesendet werden. Dabei werden
die Parameter nicht in die URL, sondern in den HTTP-Body geschrieben.
POST wird oft benutzt, um mehrere Daten gleichzeitig zu senden oder um
Entitäten zu erstellen.
PUT
PUT funktioniert ähnlich wie POST und dient dazu, bereits existierende Entitäten zu verändern. Dabei wird eine Entität vollständig mit den Daten im PUT überschrieben.
PATCH
PATCH funktioniert ähnlich wie PUT und dient dazu, Entitäten auf dem Webserver zu verändern. Anders als bei PUT werden hier nur die Daten verändert, welche im Request angegeben
wurden. Andere Daten bleiben unverändert erhalten.
DELETE
Mit einem DELETE werden Entitäten auf dem Webserver gelöscht.
Standard-Rückgaben (Default Responses)
Nachdem der Webserver eine Anfrage erhalten und interpretiert hat, wird mit einer HTTP-Response geantwortet. Eine HTTP-Response besitzt einen HTTP-Status-Code. Die erste Ziffer des Status-Codes gibt die Kategorie der HTTP-Response an:
1xx: Informative Antworten2xx: Erfolg3xx: Weiterleitung4xx: Client-Fehler5xx: Server-Fehler