Was ist die WordPress-REST-API und wie verwenden Sie sie?

Veröffentlicht: 2022-06-30

Sie haben wahrscheinlich schon von der REST-API gehört. Vielleicht haben Sie schon gehört, dass WordPress-Nutzer davon profitieren. Aber Sie fragen sich vielleicht auch, was genau eine WordPress-API ist.

Zu verstehen, wie APIs funktionieren, ist nicht so kompliziert, wie es sich anhört. Lies weiter, um zu erfahren, was eine API ist, was eine REST-API ist und wie du die WordPress-REST-API auf deinen Websites verwenden kannst.

Was ist eine API?

Eine Anwendungsprogrammschnittstelle (API) ist eine Möglichkeit für zwei Anwendungen, miteinander zu „sprechen“. Ein System stellt eine Anfrage und das andere erfüllt sie. Die Anfragen, die ein System akzeptiert, müssen in die API aufgenommen werden – sonst kann die Anfrage nicht erfüllt werden.

Denken Sie so darüber nach. Vielleicht bist du wirklich hungrig, also gehst du ins Waffle House. Sie bestellen Kaffee, Eier und Pfannkuchen. Die Kellnerin beginnt, Ihre Bestellung aufzuschreiben – und ist dann verwirrt, als Sie zu den Pfannkuchen kommen. Waffle House serviert keine Pfannkuchen. Sie servieren nur Waffeln.

Ein System, das Pfannkuchen von einem API-Menü anfordert, das nur Waffeln serviert, wird hungrig bleiben.

Was ist die REST-API?

Wenn wir REST-API sagen, sprechen wir über ein System von Beschränkungen, das für das Internet entwickelt wurde. Es beschreibt, wie eine Website skalierbar und einheitlich Informationen von einer anderen Website anfordern kann. REST steht für Representational State Transfer, das von Roy Fielding in seiner Doktorarbeit definiert wurde.

Was ist die WordPress-REST-API?

WordPress REST API bezieht sich auf Anfragen an eine Website, die auf WordPress läuft. Wenn wir eine Liste von Beiträgen oder Seiten anfordern, können wir damit rechnen, diese Informationen von der WordPress-REST-API zu erhalten. WordPress wird niemals Informationen bereitstellen, die nicht öffentlich gemacht werden, wie z. B. Entwurfsbeiträge oder (noch wichtiger) Benutzerkennwörter.

Dies ist die Grundlage für den Block-Editor, der Daten dynamisch mit WordPress austauscht, ohne die Seite neu zu laden. Jeder Endpunkt gibt Daten in einem JSON-Format zurück, das von JavaScript gelesen werden kann – oder in diesem Fall Blöcke.

Beachten Sie, dass die REST-API nur eine der von WordPress bereitgestellten APIs ist. Außerdem gibt es zum Beispiel die Datenbank-API und die Metadaten-API, die von Plugins verwendet werden, um mit WordPress auf dem Server zu interagieren. Mehr über WordPress-APIs erfahren Sie im Codex.

Wie funktioniert eine WordPress-REST-API-Anfrage?

Es gibt einige grundlegende Teile der REST-API, nämlich: Routen, Endpunkte, Anforderungen und Antworten.

Routen

Eine Route ist, wie wir auf die URL verweisen, über die die Website kommuniziert. Eine gängige Route in WordPress ist „/wp-admin“. Obwohl es sich nicht um eine Route der REST-API handelt, handelt es sich um eine Route, die vom Browser verwendet wird, um auf das WordPress Admin Dashboard zuzugreifen. Für unsere Zwecke beginnen REST-API-Routen mit „/wp-json“ (wobei JSON das Standardformat der Daten ist).

Endpunkte

Ein Endpunkt ist die Kombination aus einer Route und dem eingehenden Anforderungstyp. Eine einzelne Route kann eine Verbindung zu mehreren Endpunkten herstellen, da es mehrere Anforderungstypen gibt. Zu den gängigen Anfragetypen gehören GET (wie wir Daten auf einer Route lesen) und POST (wie wir Daten auf einer Route aktualisieren).

Anfragen und Antworten

Jede Kommunikation mit der REST-API findet zwischen einer Anfrage und einer Antwort statt. Ein System stellt eine Anfrage, auf die das andere System antwortet. Die WordPress-REST-API enthält praktische Objekte für Plugins, um auf die Anfragedaten (WP_REST_Request) zuzugreifen und die Antwortdaten (WP_REST_Response) zu verwalten, wenn die WordPress-REST-API erweitert wird.

So installieren Sie die REST-API in WordPress

Ab der WordPress-Version 4.7 enthält WordPress die REST-API als Kernfunktion.

Wenn Sie eine ältere Version ausführen, können Sie das Feature-Plugin json-rest-api installieren. Dies wurde verwendet, um die REST-API zu entwickeln, bevor sie vollständig in die WordPress-Codebasis integriert wurde. Dieses Plugin ist technisch geschlossen, daher wird empfohlen, stattdessen deine Version von WordPress zu aktualisieren (oder vielleicht Managed WordPress Hosting in Betracht zu ziehen und du wirst immer auf dem neuesten Stand sein.)

WordPress-REST-API-Beispiele

Schauen Sie sich die GiveWP-Website an. Wenn Sie zu ihrem Blog gehen, können Sie die neuesten Nachrichten und Beiträge sehen. Diese Route rendert HTML, das schön anzusehen ist, aber für einen Programmierer schwierig zu handhaben ist. Stattdessen werden Beiträge Programmierern über die Route „/wp-json/wp/v2/posts“ zur Verfügung gestellt.

Die Route „/wp-json/wp/v2/posts“ teilt uns mit, dass dies eine WordPress-Ressource („/wp“) ist, dass dies Version 2 („/v2/“) der Ressource ist und dass dies insbesondere der Fall ist Beiträge („/posts“). Falls noch nicht geschehen, besuchen Sie https://givewp.com/wp-json/wp/v2/posts und vergleichen Sie, was Sie sehen, mit https://givewp.com/blog/. Ich gebe Ihnen einen Hinweis – es ist die gleiche Information!

Ein Beispiel dafür, wie die REST-API in WordPress verwendet wird, finden Sie im Block „Neueste Beiträge“. Um eine Liste von Beiträgen in WordPress zu erhalten, müsste die Website traditionell eine Anfrage an den Server stellen und dann die gesamte Seite neu rendern.

Der Block mit den neuesten Posts kann nur die Posts anfordern und sich dann selbst neu rendern. Dies geschieht über die REST-API. Und es kann dies mehrmals tun, um nach neuen Beiträgen abzufragen – ohne die gesamte Seite neu zu rendern. Dies ist besonders nützlich, wenn Sie eine vollständige Site-Bearbeitung in Betracht ziehen, bei der Blöcke zum Bearbeiten und Anzeigen der Komponenten der Seite verwendet werden.

Jede einzelne Komponente kann die Daten anfordern, die sie benötigt (einschließlich der Suche nach Updates) und dann nur das neu rendern, was sich geändert hat.

Jetzt wissen Sie

Nachdem Sie nun den Zweck und die Struktur einer WordPress-REST-API verstanden haben, stöbern Sie herum, um zu sehen, was Sie selbst finden können. Einen vollständigen Überblick über die Verwendung und Erweiterung der WordPress-REST-API finden Sie im REST-API-Handbuch.

Denken Sie daran: Wenn Sie jemand nach APIs fragt, können Sie bei Waffle House keine Pfannkuchen bestellen.

Vergessen Sie bei der Feinabstimmung Ihrer Website nicht, dass großartige Websites großartiges Hosting erfordern. All das bekommen Sie mit Managed WordPress von Nexcess. Mit leistungsstarken Geschwindigkeiten, Skalierbarkeitsoptionen und hervorragendem Support können Sie sich auf Nexcess verlassen, um Ihre WordPress-Site zu betreiben.

Kommen Sie und sehen Sie, warum Besseres mit Nexcess integriert ist. Sehen Sie sich noch heute unsere vollständig verwalteten WordPress-Hosting-Pläne an.

Entdecken Sie WordPress-Hosting-Pläne