Du hast deinen AdBlocker an?

Es wäre ein Traum, wenn du ihn für t3n.de deaktivierst. Wir zeigen dir gerne, wie das geht. Und natürlich erklären wir dir auch, warum uns das so wichtig ist. Digitales High-five, deine t3n-Redaktion

Entwicklung & Design

JSONPlaceholder: Die REST-API mit Demo-Content

REST-API mit JSONPlaceholder (Screenshot: Instacode)

Bei der Entwicklung einer Applikation passiert es öfters, dass die Programmierung zwischen Backend und Frontend unterschiedlich schnell voran getrieben wird. Dabei ist der Frontend-Bereich vom Backend abhängig und benötigt den gewünschten Input. Damit das Warten ein Ende hat, können wir mit JSONPlaceholder eine Platzhalter-REST-API einbinden und müssen auf das Backend nicht warten.

JSONPlaceholder ist sozusagen die Platzhalter-API, die uns mit einem Response versorgt, solange die echte API noch in der Entwicklung steckt. Das gleiche Prinzip kennen wir auch schon von Platzhalter-Texten oder den Platzhalter-Bildern. Auch hier wird der gleiche Vorteil erzeugt, das uns die Wartezeit auf den Texter oder den Designer erspart bleibt.

JSONPlaceholder im Einsatz

Die JSONPlaceholder-REST-API funktioniert, wie jede andere API auch. Über einen HTTP-Request können wir die API ansteuern und erhalten, abgängig vom Endpoint und den Parametern, unsere JSON-Response. Folgende Endpoints stehen uns zur Verfügung, die untereinander wiederum verknüpft sind: /posts, /comments, /albums, /photos, /todos und /users.

Die Endpoints können mit verschiedenen Parametern gefiltert werden. Wollen wir beispielsweise nur die Posts von einem bestimmten User, können wir die UserId anhängen: /posts?userId=1

Das Ergebnis ist immer ein JSON-Response, den wir in unserem Quellcode platzieren können. Wollen wir beispielsweise einen jQuery-Ajax-Request erstellen, können wir das mit folgendem Code umsetzen:

var root = 'http://jsonplaceholder.typicode.com';
$.ajax({
url: root + '/posts/1',
method: 'GET'
}).then(function(data) {
console.log(data);
});

Den Data-Response können wir jetzt mit JavaScript weiter verwerten.

JSONPlaceholder und die möglichen Szenerien

JSONPlaceholder eignet sich aber nicht nur dafür, fehlende API-Anknüpfungen zeitlich zu überbrücken. Es kann auch sinnvoll sein, um gewisse Software zu demonstrieren, zu verkaufen oder Tutorials bereitzustellen. Code-Snippets können geteilt werden, die nicht nur die Theorie vorführen, sondern auch ein Live-Ergebnis repräsentieren. Es gibt viele Möglichkeiten eine solche Demo-API zu verwenden.

Wer weniger Interesse an den fertigen Endpoints hat und mit der gleichen Technik eine einfache REST-API, auf dem eigenen Server, erstellen will, kann mit dem JSON-Server das erstellen. Der JSON-Server muss mit NPM auf dem Zielsystem installiert und gestartet werden. Folgend darauf wird eine JSON-Datei, als Basis für die API, verwendet.

Nette Idee oder nur Spielerei – was haltet ihr von einer Demo-API?

Bitte beachte unsere Community-Richtlinien

2 Reaktionen
Alex

Danke dafür!

Habe dies auch schon mal eingesetzt und war davon über zeugt.
Besonders gut fand ich auch, wie schnell man im Backend Prototyping damit arbeiten konnte.

Nachteile liegen sicherlich in komplexeren Json Strukturen, die man bei strukturell komplexeren Projekten immer hat.

Antworten
Oliver

Schöne Sache, allerdings nur bei Standard Applikationen / Websites hilfreich. Sobald es um Systeme mit spezifischeren Datenstrukturen geht funktioniert JSONPlaceholder nur noch bedingt.

Für viele Seiten der täglichen Arbeit reichen diese Datentypen allerdings aus. Somit finde ich JSONPlaceholder einen interessanten Ansatz.

Antworten

Melde dich mit deinem t3n Account an oder fülle die unteren Felder aus.