Porozumění rozhraní WordPress REST API: Průvodce pro vývojáře

Úvodní stránka

Vytvoření webových stránek je složitý a vícestupňový proces. Na začátku je třeba nejprve najít kvalitní hostingové řešení. Pokud se chystáte vytvořit nové webové stránky a nemáte příliš vysoké nároky na zdroje a neočekáváte velmi vysokou návštěvnost, je server VPS univerzálním řešením, které bude vhodné pro většinu webových stránek. Pokud vám záleží na způsobu platby, měli byste vědět, že si můžete vybrat z celé řady možností, například VPS s kreditní kartou, bitcoinový VPS, AliPay VPS atd.

Dalším zásadním aspektem tvorby webových stránek je volba CMS - systému pro správu obsahu, speciálního nástroje, který slouží k naplnění webových stránek obsahem a jeho úpravám. Pokud je vaší volbou WordPress, budou se vývojáři muset vypořádat s rozhraním WordPress REST API.

Wordpress je v současné době jedním z nejoblíbenějších CMS pro tvorbu webových stránek. Rozhraní REST API je zase základním rozhraním, které se používá pro práci s webovými stránkami Wordpress. Díky rozhraní REST API získají vaše aplikace možnost komunikovat s webovými stránkami prostřednictvím souborů JSON. Vývojáři tak mohou nad aplikací Wordpress vytvářet vlastní aplikace, webové stránky a pluginy. Rozhraní REST API umožňuje vývojářům komunikovat s daty Wordpress pomocí příkazů HTTP.

V následujícím textu se podíváme na několik základních příkazů, které se budou hodit každému vývojáři.

Rozhraní WordPress REST API: Základy

GET:

Slouží k načtení dat z databáze WordPress pomocí metody HTTP GET. Tento příkaz je jedním z nejběžnějších příkazů a je prvním příkazem, který použijete předtím, než s daty skutečně něco provedete.

Umožňuje načtení konkrétního zdroje, například příspěvku, stránky nebo vlastního typu příspěvku, aniž by došlo k jeho úpravě.

Chcete-li metodu použít, musíte odeslat požadavek na konkrétní koncový bod s danou sadou parametrů. Koncový bod je prezentován adresou URL zdroje s parametry, které chcete získat - například ID zdroje, možnosti filtrování, informace o stránkování a další parametry dotazu.

Pokud napíšete toto:

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

získáte podrobnosti o příspěvku s tímto konkrétním ID, jako je jeho název, obsah, autor a další metadata.

Dále můžete získat informace o seznamu zdrojů. Pokud například chcete zobrazit všechny zveřejněné, měli byste do požadavku na koncový bod přidat /wp/v2/posts?status=publish:

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

POST:

Tento příkaz slouží k přidání něčeho nového na vaše webové stránky. Může to být skutečně příspěvek, ale lze jej použít i pro stránky, komentáře a další přílohy.

Chcete-li vytvořit nový příspěvek, přidejte do koncového bodu /wp/v2/posts.

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

Do užitečného zatížení pak budete moci zahrnout údaje o novém příspěvku, jako je jeho název, obsah, autor a další metadata:

"title": "Můj nový příspěvek", "content": "Toto je obsah mého nového příspěvku.", "author": 1, "status": "publish"

PUT:

POST se používá k vytváření prázdných návrhů stránek a příspěvků. Chcete-li jej dále aktualizovat novým obsahem, můžete použít příkaz PUT. Ten lze dále použít k publikování dříve vytvořených návrhů.

Chcete-li zobrazit všechny aktuální návrhy, můžete použít příkaz POST tímto způsobem:

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

Poté můžete pomocí příkazu PUT změnit stav konkrétního návrhu zadáním jeho ID:

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

Tím se zpřístupní váš příspěvek s možností jeho úpravy. Nyní musíte přepnout jeho stav z "draft" na "publish":

"status" = "publish"

Kromě toho do něj můžete přidat další obsah pomocí argumentu "status":

"status" = "publish" "content" = "obsah zde"

DELETE:

Další základní příkaz, který se používá k odstraňování příspěvků, stránek, obsahu a uživatelů. Smazaný příspěvek se nejprve umístí do koše.

Chcete-li odstranit konkrétní příspěvek, například výše vytvořený příspěvek, zadejte něco takového:

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

Pokud chcete příspěvek nadobro odstranit, aniž byste ho poslali do koše, přidejte za něj ?force=true:

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

MOŽNOSTI:

Pokud chcete zkontrolovat, zda jsou pro daný prostředek dostupné možnosti komunikace, můžete použít tento příkaz. Po zadání příkazu se na výstupu zobrazí seznam komunikačních metod, které jsou pro daný prostředek k dispozici, spolu s dalšími důležitými informacemi, jako jsou podporovaná schémata ověřování, hlavičky požadavků a typy obsahu.

HLAVA:

Tento příkaz umožňuje načíst záhlaví obsahu bez nutnosti pracovat se skutečným obsahem. Vývojář tak může získat potřebné informace o částech obsahu, jako jsou informace o ukládání do mezipaměti, typ obsahu a jeho délka, aniž by je musel stahovat.

PATCH:

Tento příkaz umožňuje aktualizovat určitou část obsahu. Je do jisté míry podobný příkazu PUT, ale nemusíte zcela nahradit konkrétní zdroj. Takto můžete aktualizovat název nebo obsah příspěvku, stejně jako metadata, která jsou spojena s uživatelem, zatímco zbytek zůstane stejný.

Při použití příkazu musíte zadat, které změny chcete provést. Chcete-li například upravit nadpis, musíte jej přidat do těla požadavku:

"title": "Název nového příspěvku"

Závěr

Rozhraní WordPress REST API je multifunkční rozhraní, které umožňuje aplikacím komunikovat s vaším webem WordPress. Rozhraní se spravuje pomocí různých příkazů, kterým jsme věnovali dnešní článek. Doufáme, že vám tyto informace byly užitečné, děkujeme za váš čas!