info@a-coding-project.de

REST-Apis: Aufbau und Struktur

Mit REST-APIs (Representational State Transfer) lassen sich Datensätze auf eine einfache Art und Weise zwischen verschiedenen austauschen. Die Schnittstelle basiert auf dem HTTP-Protokoll und ist somit zustandslos. Im Endeffekt kann man Aufrufe direkt im Browser ausführen, was beim Testen sehr hilfreich sein kann. Für den Betrieb innerhalb einer Software wird dafür ein HTTP-Client benutzt.

Rückgabetypen

Die Abfragen an REST-APIs liefern ihre Eregebnisse in den meisten Fällen über XML oder JSON zurück.

Daten mit REST abfragen

GET https://api.examle.com/kunden

In diesem Fall wird eine Liste von Kunden zurückgegeben. Über Parameter kann man z.B. Paginierungen abdecken:

GET https://api.examle.com/kunden?from=100&count=50

Die Abfrage liefert die Kunden 100 - 150 zurück.

GET https://api.examle.com/kunden/1

Um die Details eines Elements zu bekommen, wird hinter dem Listennamen die ID des Elements gehängt.

GET https://api.examle.com/kunden/1/auftraege

Von dem einzelnen Element kann man wieder in weitere Listen kommen. z.B. in die Aufträge des Kunden.

Neues Element über REST hinzufügen

Neue Einträge lassen sich über die POST-Methode des HTTP-Prodokolls hinzugefügt. Im Endeffekt kann man die Daten auch über HTML-Formular speichern.

POST https://api.examle.com/kunden

name=Kunde 1

Als Rückgabe kann hier das neue Objekt inkl. ID zurückgegeben werden.

Element bearbeiten

Über die HTTP-Methode PATCH lassen sich Elemente bearbeiten:

PATCH https://api.examle.com/kunden/1

name=Kunde Eins

Element löschen

Das geht über die DELETE-Methode;

DELETE https://api.examle.com/kunden/1

Authentifizierung

Die Authentifizierung des Clients kann über die normale HTTP-Authentifizierung erfolgen. Oft wird auch ein API-Key als HEAD-Parameter angegeben.

Über uns

Stefan Wienströer

Wir entwickeln Webanwendungen mit viel Leidenschaft. Unser Wissen geben wir dabei gerne weiter. Mehr über a coding project

Auch interessant