O introducere în API-ul REST WordPress

În decembrie 2016, odată cu lansarea WordPress 4.7, a avut loc o etapă dezbătută îndelung: API-ul WordPress REST a fost inclus oficial ca parte a WordPress Core.

Deși API-ul REST existase ca plugin înainte de fuziunea oficială în nucleu, includerea sa ulterioară a stârnit destul de multă dezbatere, argumentând atât pentru includerea sa, cât și pentru necesitatea unor teste suplimentare.

În cele din urmă, API-ul REST a fost îmbinat în Core și acum alimentează Editorul de blocuri, precum și multe integrări și interfețe terță parte cu site-uri WordPress de pe web.

Cu toate acestea, pentru mulți utilizatori WordPress, aceasta a fost prima dată când au auzit vreodată de REST API de orice fel, cu atât mai puțin de unul integrat atât de strâns în WordPress.

Deci, în acest articol, vom arunca o privire la ce este un API REST, la felul în care este unic API-ul REST WordPress și câteva exemple despre cum funcționează și câteva dintre tipurile de tehnologie care sunt activate acum că este inclusă în WordPress. Miez.

Ce este un API REST?

Termenul REST API este de fapt două acronime în unul și ambele sunt importante atunci când înțelegem cum funcționează și ce face API-ul REST WordPress.

Ce este REST?

Prima parte, REST, reprezintă transferul de stat reprezentativ. Pe cât de simplu posibil, aceasta este o specificație care definește modul în care două resurse separate de pe web ar trebui să comunice între ele. Aceste două interfețe pot fi două site-uri web diferite, un server web, o aplicație mobilă și multe altele.

Un serviciu care urmează această specificație este adesea denumit serviciu RESTful și funcționează pentru a se asigura că clientul care solicită informații nu trebuie să știe nimic despre starea serverului și despre modul în care clientul și serverul pot fi mai modulare și mai separate decât cu altele. metode de transport de date pe internet.

În esență, dacă un dezvoltator știe că interacționează cu un serviciu RESTful, poate face anumite presupuneri cu privire la modul în care solicitările lor vor fi formatate și ce fel de date vor primi în schimb, ceea ce este foarte util în dezvoltarea tehnologiilor interconectate.

Dacă doriți să aprofundați exact ceea ce alcătuiește un serviciu RESTful și cum sunt făcute aceste tipuri de solicitări, aș recomanda cu căldură să consultați articolul Codecademy numit Ce este REST?

Ce este un API?

API înseamnă Application Programming Interface și, după cum sugerează și numele, oferă o interfață pentru alți clienți și servicii de pe web pentru a interacționa cu o anumită aplicație. Specifică punctele finale, de obicei URL-uri, unde pot fi trimise datele, dacă aceste URL-uri returnează date sau creează resurse pe server și dacă este necesar un anumit tip de autentificare pentru a accesa aceste puncte finale.

Pentru multe servicii populare de pe web astăzi, API-urile oferă o modalitate automată de a face ceea ce un utilizator ar putea face manual, permițând unui script sau a unei fragmente de cod să efectueze aceeași acțiune cu un utilizator prezent. De exemplu, dacă utilizați Reddit și vă găsiți să scrieți același tip de comentariu pe multe dintre firele pe care le navigați, puteți crea un script care a căutat în Reddit acele tipuri de comentarii și a postat automat răspunsul dvs. standard prin API-ul Reddit.

Prin expunerea infrastructurii lor printr-un API, utilizatorii nu trebuie să se bazeze pe metode fragile de web scraping pentru a automatiza acest tip de sarcini, iar Reddit poate urmări cine le accesează resursele prin intermediul API-ului lor, cât de des o fac și controlează pentru utilizare care este în afara termenilor lor de serviciu.

De ce a avut nevoie WordPress de un API REST?

Dacă ați făcut vreodată solicitări asemănătoare API către WordPress înainte ca API-ul REST să facă parte din Core, este posibil să fiți familiarizat cu conceptul de admin-ajax. Acesta a fost modul original de a face cereri ca acesta în WordPress, unde fiecare solicitare a fost direcționată prin fișierul admin-ajax.php, a verificat orice acțiuni specifice pe care dezvoltatorii oricăror plugin-uri sau teme active le-au înregistrat și apoi au folosit acele funcții înregistrate pentru a satisface cererile.

După cum v-ați putea aștepta, asta însemna că fiecare dezvoltator care a folosit solicitări asemănătoare API-ului a activat această funcționalitate ca parte a pluginului sau a temei lor, a făcut acest lucru ușor diferit și oricine dorea să interacționeze cu această funcționalitate trebuia să se familiarizeze cu modul în care era fiecare plugin sau temă. construit. API-ul REST WordPress a fost introdus pentru a standardiza modul în care au fost făcute aceste solicitări și pentru a oferi un set mult mai larg de puncte finale care ar putea fi utilizate pentru a interacționa cu WordPress Core în sine.

Un exemplu de solicitare către API-ul REST WordPress

Manualul WordPress REST API menține o listă completă a punctelor finale care sunt acceptate în WordPress REST API din cutie. Și deși este grozav să ai o listă completă, poate fi puțin copleșitor. Să aruncăm o privire la ceea ce ar putea fi considerată cea mai de bază funcționalitate a oricărei interacțiuni API: preluarea resursei de bază a API-ului. În cazul WordPress, resursa respectivă este postată.

Toate punctele finale ale API-ului REST WordPress sunt prefixate cu calea URL wp-json între domeniul rădăcină și ceea ce manualul API-ului REST se referă ca Base Route . Aceasta înseamnă că, dacă accesăm punctul final pentru a enumera postările site-ului și adresa URL a site-ului nostru a fost example.com , ar trebui să facem o solicitare la adresa URL https://example.com/wp-json/wp/v2/posts .

Efectuarea unei solicitări GET, fie pur și simplu încărcând acea adresă URL în browserul dvs. web preferat sau folosind un browser API, cum ar fi Postman, ar trebui să vă returneze o listă de postări din API, deși este posibil să nu fie într-un format pe care îl utilizați dvs. la. Dacă tot ceea ce vedeți este un șir lung de text, vă uitați la un format de date cunoscut sub numele de JSON. Dacă accesați punctul final API prin browser și doriți să vă uitați la aceste informații într-un format mai ușor de citit, vă recomand să instalați extensia JSON Viewer. Aceasta va detecta orice ieșire din browser care este JSON și o va formata astfel încât să o puteți citi mai ușor. Cu aceasta instalată, ar trebui să vedeți date postate din API-ul REST WordPress și ați făcut cu succes prima solicitare API-ul REST!

Ce altceva poate face API-ul REST WordPress?

În afară de a obține o listă cu cele mai recente postări de pe un site WordPress, uitându-ne la Referința punctului final, veți vedea că există o mulțime de alte moduri în care puteți interacționa cu API-ul REST WordPress. Dacă sunteți autentificat ca utilizator WordPress, puteți publica postări prin intermediul API-ului, puteți obține o listă de teme disponibile pe site, puteți vizualiza și edita setările, precum și multe dintre celelalte funcționalități care sunt disponibile pentru a fi interacționate manual prin wp-admin. .

Câteva exemple de API-ul REST WordPress în acțiune

Expunerea capacității de a interacționa cu WordPress prin intermediul API-ului REST a deschis o gamă largă de posibilități de site-uri care ar putea utiliza acum WordPress ca backend pentru gestionarea conținutului.

TechCrunch : La scurt timp după anunțarea API-ului WordPress REST, TechCrunch a anunțat că și-a reconstruit site-ul folosind o arhitectură fără cap, ceea ce însemna că foloseau WordPress pe backend ca sistem de gestionare a conținutului, putând în același timp să folosească o „o singură pagină”. stilul aplicației React” pe front-end.

Editor de blocuri (Gutenberg) : Poate că utilizarea API-ului REST de care au beneficiat majoritatea oamenilor este Editorul de blocuri WordPress. Acum, editorul principal din WordPress, o mare parte din funcționalitatea Editorului bloc este activată de faptul că poate interacționa cu punctele finale API REST WordPress fără

Tot felul de proiecte comunitare : când API-ul REST a fost luat în considerare pentru prima dată pentru îmbinare într-un nucleu, a avut loc un apel public în care le-a cerut oamenilor să vorbească mai multe despre cum foloseau API-ul REST. Răspunsurile au fost foarte variate, la care vă puteți aștepta de la o comunitate atât de mare ca WordPress, dar au inclus totul, de la pluginuri cu interfețe mai interactive decât era posibil anterior, până la oameni care construiesc aplicații mobile pentru clienții lor care ar putea consuma conținut WordPress.

Încheierea

Chiar dacă nu aveți experiență în utilizarea API-urilor, probabil că ați folosit ceva la un moment dat în cariera dvs. care se bazează pe API-ul REST WordPress pentru a funcționa. Pe măsură ce interfețele continuă să devină mai dinamice și site-urile web încep să aibă mai multe acțiuni care nu necesită o încărcare a paginii.

Acum că știți ce este API-ul REST WordPress, s-ar putea să vă gândiți la câteva lucruri pe care le puteți construi cu el! API-ul REST poate fi cu siguranță un instrument puternic în cutia dvs. de instrumente pentru a crea teme și plugin-uri WordPress și mai bune.

Dacă aveți nevoie de mai multe clarificări sau de câteva exemple despre ceea ce este posibil, aruncați o privire la documente și accesați imediat!