WordPress REST API: Was es ist und wie man damit anfängt

WordPress REST API: Was es ist und wie man damit anfängt

WordPress REST API: Was es ist und wie man damit anfängt
СОДЕРЖАНИЕ
02 июня 2020

Wenn Sie in den letzten Jahren einige Zeit in der WordPress-Community verbracht haben, haben Sie wahrscheinlich schon von der neuen REST-API gehört. Sofern Sie kein erfahrener Entwickler sind, haben Sie möglicherweise keine Ahnung, was die WordPress-REST-API tatsächlich ist.


Während die technischen Details etwas komplex sind, sind die grundlegenden Konzepte hinter dieser Funktion leicht zu verstehen. Die neue API hilft dabei, die Möglichkeiten von WordPress als Plattform zu erweitern. Darüber hinaus macht es die REST-API Entwicklern einfacher als je zuvor, WordPress mit anderen Websites und Anwendungen zu verbinden.

WordPress REST API

In diesem umfassenden Handbuch führen wir Sie durch alle Grundlagen, die Sie wissen müssen. Wir werden erklären, was APIs im Allgemeinen und welche REST-APIs (und die WordPress-spezifische Version) im Besonderen sind. Anschließend werden wir darüber sprechen, wie Sie die WordPress REST-API selbst verwenden können. Lass uns gleich einsteigen!

Eine Einführung in Application Programming Interfaces (APIs)

Bevor wir uns speziell mit der REST-API befassen, lassen Sie uns ein wenig sichern. Um dieses Konzept zu verstehen, ist es wichtig, zunächst eine grundlegende Vorstellung davon zu haben, was APIs im Allgemeinen sind.

Auf seiner grundlegendsten Ebene, eine API – oder Anwendungsprogrammierschnittstelle – ermöglicht es zwei Anwendungen, miteinander zu kommunizieren. Wenn Sie beispielsweise eine Website besuchen, sendet Ihr Browser eine Anfrage an den Server, auf dem sich diese Website befindet. Die API dieses Servers empfängt die Anfrage Ihres Browsers, interpretiert sie und sendet alle Daten zurück, die für die Anzeige Ihrer Website erforderlich sind.

Es gibt noch viel mehr zu tun die Funktionsweise von APIs im technischen Sinne natürlich. Wir werden uns jedoch auf das konzentrieren, was für Sie wahrscheinlich am wichtigsten ist – die praktischen Anwendungen. APIs haben viel Aufmerksamkeit und Sichtbarkeit erhalten, da viele Unternehmen damit begonnen haben, sie zu verpacken und als Produkte bereitzustellen, die Sie verwenden können.

Mit anderen Worten, Entwickler in einem Unternehmen wie Google sammeln einige Teile des Codes ihrer Anwendung zusammen öffentlich zugänglich machen. Auf diese Weise können andere Entwickler die API als Tool verwenden, um ihren eigenen Websites zu helfen, eine Verbindung zu Google herzustellen und die Funktionen zu nutzen:

Googles API-Bibliothek.

Sie können beispielsweise die Google Maps-API verwenden, um Platzieren Sie eine voll funktionsfähige Karte auf Ihrer Website, die von allen relevanten Daten und Funktionen von Google profitiert. Dies erspart Ihnen das Codieren einer Karte und das Sammeln all dieser Daten selbst. Gleiches gilt für eine Vielzahl von Standorten und Anwendungen.

Da Websites und die Funktionen, auf die sie angewiesen sind, immer komplexer werden, werden Tools wie APIs von entscheidender Bedeutung. Sie ermöglichen Entwicklern, auf vorhandenen Funktionen aufzubauen, und ermöglichen es, neue Funktionen einfach in Ihre Website einzufügen. Die Site, der die API gehört, profitiert wiederum von der erhöhten Gefährdung und dem erhöhten Datenverkehr.

Die Grundregeln einer REST-API (Representational State Transfer)

Es gibt viele Möglichkeiten, eine API zu erstellen. EIN REST-API (Representational State Transfer) ist ein bestimmter Typ, der nach bestimmten Regeln entwickelt wird. Mit anderen Worten, REST enthält eine Reihe von Richtlinien, die Entwickler beim Erstellen von APIs verwenden können. Dies stellt sicher, dass die APIs effektiv funktionieren.

Um zu verstehen, wie REST-APIs funktionieren, müssen Sie daher wissen, unter welchen Regeln (oder Einschränkungen) sie funktionieren. Es gibt fünf Grundelemente das macht eine API “RESTful”. Beachten Sie, dass der “Server” die Plattform ist, zu der die API gehört, und der “Client” die Site, Anwendung oder Software ist, die eine Verbindung zu dieser Plattform herstellt:

RUHIG

  1. Client-Server-Architektur. Die API sollte so aufgebaut sein, dass Client und Server voneinander getrennt bleiben. Auf diese Weise können sie sich selbstständig weiterentwickeln und unabhängig voneinander eingesetzt werden.
  2. Staatenlosigkeit. REST-APIs müssen einem Protokoll ohne Status folgen. Mit anderen Worten, sie können keine Informationen über den Client auf dem Server speichern. Die Anfrage des Kunden sollte alle erforderlichen Daten im Voraus enthalten, und die Antwort sollte alles enthalten, was der Kunde benötigt. Dies macht jede Interaktion zu einem “One and Doed” -Deal und reduziert sowohl den Speicherbedarf als auch das Fehlerpotential.
  3. Cachefähigkeit. Ein “Cache” ist die temporäre Speicherung bestimmter Daten, damit diese schneller abgerufen und gesendet werden können. RESTful-APIs verwenden nach Möglichkeit zwischengespeicherte Daten, um Geschwindigkeit und Effizienz zu verbessern. Darüber hinaus muss die API den Client darüber informieren, ob jedes Datenelement zwischengespeichert werden kann und sollte.
  4. Schichtsystem. Gut gestaltete REST-APIs werden mithilfe von Ebenen erstellt, von denen jede über eine eigene Funktionalität verfügt. Diese Schichten interagieren, bleiben aber getrennt. Dies erleichtert das Ändern und Aktualisieren der API im Laufe der Zeit verbessert seine Sicherheit.
  5. Einheitliche Schnittstelle. Alle Teile einer REST-API müssen über dieselbe Schnittstelle funktionieren und in denselben Sprachen kommunizieren. Diese Schnittstelle sollte speziell für die API entwickelt werden und sich selbst weiterentwickeln können. Es sollte nicht vom Server oder Client abhängig sein, um zu funktionieren.

Jede API, die diesen Prinzipien folgt, kann als RESTful betrachtet werden. Es gibt auch eine sechste Einschränkung, die als „Code on Demand“ bezeichnet wird. Wenn diese Technik befolgt wird, kann die API den Server anweisen, Code an einen Client zu übertragen, um dessen Funktionalität zu erweitern. Diese Einschränkung ist jedoch optional und wird nicht von allen REST-APIs übernommen.

Die WordPress REST API

An diesem Punkt wundern Sie sich vielleicht, wie sich all dies auf Sie auswirkt. APIs sind hervorragende Tools, aber sind sie für Ihre tägliche Arbeit relevant? Wenn Sie ein WordPress-Benutzer sind, lautet die Antwort eindeutig "Ja".

Die WordPress REST API befindet sich seit einigen Jahren in der Entwicklung. Eine ganze Weile wurde daran gearbeitet ein unabhängiges Plugin, Zu welchen Entwicklern im Laufe der Zeit beitragen konnten, konnte jeder experimentieren.

In der Tat gab es zwei separate Versionen des REST-API-Plugins. Elemente der API wurden bereits in Update 4.4 zur Kernplattform hinzugefügt. Es folgte die vollständige Integration ab WordPress 4.7 (2016). Dies bedeutet, dass WordPress heute über eine eigene voll funktionsfähige REST-API verfügt.

Warum hat die Plattform diesen Schritt gemacht? Gemäß die Projektseite selbst, weil WordPress auf dem Weg ist, ein "vollwertiges Anwendungsframework". Mit anderen Worten, die REST-API ermöglicht der Plattform die Interaktion mit nahezu jeder Site und Webanwendung. Außerdem kann es Daten kommunizieren und austauschen, unabhängig davon, welche Sprachen ein externes Programm verwendet.

Rest api

Dies eröffnet Entwicklern zahlreiche Möglichkeiten. Außerdem ist WordPress als Plattform flexibler und universeller als je zuvor. Als Katie Keith, die Operations Director bei Barn2 Media drückt es aus:

Durch das Verständnis der REST-API können WordPress-Entwickler den effektivsten Weg wählen, um jede Aufgabe zu implementieren, ohne sich auf bestimmte Technologien oder Plattformen wie PHP oder das WordPress-Backend zu beschränken. Die REST-API wird effektiv eingesetzt und erleichtert die Integration von Drittanbietern erheblich. Sie eröffnet sogar neue Möglichkeiten, z. B. eigene WordPress-basierte mobile Apps zu erstellen oder neue und einzigartige Möglichkeiten für die Kommunikation mit WordPress zu erkunden.

Es ist auch wichtig zu beachten, dass Sie diese Funktion möglicherweise hören, die manchmal als WordPress JSON REST API bezeichnet wird. Der JSON-Teil, Dies steht für JavaScript Object Notation und beschreibt das Format, das diese API zum Datenaustausch verwendet. Dieses Format basiert auf JavaScript und ist eine beliebte Methode zur Entwicklung von APIs, da es mit vielen gängigen Programmiersprachen kompatibel ist. Mit anderen Worten, eine JSON-API kann die Kommunikation zwischen Anwendungen, die verschiedene Sprachen verwenden, einfacher vereinfachen.

Die Anatomie einer WordPress REST API-Anfrage

Sie sollten nun den allgemeinen Zweck und die Richtung der WordPress-REST-API verstehen. Lassen Sie uns daher einige Einzelheiten zur Funktionsweise erläutern. Es gibt einige grundlegende Konzepte, die Sie verstehen müssen, wenn Sie praktische Erfahrungen sammeln und selbst mit der API experimentieren möchten.

Wie bereits erläutert, verarbeitet jede API Anforderungen und gibt Antworten zurück. Mit anderen Worten, ein Client fordert ihn auf, eine bestimmte Aktion auszuführen, und die API führt diese Aktion aus. Wie APIs dies tun, kann variieren. REST-APIs wurden speziell entwickelt, um bestimmte Arten von Anforderungen mithilfe einfacher HTML-Befehle (oder „Methoden“) zu empfangen und zu beantworten..

Zur Veranschaulichung hier die meisten grundlegende und wichtige HTML-Methoden Ein Kunde kann senden:

HTML-Methoden

  • ERHALTEN: Dieser Befehl ruft eine Ressource vom Server ab (z. B. ein bestimmtes Datenelement)..
  • POST: Damit fügt der Client dem Server eine Ressource hinzu.
  • STELLEN: Mit dieser Option können Sie eine Ressource bearbeiten oder aktualisieren, die sich bereits auf dem Server befindet.
  • LÖSCHEN: Wie der Name schon sagt, wird dadurch eine Ressource vom Server entfernt.

Zusammen mit diesen Befehlen sendet der Client eine oder mehrere Zeilen, die genau mitteilen, welche Ressource gewünscht wird und was damit zu tun ist. Eine Anforderung zum Hochladen einer PHP-Datei in einen bestimmten Ordner auf einem Server könnte beispielsweise folgendermaßen aussehen:

POST /foldername/my_file.php

Der Teil /foldername/my_file.php ist die “Route” genannt, da es der API mitteilt, wohin sie gehen soll und mit welchen Daten sie interagieren soll. Wenn Sie es mit der HTTP-Methode (in diesem Fall POST) kombinieren, wird die gesamte Funktion als “Endpunkt” bezeichnet..

Die meisten REST-APIs und die Clients, die mit ihnen interagieren, werden viel komplizierter – einschließlich der WordPress-Version. Diese Grundelemente bilden jedoch die Grundlage für die Funktionsweise der WordPress-REST-API.

So starten Sie die WordPress REST-API

Solange Sie eine WordPress-Site eingerichtet haben, können Sie sofort mit der REST-API experimentieren. Sie können verschiedene GET-Anforderungen ausführen, um Daten direkt abzurufen, indem Sie einfach Ihren Browser verwenden.

Um auf die WordPress REST-API zuzugreifen, müssen Sie mit der folgenden Route beginnen:

yoursite.com/wp-json/wp/v2

Anschließend können Sie dieser URL hinzufügen, um auf verschiedene Datentypen zuzugreifen. Sie können beispielsweise ein bestimmtes Benutzerprofil über eine Route wie die folgende nachschlagen:

yoursite.com/wp-json/wp/v2/users/4567

In diesem Szenario, "4567" ist die eindeutige Benutzer-ID für das Profil, das Sie anzeigen möchten. Wenn Sie diese ID weglassen, wird stattdessen eine Liste aller Benutzer auf Ihrer Website angezeigt:

Eine Liste der Benutzer in der WordPress REST-API.

Sie können dieselbe grundlegende Route verwenden, um andere Datentypen anzuzeigen, z. B. Ihre Beiträge oder Seiten. Sie können sogar nach Teilmengen der Daten suchen, die bestimmte Kriterien erfüllen. Mit dieser URL können Sie beispielsweise alle Beiträge abrufen, die einen bestimmten Begriff enthalten:

yoursite.com/wp-json/wp/v2/posts?=search[keyword]

Dies ist natürlich nur eine einfache Illustration. Es gibt fast keine Begrenzung, was Sie mit der WordPress-REST-API tatsächlich tun können. Wenn Sie mehr über die Funktionsweise erfahren möchten, empfehlen wir, mit den folgenden Ressourcen zu beginnen:

Die WordPress REST API ist zweifellos ein komplexes Thema. Selbst für Nicht-Entwickler lohnt es sich jedoch, die Grundlagen zu verstehen, wie diese Technologie funktioniert und was sie ermöglicht. Darüber hinaus können Sie möglicherweise sogar selbst mit der Entwicklung beginnen!

Ein weiterer Ansatz zur Verwendung der WordPress-REST-API

Die WordPress REST API kann für eine Reihe interessanter Dinge und Projekte verwendet werden. Wir haben das ziemlich klar festgestellt.

Es gibt jedoch einen Bereich, in dem es eine echte Popularität erlangt hat:

Headless WordPress ist die Idee, die beiden Hauptebenen des WordPress-Ökosystems zu entkoppeln – das Backend und das Frontend.

Auf diese Weise können Sie alle Extras, die die WordPress-Software unter der Haube hat, mit einem Endprodukt verbinden, das nicht die Standard-WordPress-Präsentation verwendet – es ist per se keine Website.

Das ganze Konzept ist sehr interessant. Wir sprechen in einem anderen Beitrag darüber, in dem wir diskutieren, ob kopfloses WordPress sinnvoll ist, und die besten kopflosen WordPress-Hosting-Lösungen auf dem Markt vergleichen.

Fazit

Es gibt keinen besseren Zeitpunkt, um mehr über die WordPress REST-API zu erfahren als jetzt. Da es vollständig in den WordPress-Kern integriert wurde, wird es eine wichtige Rolle in der Zukunft der Plattform spielen. Entwickler aller Art werden diese API verwenden, um WordPress auf eine Weise mit dem breiteren Web zu verbinden, die zuvor schwierig oder unmöglich war.

Dieses Konzept selbst zu verstehen, kann eine Herausforderung sein. Grundsätzlich sind die Konzepte jedoch leicht zu verstehen. Eine REST-API ist eine Schnittstelle, über die zwei Programme miteinander kommunizieren können. Sie wird erstellt folgenden Richtlinien Dies stellt sicher, dass es flexibel, erweiterbar und sicher ist. Wenn Sie genauer untersuchen möchten, wie all dies funktioniert und wie es verwendet werden kann, gibt es viele hilfreiche Ressourcen, wie z. B. den Beamten Handbuch.

Haben Sie Fragen zur REST-API und deren Bedeutung für WordPress? Fragen Sie uns in den Kommentaren unten!

Vergessen Sie nicht, an unserem Crashkurs teilzunehmen, um Ihre WordPress-Site zu beschleunigen. Mit einigen einfachen Korrekturen können Sie Ihre Ladezeit sogar um 50-80% reduzieren:

Jeffrey Wilson Administrator
Sorry! The Author has not filled his profile.
follow me
    Это интересно
    Adblock
    detector