Co to jest WordPress REST API i jak z niego korzystać?

Opublikowany: 2022-06-30

Prawdopodobnie słyszałeś o REST API. Być może słyszałeś, że korzystają na tym użytkownicy WordPressa. Ale możesz się również zastanawiać, czym dokładnie jest WordPress API.

Zrozumienie działania interfejsów API nie jest tak skomplikowane, jak się wydaje. Czytaj dalej, aby dowiedzieć się, czym jest API, czym jest REST API i jak możesz używać WordPress REST API w swoich witrynach.

Co to jest API?

Interfejs programowania aplikacji (API) to sposób, w jaki dwie aplikacje „porozumieją się” ze sobą. Jeden system zgłasza żądanie, a drugi je spełnia. Żądania, które system akceptuje, muszą być zawarte w API — w przeciwnym razie żądanie nie może zostać spełnione.

Pomyśl o tym w ten sposób. Może jesteś naprawdę głodny, więc idziesz do Waffle House. Zamawiasz kawę, jajka i naleśniki. Kelnerka zaczyna spisywać Twoje zamówienie — a potem jest zdezorientowana, gdy dochodzisz do naleśników. Waffle House nie serwuje naleśników. Podają tylko gofry.

System żądający naleśników z menu API, które serwuje tylko gofry, będzie głodny.

Co to jest REST API?

Kiedy mówimy REST API, mamy na myśli system ograniczeń zaprojektowany dla internetu. Opisuje, w jaki sposób jedna witryna może żądać informacji od innej witryny w sposób skalowalny i jednolity. REST to skrót od Representational State Transfer, który został zdefiniowany przez Roya Fieldinga w jego rozprawie doktorskiej.

Co to jest WordPress REST API?

WordPress REST API odnosi się do żądań skierowanych do witryny działającej na WordPress. Jeśli poprosimy o listę postów lub stron, możemy spodziewać się otrzymania tych informacji z interfejsu API REST WordPress. WordPress nigdy nie udostępni żadnych informacji, które nie są upublicznione, takich jak wersje robocze postów lub (co ważniejsze) hasła użytkowników.

Jest to podstawa Edytora bloków, który dynamicznie wymienia dane z WordPress bez ponownego ładowania strony. Każdy punkt końcowy zwraca dane w formacie JSON, który może być odczytany przez JavaScript — lub w tym przypadku bloki.

Pamiętaj, że REST API jest tylko jednym z interfejsów API dostarczanych przez WordPress. Istnieje również, na przykład, Database API i Metadata API, które są używane przez wtyczki do interakcji z WordPress na serwerze. Więcej informacji o API WordPress znajdziesz w Kodeksie.

Jak działa żądanie WordPress REST API?

Istnieje kilka podstawowych części REST API, a mianowicie: trasy, punkty końcowe, żądania i odpowiedzi.

Trasy

Trasa to sposób, w jaki odwołujemy się do adresu URL, za pomocą którego komunikuje się witryna. Popularną drogą w WordPressie jest „/wp-admin”. Chociaż nie jest to trasa interfejsu API REST, jest to trasa używana przez przeglądarkę w celu uzyskania dostępu do pulpitu administracyjnego WordPress. Dla naszych celów trasy REST API zaczynają się od „/wp-json” (przy czym JSON jest standardowym formatem danych).

Punkty końcowe

Punkt końcowy to połączenie trasy i typu żądania przychodzącego. Pojedyncza trasa może łączyć się z wieloma punktami końcowymi, ponieważ istnieje wiele typów żądań. Typowe typy żądań to GET (jak odczytujemy dane na trasie) i POST (jak aktualizujemy dane na trasie).

Prośby i odpowiedzi

Każda komunikacja z REST API jest umieszczona pomiędzy żądaniem a odpowiedzią. Jeden system wysyła żądanie, na które odpowiada drugi system. WordPress REST API zawiera przydatne obiekty dla wtyczek, aby uzyskać dostęp do danych żądania (WP_REST_Request) i zarządzać danymi odpowiedzi (WP_REST_Response) podczas rozszerzania WordPress REST API.

Jak zainstalować REST API w WordPressie

Od wersji WordPress 4.7, WordPress zawiera REST API jako podstawową funkcję.

Jeśli korzystasz ze starszej wersji, możesz zainstalować wtyczkę funkcji json-rest-api. Zostało to wykorzystane do opracowania REST API przed pełną integracją z bazą kodu WordPress. Ta wtyczka jest technicznie zamknięta, więc zaleca się zamiast tego zaktualizować swoją wersję WordPressa (lub rozważ Zarządzany hosting WordPressa, a będziesz zawsze na bieżąco).

Przykłady WordPress REST API

Zajrzyj na stronę GiveWP. Jeśli wejdziesz na ich blog, będziesz mógł zobaczyć najnowsze wiadomości i posty. Ta trasa renderuje HTML, który jest przyjemny dla oka, ale trudny dla programisty do interakcji. Zamiast tego posty są udostępniane programistom przy użyciu trasy „/wp-json/wp/v2/posts”.

Trasa „/wp-json/wp/v2/posts” mówi nam, że jest to zasób WordPress („/wp”), że jest to wersja 2 („/v2/”) zasobu, a konkretnie, że są to posty („/posty”). Jeśli jeszcze tego nie zrobiłeś, odwiedź https://givewp.com/wp-json/wp/v2/posts i porównaj to, co widzisz z https://givewp.com/blog/. Dam ci podpowiedź — to ta sama informacja!

Aby zapoznać się z przykładem wykorzystania REST API w WordPress, rozważ blok najnowszych postów. Aby uzyskać listę postów w WordPressie, witryna tradycyjnie musiałaby wysłać żądanie do serwera, a następnie ponownie wyrenderować całą stronę.

Ostatni blok postów może żądać tylko postów, a następnie ponownie się renderować. Robi to za pomocą interfejsu API REST. I może to zrobić wiele razy, aby odpytywać o nowe posty — bez ponownego renderowania całej strony. Jest to szczególnie przydatne, gdy rozważasz pełną edycję witryny, w której bloki są używane do edycji i wyświetlania komponentów strony.

Każdy pojedynczy składnik może zażądać danych, których potrzebuje (w tym sprawdzić dostępność aktualizacji), a następnie ponownie renderować tylko to, co się zmieniło.

Teraz wiesz

Teraz, gdy znasz cel i strukturę interfejsu API REST WordPress, przejrzyj, aby zobaczyć, co możesz znaleźć samodzielnie. Aby uzyskać pełny opis korzystania i rozszerzania interfejsu API REST WordPress, zapoznaj się z Podręcznikiem interfejsu API REST.

Pamiętaj: jeśli ktoś zapyta Cię o API, nie możesz zamówić naleśników w Waffle House.

Podczas dostrajania witryny nie zapominaj, że świetne witryny wymagają doskonałego hostingu. Wszystko to otrzymujesz dzięki Managed WordPress by Nexcess. Dzięki potężnym prędkościom, opcjom skalowalności i wyjątkowej obsłudze możesz polegać na Nexcess, aby zasilać swoją witrynę WordPress.

Przyjdź i przekonaj się, dlaczego Nexcess zawiera lepsze. Już dziś sprawdź nasze w pełni zarządzane plany hostingowe WordPress.

Poznaj plany hostingowe WordPress

Powiązane zasoby WordPress

  • WordPress.com vs WordPress.org
  • 5 zaawansowanych technik przyspieszających działanie witryny WordPress
  • Co to jest hosting WordPress?
  • Niezbędny przewodnik po wtyczkach WordPress
  • Jak wybrać hosta internetowego: na co zwrócić uwagę i czego unikać?