Pochopenie rozhrania WordPress REST API: Sprievodca pre vývojárov

Úvod

Vytvorenie webovej stránky je zložitý a viacstupňový proces. Na začiatok musíte najprv nájsť kvalitné hostingové riešenie. Ak sa chystáte vytvoriť novú webovú lokalitu a nemáte veľmi vysoké nároky na zdroje a neočakávate veľmi vysokú návštevnosť, server VPS je univerzálne riešenie, ktoré bude vhodné pre väčšinu webových lokalít. Ak vám záleží na spôsobe platby, mali by ste vedieť, že si môžete vybrať z rôznych možností, napríklad VPS s kreditnou kartou, bitcoinový VPS, AliPay VPS atď.

Ďalším základným aspektom tvorby webovej stránky je výber CMS - systému správy obsahu, špeciálneho nástroja, ktorý sa používa na napĺňanie webovej stránky obsahom a jeho úpravu. Ak je vašou voľbou WordPress, vývojári sa budú musieť vysporiadať s rozhraním WordPress REST API.

Wordpress je v súčasnosti jedným z najobľúbenejších CMS na tvorbu webových stránok. Rozhranie REST API je zasa základným rozhraním, ktoré sa používa na prácu s webovou lokalitou Wordpress. Vďaka rozhraniu REST API získajú vaše aplikácie možnosť komunikovať s vašou webovou stránkou prostredníctvom súborov JSON. Vývojári tak môžu nad systémom Wordpress vytvárať vlastné aplikácie, webové lokality a zásuvné moduly. Rozhranie REST API umožňuje vývojárom komunikovať s údajmi Wordpress pomocou príkazov HTTP.

V nasledujúcom texte sa pozrieme na niekoľko základných príkazov, ktoré budú užitočné pre každého vývojára.

Rozhranie API WordPress REST: Základy

GET:

Používa sa na načítanie údajov z databázy WordPress pomocou metódy HTTP GET. Tento príkaz je jedným z najbežnejších príkazov, pretože je prvým príkazom, ktorý použijete pred tým, ako začnete niečo robiť s údajmi.

Umožňuje načítanie konkrétneho zdroja, napríklad príspevku, stránky alebo vlastného typu príspevku, bez toho, aby ho bolo potrebné upravovať.

Ak chcete použiť túto metódu, musíte poslať požiadavku na konkrétny koncový bod s danou sadou parametrov. Koncový bod je prezentovaný adresou URL zdroja s parametrami, ktoré chcete získať - napríklad ID zdroja, možnosti filtrovania, informácie o stránkovaní a ďalšie parametre dotazu.

Ak napíšete toto:

GET http://yoursite.com/wp-json/wp/v2/posts/983

získate podrobnosti o príspevku s týmto konkrétnym ID, ako je jeho názov, obsah, autor a ďalšie metadáta.

Okrem toho môžete získať informácie o zozname zdrojov. Ak napríklad chcete vidieť všetky publikované, mali by ste do požiadavky koncového bodu pridať /wp/v2/posts?status=publish:

GET http://yoursite.com/wp-json/wp/v2/posts?status=publish

POST:

Tento príkaz sa používa na pridanie niečoho nového na vašu webovú lokalitu. V skutočnosti to môže byť príspevok, ale môže sa použiť aj pre stránky, komentáre a iné prílohy.

Ak chcete vytvoriť nový príspevok, pridajte do koncového bodu /wp/v2/posts.

POST http://yoursite.com/wp-json/wp/v2/posts

Potom budete môcť do užitočného zaťaženia zahrnúť údaje o novom príspevku, napríklad jeho názov, obsah, autora a ďalšie metadáta:

"title": "Môj nový príspevok", "content": "Toto je obsah môjho nového príspevku.", "author": 1, "status": "publish"

PUT:

POST sa používa na vytváranie prázdnych návrhov stránok a príspevkov. Ak chcete jeden z nich ďalej aktualizovať novým obsahom, môžete použiť príkaz PUT. Ten možno ďalej použiť na publikovanie skôr vytvorených návrhov.

Ak chcete zobraziť všetky aktuálne návrhy, môžete použiť príkaz POST týmto spôsobom:

POST http://yoursite.com/wp-json/wp/v2/posts/?status="draft".

Potom môžete pomocou príkazu PUT zmeniť stav konkrétneho návrhu zadaním jeho ID:

PUT http://yoursite.com/wp-json/wp/v2/posts/983

Tým sa sprístupní váš príspevok s možnosťou jeho úpravy. Teraz musíte zmeniť jeho stav z "draft" na "publish":

"status" = "publish"

Okrem toho do nej môžete pridať ďalší obsah pomocou argumentu "status":

"status" = "publish" "content" = "obsah tu"

DELETE:

Ďalší dôležitý príkaz používaný na odstraňovanie príspevkov, stránok, obsahu a používateľov. Odstránený príspevok sa najprv vloží do koša.

Ak chcete odstrániť konkrétny príspevok, napríklad vyššie vytvorený príspevok, zadajte niečo také:

DELETE http://yoursite.com/wp-json/wp/v2/posts/983

Ak chcete príspevok nadobro odstrániť bez toho, aby ste ho poslali do koša, pridajte zaň ?force=true:

DELETE http://yoursite.com/wp-json/wp/v2/posts/983?force=true

MOŽNOSTI:

Ak chcete skontrolovať, či sú pre daný prostriedok dostupné komunikačné možnosti, môžete použiť tento príkaz. Po zadaní príkazu sa na výstupe zobrazí zoznam komunikačných metód, ktoré sú pre daný prostriedok k dispozícii, spolu s ďalšími dôležitými informáciami, ako sú podporované schémy overovania, hlavičky požiadaviek a typy obsahu.

HLAVA:

Tento príkaz umožňuje načítať hlavičky obsahu bez toho, aby ste museli pracovať so skutočným obsahom. Vývojár tak môže získať potrebné informácie o častiach obsahu, ako sú informácie o vyrovnávacej pamäti, type obsahu a dĺžke obsahu, bez toho, aby ich musel sťahovať.

PATCH:

Tento príkaz umožňuje aktualizovať konkrétnu časť obsahu. Je trochu podobný príkazu PUT, ale nemusíte úplne nahradiť konkrétny zdroj. Takto môžete aktualizovať názov alebo obsah príspevku, ako aj metadáta, ktoré sú spojené s používateľom, pričom zvyšok zostane nezmenený.

Pri použití príkazu musíte určiť, ktoré zmeny chcete vykonať. Ak chcete napríklad upraviť názov, musíte ho pridať do tela požiadavky:

"title": "Názov nového príspevku"

Záver

Rozhranie WordPress REST API je multifunkčné rozhranie, ktoré umožňuje aplikáciám komunikovať s vašou stránkou WordPress. Rozhranie sa spravuje pomocou rôznych príkazov, ktorým sme venovali dnešný článok. Dúfame, že tieto informácie boli užitočné, ďakujeme za váš čas!