RESTful API

Die RESTful API oder auch Rest API ist neben der neueren GraphQL-API das vorherschende Architektur-Prinzip bei Web-APIs. REST steht für Representational State Transfer und beschreibt die Prinzipien der API.

Bei einer RESTful API kann jede Ressource (z. B. ein Benutzer, ein Artikel) durch eine eindeutige URL mit Hilfe von HTTP-Methoden angesprochen werden. Diese Zugriffspunkt (URLs) werden als Endpunkte (endpoint) bezeichnet. Darüber hinaus muss die API stateless sein, das heißt die Anfrage muss alle Informationen zur Bearbeitung enthalten und darf nicht auf zwischengespeicherte Informationen wie zum Beispiel Sessions angewiesen sein. Gleichzeitig muss die API unabhängig von der anfragenden Software sein (Client-Server-Architektur), d.h. die anfragende Software (Client) muss nichts über die Funktionsweise der API (Server) wissen und umgekehrt.

HTTP-Methoden

RESTful APIs verwenden HTTP-Methoden, um Daten (Ressourcen) abzurufen, zu erstellen oder zu verändern:

• GET: Um Daten von einer Ressource abzurufen (lesen).
• POST: Um neue Daten zu einer Ressource hinzuzufügen (erstellen).
• PUT: Um eine Ressource zu aktualisieren (ersetzen).
• PATCH: Um Teile einer Ressource zu aktualisieren.
• DELETE: Um eine Ressource zu löschen.

Beispiel

Der folgende Endpunkt für eine RESTful API würde eine vollständige Nutzerliste zurückgeben:

GET https://api.example.com/users

Die Antwort der API kann so aussehen:

[
  {
    "id": 1,
    "name": "John Doe",
    "email": "johndoe@example.com"
  },
  {
    "id": 2,
    "name": "Jane Smith",
    "email": "janesmith@example.com"
  }
]