So funktionieren REST-APIs · Mindmaps

So funktionieren REST-APIs. Eine bearbeitbare Mindmap mit farbigen Zweigen, Unterthemen und Verbindungen. Geschwungene Linien zeigen Beziehungen; Pfeile stehen nur dort, wo die Richtung wichtig ist.

Eine REST-API ist ein Gespräch in HTTP: Der Client sendet eine Anfrage, die eine Ressource und eine Aktion benennt, der Server verarbeitet sie, und die Antwort trägt einen Statuscode und das Ergebnis.

So funktionieren REST-APIs · Mindmaps

Die interaktive MindMap-Zeichenfläche zu dieser Erklärung — jede Bahn, jede Zeile und jeder Pfeil oben gehört zu einem echten QueryChart-Diagramm, das Sie öffnen und bearbeiten können.

So lesen Sie diese Mindmap

  • Beginnen Sie beim Thema in der Mitte und folgen Sie einem farbigen Zweig zu den zugehörigen Ideen.
  • Geschwungene Linien zeigen Beziehungen; Pfeile stehen nur dort, wo die Richtung wichtig ist.

Request

Dieser Zweig verbindet “The method is the verb — GET reads, POST creates, PUT replaces, PATCH updates, DELETE removes. REST names resources by URL and acts on them with these verbs.”, “Client sends the request over HTTPS”.

Routing

Dieser Zweig verbindet “The URL path is the routing key: /users/42 is the handler for one user. Query parameters, headers and the body carry everything else the handler needs.”, “Validation covers authentication (are you who you say you are?), authorization (are you allowed?), and the payload itself (is the data well formed?).”.

Business logic

Dieser Zweig verbindet “Handler runs the business logic”, “Server reads or writes the resource in the database”.

Response

Dieser Zweig verbindet “The status code is the contract: 200 OK, 201 Created, 204 No Content, 404 Not Found, 500 Server Error. Clients branch on it before they read the body.”, “Client receives the response and parses it”, “Client renders the result to the user”.

Errors

Dieser Zweig verbindet “Server returns 400 / 401 / 403”.

Verbindungen zwischen den Zweigen

REST ist ein Vertrag in HTTP: Methoden sind Verben, URLs sind Ressourcen, und Statuscodes sind das maschinenlesbare Ergebnis.

Der Client ist zustandslos: jede Anfrage trägt alles, was der Server braucht, eine gemeinsame Sitzung ist nicht nötig.

Die Prüfung ist die Sicherheitsgrenze; eine ungültige Anfrage wird abgewiesen, bevor Geschäftslogik läuft.

Die Antwort ist zuerst über ihren Statuscode definiert und erst danach über ihren Body.

REST-Verkehr läuft über dieselbe DNS-, HTTPS- und Internet-Infrastruktur, die die anderen Technik-Darstellungen abbilden.

Wichtige Zusammenhänge und Erkenntnisse

  • REST ist ein Vertrag in HTTP: Methoden sind Verben, URLs sind Ressourcen, und Statuscodes sind das maschinenlesbare Ergebnis.
  • Der Client ist zustandslos: jede Anfrage trägt alles, was der Server braucht, eine gemeinsame Sitzung ist nicht nötig.
  • Die Prüfung ist die Sicherheitsgrenze; eine ungültige Anfrage wird abgewiesen, bevor Geschäftslogik läuft.
  • Die Antwort ist zuerst über ihren Statuscode definiert und erst danach über ihren Body.
  • REST-Verkehr läuft über dieselbe DNS-, HTTPS- und Internet-Infrastruktur, die die anderen Technik-Darstellungen abbilden.

Wann Sie diese Darstellung nutzen

  • Das Modell aus HTTP-Methode, URL und Statuscode vermitteln, bevor ein Team seinen ersten Endpunkt entwirft.
  • Den Vertrag einer API prüfen (sind Fehler Statuscodes oder 200 mit einem Flag?) und ihn an der REST-Konvention messen.
  • Ein Gespräch über Idempotenz und Caching daran verankern, wie Anfragen tatsächlich gebaut und geprüft werden.

So funktioniert es

  1. Mittleres Thema anpassen

    Benennen Sie das Thema für Ihr Projekt oder Ihren Unterricht um.

  2. Zweige ausbauen

    Bearbeiten Sie Ideen und ergänzen Sie Beispiele oder Notizen.

  3. Ideen verbinden

    Zeichnen Sie Verbindungen zwischen Zweigen; Pfeile zeigen eine wichtige Richtung an.

Häufig gestellte Fragen

Was ist eine REST-API?

Eine REST-API ist eine Menge von HTTP-Endpunkten, die die Ressourcen eines Systems zugänglich machen. Clients wirken mit HTTP-Methoden auf Ressourcen ein (GET zum Lesen, POST zum Anlegen, PUT oder PATCH zum Ändern, DELETE zum Entfernen) und der Server antwortet mit einem Statuscode und einer Darstellung der Ressource, meist JSON. REST ist ein Stil und kein Standard, und sein Wert liegt darin, dass jeder Client, der HTTP spricht, ihn nutzen kann.

Was unterscheidet GET, POST, PUT und DELETE?

Sie sind die Verben des REST-Vertrags. GET liest eine Ressource und sollte keine Nebenwirkungen haben. POST legt eine neue Ressource an und gibt deren Identität zurück. PUT ersetzt eine Ressource vollständig und ist idempotent: eine Wiederholung ändert nichts weiter. PATCH führt eine teilweise Änderung durch. DELETE entfernt eine Ressource. Zusammen benennen Verb und URL die vollständige Aktion, und deshalb nennt der Anfragekasten in der Darstellung die Methode zuerst.

Warum sind Statuscodes in REST wichtig?

Weil sie das maschinenlesbare Ergebnis der Anfrage sind. Ein Client kann anhand des Statuscodes verzweigen, ohne den Body zu lesen: 2xx Erfolg, 4xx Fehler des Clients, 5xx Fehler des Servers. APIs, die 200 mit einem Fehler-Flag im Body liefern, brechen diesen Vertrag und zwingen jeden Client zu einer Sonderbehandlung der Antwort.

Was macht eine API „RESTful“?

Die praktische Prüfliste: Ressourcen über URLs benannt, Aktionen als HTTP-Methoden ausgedrückt, zustandslose Anfragen (jede trägt alles, was der Server braucht), Antworten, die Statuscodes richtig nutzen, und oft Hypermedia oder versionierte URLs. Die Zeichenfläche bildet den Umlauf ab (Anfrage, Prüfung, Verarbeitung, Antwort), und diese Form teilt jeder RESTful-Austausch.

Diese Mindmap in QueryChart bearbeiten

Öffnen Sie die Mindmap auf einer bearbeitbaren Leinwand. Verschieben Sie Ideen und ergänzen Sie Zweige und Verbindungen.

Diese Mindmap in QueryChart bearbeiten

Mehr in Mindmaps