RESTAPIEndpunkt

RESTAPIEndpunkt bezeichnet in der Regel eine eindeutig adressierbare URL, über die ein REST-API eine Ressource oder eine Aktion bereitstellt. Ein Endpunkt ist die konkrete Schnittstelle, über die Client-Anfragen an den Server gesendet werden und auf deren Antworten in einem bestimmten Format reagiert wird. Typischerweise verwenden REST-APIs das HTTP-Protokoll und übertragen Repräsentationen wie JSON oder XML.

Die Struktur von Endpunkten folgt oft ressourcenorientierten Mustern. Beispiele sind /api/v1/users/{id} zur Abfrage eines einzelnen Benutzers oder /api/v1/products zur Arbeit mit Produktlisten. Die Verwendung von Versionierung (z. B. v1) erleichtert zukünftige Änderungen, ohne bestehende Clients zu brechen. Endpunkte unterscheiden zwischen Sammlungen (Platzhalter) und einzelnen Ressourcen.

Zu den gängigen HTTP-Methoden zählen GET zum Lesen, POST zum Anlegen, PUT oder PATCH zum Aktualisieren und DELETE zum Entfernen. GET, PUT und DELETE sind in der Regel idempotent, POST ist meist nicht. Antworten verwenden Statuscodes wie 200 (OK), 201 (Erstellt), 204 (Keine Inhalte), 400/401/403/404/500 zur Fehlerkommunikation. Repräsentationen werden oft als JSON gesendet und empfangen; auch Validierung, Felderlisten und Fehlermeldungen gehören dazu. Sicherheitsaspekte umfassen Authentifizierung (z. B. OAuth 2.0, API-Keys), Autorisierung, Ratenbegrenzung und CORS.

Endpunkte unterscheiden sich vom API als Ganzem: Ein API umfasst eine Sammlung von Endpunkten, die zusammen Funktionen bereitstellen. Gute Dokumentation (z. B. OpenAPI/Swagger) beschreibt Endpunkte, Parameter, Antworten und Fehlerfälle, sodass Clients sie konsistent nutzen können. HATEOAS-ähnliche Erklärungen sind optional, unterstützen jedoch die Auffindbarkeit von Aktionen.