API plugin. API plugin Pripojenie doplnku API tretej strany pre minecraft

Doplnky sú kľúčovou súčasťou ekosystému webového balíka a poskytujú komunite účinný spôsob, ako využiť proces kompilácie webového balíka. Zásuvný modul sa dokáže pripojiť ku kľúčovým udalostiam, ktoré sa spúšťajú počas každej kompilácie. Každý krok bude mať doplnok úplný prístup ku kompilátoru a prípadne k aktuálnej kompilácii .

Ak chcete získať úvod do písania doplnkov na vysokej úrovni, začnite písaním doplnku .

Začnime tým, že si prejdeme pomôckou na poklepanie, ktorá poskytuje chrbticu rozhrania doplnku webpacku.

Poklepávateľné

Táto malá knižnica je základnou pomôckou vo webovom balíku, ale dá sa použiť aj inde na poskytnutie podobného rozhrania zásuvných modulov. Mnoho objektov vo webovom balíku rozširuje triedu Tapable. Trieda odhaľuje metódy tap , tapAsync a tapPromise, ktoré môžu pluginy použiť na vloženie vlastných krokov zostavenia, ktoré sa budú spúšťať počas kompilácie.

Tlačový výstup je možné prispôsobiť odovzdaním rôznych argumentov funkcii reportProgress v ProgressPlugin.

Ak chcete nahlásiť pokrok, doplnok musí klepnúť na háčik pomocou možnosti context: true:

Kompilátor. háčiky. emitovať. tapAsync (( name: "MyPlugin" , context: true ) , (kontext, kompilátor, spätné volanie) => ( const reportProgress = kontext && kontext. reportProgress; if (reportProgress) reportProgress (0,95, "Začína sa pracovať" ) ; setTimeout (( ) => ( if (reportProgress) reportProgress (0,95, "Dokončená práca" ); spätné volanie () ; ), 1000 ) ; ) );

Funkciu reportProgress možno volať s týmito argumentmi:

reportProgress(percento, ... args);
  • percento: Tento argument je nepoužitý; namiesto toho ProgressPlugin vypočíta percento na základe aktuálneho háku.
  • ...args: Ľubovoľný počet reťazcov, ktoré budú odovzdané obsluhe ProgressPlugin, aby boli nahlásené používateľovi.

Všimnite si, že iba podmnožina kompilátorov a kompilačných hákov podporuje funkciu reportProgress. Úplný zoznam nájdete v ProgressPlugin.

Ťažba dreva

Logovacie API je dostupné od vydania webového balíka 4.37. Keď je v konfigurácii štatistík povolené protokolovanie a/alebo ak je povolené protokolovanie infraštruktúry, pluginy môžu protokolovať správy, ktoré sa vytlačia v príslušnom formáte zapisovača (štatistiky, infraštruktúra).

  • Pluginy by mali uprednostňovať použitie compilation.getLogger("PluginName") na zaznamenávanie. Tento druh protokolovania je uložený v štatistike a je podľa toho formátovaný. Môže byť filtrovaný a exportovaný používateľom.
  • Doplnky môžu na zaznamenávanie používať kompilátor.getInfrastructureLogger("PluginName"). Protokolovanie pomocou infraštruktúry nie je uložené v štatistike, a preto nie je naformátované. Zvyčajne sa prihlási priamo do konzoly/dashboardu/GUI. Používateľ ho môže filtrovať.
  • Doplnky môžu používať špeciálnu záložnú logiku na zisťovanie podpory protokolovania compilation.getLogger? compilation.getLogger("PluginName") : konzola na poskytovanie núdzovej pomoci pre prípady, keď sa používa staršia verzia webového balíka, ktorá nepodporuje metódu getLogger na objekte kompilácie.

Ďalšie kroky

Pozrite si sekciu háčikov kompilátora, kde nájdete podrobný zoznam všetkých dostupných hákov kompilátora a parametrov, ktoré sprístupňujú.

Plugin je dynamicky načítaná knižnica (DLL). Po nainštalovaní programu sú všetky pluginy zahrnuté v distribúcii umiestnené v adresári c:\Program Files (x86)\Common Files\Soft Gold\Inventory 14\Plugins\... Prípona *.abl sa vyžaduje pre automatické sťahovanie plugin zo zadaného adresára pri spustení aplikácie. Doplnok je možné načítať aj z akéhokoľvek iného miesta na disku zadaním vyhľadávacej cesty v nastaveniach.

Inicializuje sa rozhranie API doplnku

(Rozšírenia Delphi VCL)

(Pluginové rozhranie pre ABViewer/Inventory)

(Autorské práva (c) softvérová spoločnosť SoftGold 2002 – 2010)

{************************************************************}

jednotka sgPluginItem;

rozhranie

implementáciu

XMLDocRef: IXMLDocument = nula;

ClientRef: IXMLNode = nula;

P: ukazovateľ = nula;

PluginsHostWnd: HWND = 0;

PluginsHostWndName: string = "";

XMLAtomString: string = "";

postup InitializeDoc;

začať

// získanie jedinečného názvu triedy okna s parametrami

PluginsHostWndName:= Format("TsgPluginsHost:%.8X:%.8X", );

// nájdenie samotného okna

PluginsHostWnd:= FindWindow(PChar(PluginsHostWndName), nil);

Ak PluginsHostWnd<>0 potom

Začať

// získajte reťazec atómu, ktorý chcete získať xml parameter dokument

XMLAtomString:= Format("XMLOfs%.8X%.8X",

XMLDocRef:= IXMLDocument(GetProp(PluginsHostWnd, PChar(XMLAtomString)));

Ak je priradené (XMLDocRef), potom

Začať

// pridanie prvku do zoznamu

ClientRef:= XMLDocRef.DocumentElement.ChildNodes.ChildNodes.AddChild(sClient);

// inicializácia adresy funkcie Invoke

ClientRef.ChildValues["Invoke"] := IntToId(Integer(@Invoke)); // hexadecimálne $XXXXXXXXX

Koniec;

Koniec;

koniec;

inicializácia

CoInitialize(P);

InitializeDoc;

Nastavenie a spustenie demo verzie doplnku

Demo verzia pluginu sa nakonfiguruje automaticky pri inštalácii programu a pripojí sa ihneď po spustení Inventory. Balík obsahuje zdrojový kód komponentu (názov projektu sgPlugin.dpk) a demo verziu pluginu (názov projektu plug1.dpr).

Postup na spustenie doplnku z režimu ladenia:

▪ Otvoriť C:\Users\USER_NAME\Documents\Inventory 14\Plugins\Source\Delphi\Demos\Plug1\plug1.dpr

▪ Nastavte v možnostiach projektu:

Cesta hľadania: "..\..\Components\PlugItem";

Výstupný adresár , napríklad: „c:\Program Files\Common Files\Soft Gold\Inventory 14\Plugins“;

Hostiteľská aplikácia opäť zapnutá nainštalovaná aplikácia, napríklad: „c:\Program Files\Soft Gold\Inventory 14\Inventory 14.exe“.

▪ Spustiť na vykonanie.

Ak chcete použiť komponent v dizajnovom čase, musíte ho otvoriť, prebudovať a nainštalovať C:\Users\USER_NAME\Documents\Inventory 14\Plugins\Source\Delphi\Components\PlugItem\sgPlugin.dpk. Po inštalácii komponentu v palete komponenty Delphi, na záložke Soft Gold sa objaví komponent TsgPluginItem, ktorý je možné použiť v designtime, t.j. umiestniť na formulár.

Háčiky poskytuje WordPress, aby umožnili vášmu doplnku „zavesiť sa“ do zvyšku WordPress; to znamená volať funkcie vo vašom doplnku v konkrétnych časoch, a tým uviesť doplnok do pohybu. Existujú dva druhy háčikov:

  1. (kódex)
  2. (kódex)

Niekedy môžete dosiahnuť rovnaký cieľ buď akciou alebo filtrom. Ak napríklad chcete, aby váš doplnok zmenil text príspevku, môžete pridať funkciu akcie do publikovať_príspevok (takže príspevok sa upraví pri ukladaní do databázy) alebo funkciu filtrovania do obsahu (takže príspevok bude upravené tak, ako sa zobrazuje na obrazovke prehliadača).

Podrobný zoznam všetkých akčných a filtračných háčikov vo WP nájdete v databáze háčikov WordPress od Adama Browna.

Odkaz na funkciu

Funkcie filtra
Akcie Funkcie
Funkcie aktivácie/deaktivácie/odinštalovania

Akcie

Akcie sú spúšťané konkrétnymi udalosťami, ktoré sa dejú vo WordPress, ako je publikovanie príspevku, zmena tém alebo zobrazenie súboru . Akcia je vlastná funkcia PHP definovaná vo vašom doplnku (alebo téme) a zahnutý, t.j. nastaviť reagovať na niektoré z týchto udalostí. Akcie zvyčajne vykonávajú jednu alebo viacero z nasledujúcich činností:

  • Upravte údaje databázy.
  • Odoslať e-mailovú správu.
  • Upravte vygenerovanú administratívnu obrazovku alebo front-end stránku odoslanú do používateľského prehliadača.

Základné kroky, ako to dosiahnuť (podrobnejšie popísané nižšie), sú:

  1. Vytvorte v súbore doplnku funkciu PHP, ktorá by sa mala spustiť, keď nastane konkrétna udalosť WordPress.
  2. Pripojte túto funkciu k udalosti pomocou funkcie.
  3. Vložte svoju funkciu PHP do súboru pluginu a aktivujte ju.

Vytvorte akčnú funkciu

Prvým krokom pri vytváraní akcie vo vašom doplnku je vytvorenie funkcie PHP s funkciou akcie vášho doplnku a jej vloženie do súboru doplnku (súbor vášho doplnku musí ísť do wp-content/plugins adresár). Ak napríklad chcete, aby vaši priatelia dostali e-mailovú správu vždy, keď vytvoríte nový príspevok, môžete definovať nasledujúcu funkciu:

Funkcia email_friends($post_ID) ( $friends = " [chránený e-mailom],[chránený e-mailom]"; mail($friends, blog "sally" aktualizovaný", "Práve som niečo vložil na svoj blog: http://blog.example.com"); vrátiť $post_ID; )

Pre väčšinu akcií by vaša funkcia mala akceptovať jeden parameter (zvyčajne ID príspevku alebo komentára, v závislosti od akcie). Niektoré akcie vyžadujú viac ako jeden parameter – ďalšie informácie nájdete v dokumentácii akcie (ak je k dispozícii) alebo v zdrojovom kóde WordPress. Okrem jedného parametra môžete tiež pristupovať k a volať ďalšie funkcie WordPress (alebo funkcie v súbore doplnku).

Akýkoľvek textový výstup funkcie (napr. s tlačou) sa objaví v zdroji stránky na mieste, kde bola akcia vyvolaná.

POZNÁMKA: Majte na pamäti, že iné doplnky alebo jadro WordPress už môžu používať názov funkcie, ktorý ste si vymysleli. Viac informácií nájdete v ďalšej časti.

Predchádzanie kolíziám názvov funkcií

Je možné, že niekto vytvoril doplnok s funkciou pomenovanou rovnako ako vo vašom doplnku.

Toto je problém, pretože PHP neumožňuje viacero funkcií s rovnakým názvom. Ak dva doplnky poskytujú funkciu s rovnakým názvom alebo doplnok poskytuje funkciu s rovnakým názvom ako funkcia WordPress, blog môže prestať fungovať. Existujú dva spôsoby, ako sa tomuto problému vyhnúť.

Prvým riešením je pridať pred každú funkciu vo vašom doplnku jedinečnú sadu znakov. Ak sa voláte John Q. Public, môžete svoje funkcie deklarovať ako funkciu jqp_output() (...) . Pravdepodobnosť, že niekto s rovnakými iniciálami urobí to isté so svojím pluginom, je možná, ale nízka.

Druhým – a možno aj jednoduchším – riešením je uzavrieť funkcie vášho pluginu do triedy a volať metódy triedy staticky. Znie to komplikovanejšie, než to je.

Zvážte túto triedu, ktorá rozširuje príklady uvedené vyššie:

Class emailer ( statická funkcia send($post_ID) ( $friends = " [chránený e-mailom],[chránený e-mailom]"; mail($friends,"sally"s blog aktualizovaný","Práve som niečo vložil na svoj blog: http://blog.example.com"); vrátiť $post_ID; ) ) add_action("publikovať_príspevok", array("e-mail", "odoslať"));

Táto trieda tzv emailer má metódu poslať ktorý implementuje funkciu pluginu.

Funkcia add_action() mimo triedy pridá do WordPress akciu, ktorá mu povie, aby zavolal poslať spôsob pri zverejnení príspevku. Pole použité v druhom parametri hovorí systému pluginu, aby zavolal statickú metódu triedy „emailer“ s názvom „send“.

Funkcia poslať je chránený pred globálnym menným priestorom deklaráciou triedy. Nie je možné volať priamo send() a teda ani žiadnu inú pomenovanú funkciu poslať nebude kolidovať s týmto. Ak by ste chceli zavolať send(), museli by ste použiť operátor rozlíšenia rozsahu, ako je tento: emailer::send()

Vyššie uvedený príklad je pre statické metódy. Ak máte inštanciu triedy, potom to nebude fungovať. Ak chcete zavolať metódu inštancie potrebuješ odovzdať inštanciu ako premennú. Zvážte vyššie uvedený príklad upravený tak, aby to zohľadnil:

Class emailer ( function send($post_ID) ( $friends = " [chránený e-mailom],[chránený e-mailom]"; mail($friends,"sally"s blog aktualizovaný","Práve som niečo vložil na svoj blog: http://blog.example.com"); vrátiť $post_ID; ) ) $myEmailClass = nový emailer(); add_action("publikovať_príspevok", array($myEmailClass, "odoslať"));

Triedy sú zložitý predmet. Prečítajte si o nich viac v PHP dokumentácii o triedach.

Pripojte sa k WordPress

Keď je vaša funkcia definovaná, ďalším krokom je „zavesiť“ alebo zaregistrovať ju vo WordPress. Ak to chcete urobiť, zavolajte do globálneho vykonávacieho priestoru vášho súboru doplnku:

Add_action("názov_háku", "názov_vašej_funkcie", , );

Hook_name Názov akčného háku poskytovaného WordPress, ktorý hovorí, s ktorou udalosťou by mala byť vaša funkcia spojená. your_function_name Názov funkcie, ktorá sa má vykonať po udalosti špecifikovanej pomocou hook_name . Môže to byť štandardná funkcia php, funkcia prítomná v jadre WordPress alebo funkcia definovaná vami v súbore doplnku (napríklad „email_friends“ definovaný vyššie). priorita Voliteľný celočíselný argument používaný na určenie poradia, v ktorom sa vykonávajú funkcie spojené s konkrétnou akciou (predvolené: 10). Nižšie čísla zodpovedajú skoršiemu vykonaniu a funkcie s rovnakou prioritou sa vykonajú v poradí pridanom k ​​akcii. accept_args Voliteľný celočíselný argument definujúci, koľko argumentov môže vaša funkcia prijať (predvolený 1), užitočný, pretože niektoré háky môžu vašej funkcii odovzdať viac ako jeden argument. Tento parameter je nový vo verzii 1.5.1.

Vo vyššie uvedenom príklade by sme do súboru doplnku vložili nasledujúci riadok:

Add_action("publikovať_príspevok", "e-mail_priateľov");

Inštalovať a aktivovať

Posledným krokom k tomu, aby váš filter fungoval, je inštalácia súboru a aktivácia doplnku. Funkcia PHP, ktorú ste napísali, a volanie musia ísť do súboru PHP spolu a súbor PHP musí byť nainštalovaný v wp-content/plugins adresár. Po nainštalovaní budete musieť navštíviť sekciu správcu WordPress a aktivovať doplnok; pozri ďalšie podrobnosti.

Aktuálne háčiky pre filtre

Aktivácia/deaktivácia/odinštalovanie

Ak má váš doplnok úlohy, ktoré je potrebné dokončiť iba v čase aktivácie alebo deaktivácie, môže použiť a Action Reference – zoznam akčných háčikov WordPress

Externé zdroje

  • Databáza háčikov WordPress od Adama Browna, databáza všetkých háčikov WordPress, ktorá ukazuje, z ktorej verzie pochádzajú, a odkazuje na miesta zdrojového kódu, ktoré ich používajú. Toto je najkompletnejšie.
  • Otto na WordPress:

Od spoločnosti Yandex.
Je to webová služba, takže ju nemusíte pridávať.

Majitelia serverov potrebujú na aktiváciu tohto doplnku špeciálny kľúč.
Prihláste sa na webovú stránku Yandex a získajte tento kľúč a potom ho vložte do konfigurácie rozhrania API.
Upozorňujeme, že bezplatný kľúč podporuje „len“ 10 000 000 znakov každý mesiac, ale môžete si vytvoriť, koľko kľúčov chcete.

Toto sú dostupné jazyky:

SpoilerTarget">Spoiler

AZERBAJDŽAN
ALBÁNSKY
ANGLIČTINA
ARABSKÝ
AFRIKÁNSKY
BASKICKÝ
BIELORUSKÝ
BULHARSKÝ
BOSNIAN
WELSH
MAĎARSKÝ
VIETNAMSKÝ
HAITSKÝ
GALICIAN
HOLANDSKÝ
GRÉCKY
GRUZÍN
DÁNSKY
INDONÉZSKÝ
ÍRSKY
TALIANČINA
ISLANDSKÝ
ŠPANIELSKY
KANNADA
ČÍNSKY
KOREAN
LATINSKÝ
LITOVSKÝ
MACEDÓNSKY
MONGOLSKÝ
NEMČINA
NEPALI
NÓRSKY
PERŽSKÝ
POĽSKÝ
PORTUGALSKÝ
RUMUNSKÝ
RUSKY
SRBSKÝ
SLOVENSKÝ
SLOVENSKÝ
SUNDÁNSKY
TURECKÝ
UZBEK
UKRAJINSKÝ
FÍNSKY
FRANCÚZSKY
HINDI
CHORVÁTINA
ČEŠTINA
ŠVÉDSKO
Škótsky
ESTÓNSKY
JAPONSKÝ

Keď sa pripojíte k serveru, váš jazyk je jazykom servera.
Ak to chcete zmeniť, stačí zadať /lang(povolenie: prekladateľ.lang) a z ponuky vyberte svoj jazyk.

Ak neviete, ako pridať závislosti, prečítajte si tu.

Vývojár
Uistite sa, že používate Java >= 8.
Pridajte JAR do svojej cesty zostavy. Potom nastavte nastavenie "Manuálny manifest" a vytvorte svoj MANIFEST.MF do projektu. Napíšte:

Main-Class: your.package.Class
Cesta triedy: ..\lib\Translator.jar

Majitelia serverov
Uistite sa, že používate Java >= 8.
Vytvorte priečinok s názvom lib v koreňovom adresári hlavného servera a sem vložte JAR.
Tiež ho musíte vložiť do priečinka pluginov.

//Odoslanie správy automaticky preloženej do jazyka prehrávača
p.sendMessage("§a" + Translator.translate("Ahoj!", p));

//Odoslanie ručne preloženej správy
p.sendMessage("§a" + Translator.translate("Dobrý deň!", Jazyk.ANGLISH, Jazyk.TALIANČINA));

//Získanie jazyka servera
Jazyk serverLang = Translator.getServerLanguge();

//Získanie jazyka hráča
Jazyk playerLang = Translator.getPlayerLanguage(p);

  • Ak znova načítate rozhranie API, keď je povolený doplnok, ktorý ho používa, zlyhá. Ak chcete opraviť manuálne, uvoľnite doplnok, znova načítajte rozhranie API a načítajte doplnok
  • Farebné kódy nie sú podporované. Ak ich chcete použiť, pozrite si príklady vyššie
  • Malé oneskorenie (rozhranie API potrebuje preložiť pôvodný text a prijať JSON)

Ak máte nejaký problém, napíšte príspevok do diskusie alebo ma kontaktujte cez súkromné ​​správy. Nebudem odpovedať na hlásenia chýb v sekcii recenzií.

V súčasnosti neexistujú žiadne doplnky, ktoré používajú toto API. Ak ho používate, povedzte mi to a ja to sem pridám

Najnovšie recenzie

  1. Verzia: 1.0

    Veľký brat! Ho letto Beží na Gamehostingu, chcete si ho v Taliansku? se si: sai perché da questo errore all" avvio?

    P.s (ho letto impossibile trovare il percorso specificato, ma la cartella ci sta)

    : java.io.IOVýnimka: Nemožné trovare il percorso specificato
    : na java.io.WinNTFileSystem.createFileExclusively (Native Method)
    : na java.io.File.createNewFile(Neznámy zdroj)
    : na eu.iamgio.translator.UsersFileLoader.loadRegisterFile(UsersFileLoader.java:21)
    : na eu.iamgio.translator.Translator.onEnable(Translator.java:35)
    : na adrese org.bukkit.plugin.java.JavaPlugin.setEnabled(JavaPlugin.java:321)
    : na org.bukkit.plugin.java.JavaPluginLoader.enablePlugin(JavaPluginLoader.java:340)
    : na org.bukkit.plugin.SimplePluginManager.enablePlugin(SimplePluginManager.java:405)
    : na org.bukkit.craftbukkit.v1_8_R3.CraftServer.loadPlugin(CraftServer.java:357)
    : na org.bukkit.craftbukkit.v1_8_R3.CraftServer.enablePlugins(CraftServer.java:317)
    : na net.minecraft.server.v1_8_R3.MinecraftServer.s(MinecraftServer.java:414)
    : na net.minecraft.server.v1_8_R3.MinecraftServer.k(MinecraftServer.java:378)
    : na net.minecraft.server.v1_8_R3.MinecraftServer.a(MinecraftServer.java:333)
    : na adrese net.minecraft.server.v1_8_R3.DedicatedServer.init(DedicatedServer.java:263)
    : na net.minecraft.server.v1_8_R3.MinecraftServer.run(MinecraftServer.java:525)
    : na java.lang.Thread.run (Neznámy zdroj)

Vydané na konci roka 2015. Celkovo však iba pokročilí vývojári našli čas, aby zistili, aká silná je táto ponuka.

Balík WordPress REST API spája všetky moderné aktualizácie a poskytuje vstavané API, ktoré možno integrovať do tém, mobilných aplikácií a ďalších. Inými slovami, umožňuje vývojárom oddeliť rozhranie front-end od správy údajov, čo umožňuje akejkoľvek aplikácii interagovať s WordPress. Naučiť sa, ako tento nástroj funguje, vám môže otvoriť dvere k takmer nekonečným možnostiam rozšírenia vášho webu WordPress.

V tomto článku vám predstavíme projekt WordPress REST API, vysvetlíme, prečo je taký dobrý, a potom ponúkneme niekoľko nápadov na jeho použitie. Tak nestrácajme čas a začnime!

Predstavujeme WordPress REST API

Projekt WordPress REST API (REST from Representational State Transfer) potvrdzuje, že WordPress podniká kroky k tomu, aby sa stal plnohodnotnou aplikačnou platformou. Jeho prítomnosť je presvedčivá, pretože k jadru WordPress pridáva štandardné REST API.

Projekt prvýkrát nahrali na GitHub pre vývojárov v roku 2013 vývojármi Ryan McCue a Rachel Baker. Nezávislý doplnok REST API bol zabudovaný do jadra WordPress v decembri 2015 po tom, čo získal obrovskú podporu a prilákal takmer 100 prispievateľov ochotných pracovať na zlepšovaní jeho možností.

Odkedy sa WordPress REST API stalo súčasťou jadra, preukázalo svoju účinnosť. Tu je len niekoľko reálnych príkladov pre prehľadnosť aplikácie a inšpiráciu vo vašich projektoch:

  1. Event Espresso používa REST API na poskytnutie prístupu vývojárom k ich globálnej infraštruktúre, čo im umožňuje vyvíjať aplikácie pomocou ich služieb.
  2. Simmer umožňuje vývojárom prístup k API s cieľom rozšíriť ich funkčnosť na plnohodnotnú mobilná aplikácia alebo prispôsobenie tém.
  3. JoinIn poskytuje svoj vlastný „vložiteľný“ widget pomocou REST API, ktorý ho naplní relevantnými údajmi, kdekoľvek sa zobrazia.

Toto je len špička ľadovca, pokiaľ ide o inovatívne účely REST API. Poďme si však povedať, ako funguje samotné REST API.

Ako funguje WordPress REST API

Stručne povedané, REST API funguje tak, že manipuluje s textovými údajmi z jedného miesta na druhé bez priameho prístupu k databáze alebo používateľskému rozhraniu. Existuje mnoho typov API (Application Programming Interfaces), napriek tomu zostáva REST moderným a relevantným štandardom.

Rozhranie REST API sa prenáša cez prístupové body protokolu HTTP (Hyper Text Transfer Protocol) pomocou formátu JavaScript Object Notation (JSON). Jednoducho povedané, tieto technológie poskytujú prístup k API pomocou jedinečných webových adries na poskytovanie údajov, ktoré sa správajú ako objekty JavaScriptu.

Ak ste nikdy nepracovali s JavaScriptom alebo jeho definíciami objektov, naučte sa základy JSON. Teraz, keď sme si trochu ujasnili koncept REST API, poďme sa rozprávať o tom, ako môže mať veľký vplyv na proces vývoja pomocou WordPress.

Čo znamená WordPress REST API pre vývojárov?

WordPress REST API je univerzálny integrátor akejkoľvek inštalácie WordPress s akoukoľvek aplikáciou na webovom serveri alebo vašej operačný systém. V konečnom dôsledku to znamená, že jediný limit toho, s čím sa dá stavať pomocou WordPress, je len naša predstavivosť. Môžete vytvoriť ľubovoľnú aplikáciu napísanú v akejkoľvek platforme alebo jazyku a použiť WordPress na spracovanie údajov cez REST API. Otvorená a priateľská komunita WordPress ponúka obrovské príležitosti.

REST API je založené na JavaScripte, ktorému sa venuje čoraz väčšia pozornosť, čo naznačuje, ktoré programovacie jazyky je dôležité poznať. Čoskoro zistíte, že JavaScript na strane servera je nový PHP. To už možno vidieť v novom softvéri WordPress.com Calypso, ktorý beží výhradne na JavaScripte a REST API.

Vďaka štandardizácii spôsobu, akým aplikácie (vrátane jadra WordPress) interagujú s údajmi WordPress, bude vývoj WordPress jednoduchší a intuitívnejší. Okrem toho uľahčí integráciu s platformami tretích strán.

Dúfam, že teraz máte viac dôvodov, prečo je dôležité začať sa učiť používať túto technológiu už teraz. Je čas urobiť prvé kroky k používaniu REST API vo vašej vlastnej práci!

5 krokov, ako začať s WordPress REST API

Ako sme už uviedli, REST API možno použiť s akoukoľvek aplikáciou alebo akýmkoľvek programovacím jazykom, ktorý môže volať zdroje HTTP. Zameriame sa na používanie príkazového riadka na zadávanie požiadaviek REST API, pretože je to najjednoduchšia metóda s najmenšou pravdepodobnosťou zavedenia chýb, ktoré môžu zhoršiť proces učenia.

Ak to chcete urobiť, musíte vo svojom počítači otvoriť program s rozhraním príkazového riadka (Command Line Interface CLI) - terminál v systéme MacOS alebo Linux a príkazový riadok v systéme Windows. CLI vám umožňuje priamu interakciu s REST API bez potreby písať ďalšie skripty na vyžiadanie a spracovanie informácií. Akákoľvek požiadavka, ktorú napíšete do CLI, môže byť skript v PHP, JavaScripte alebo inom jazyku, ale spôsob bude pre každý iný. Priame vykonávanie príkazov v CLI. Stačí zadať požadovaný príkaz a stlačiť Enter.

Odporúčame vám tiež nastaviť demo stránku alebo testovať lokálne, než skúšať tieto kroky na živej stránke. A nakoniec ešte jedna podmienka je, že verzia WordPress vašej stránky je 4.4 alebo vyššia. Ak ste pripravení, začnime!

Krok 1: Spoznajte základné koncepty REST API

Skôr než začneme, oboznámme sa s kľúčovými konceptmi REST API. Existuje len päť základných pojmov a pojmov, s ktorými by ste sa mali zoznámiť. Pozrime sa na ne:

  1. Trasy ('Cesty') a Zdroje alebo prístupové body ('Koncové body'). Toto je najdôležitejší aspekt pri pochopení REST API. Trasy vám pomáhajú pri navigácii medzi vašimi zdrojmi, keď je ku konkrétnej trase pripojená špecifická metóda HTTP (napríklad statická množina údajov alebo akcia). Napríklad /wp-json/ je trasa nakonfigurovaná ako zdroj vytvorený na zobrazenie dostupných trás.
  2. Žiadosti. Vznikajú spustením správnych zdrojov a prechodom údajov.
  3. odpoveď ( Odpovede). Stručne povedané, poskytnutie požadovaných údajov alebo vrátenie chyby, aby ste vedeli, že sa niečo pokazilo.
  4. Schémy. Nižšie sú uvedené šablóny odpovedí, aby ste vždy presne vedeli, kde hľadať údaje, ktoré potrebujete.
  5. Triedy ovládačov. Umožňujú vám vytvárať si vlastné trasy a zdroje. Pokiaľ sa o to nebudete musieť starať, neskôr sa stanú užitočnejšími.

Keď pochopíte týchto päť pojmov, môžete sa začať ponoriť hlbšie do samotného REST API, počnúc jeho prístupovými bodmi.

Krok 2: Zistite najužitočnejšie prístupové body REST API

WordPress REST API ponúka referenčnú príručku so všetkými prístupovými bodmi (zdrojmi), kde nájdete tie, ktoré sú pre vás najužitočnejšie. Najprv musíte vedieť, ako vytvoriť volanie HTTP REST API. Základná časť akéhokoľvek volania WordPress API vyzerá takto, nahraďte vasa domena.com k tvojmu:

Http://yourdomain.com/wp-json/

Pripojenie môžete otestovať spustením príkazu curl vo vašom CLI pomocou vlastnej adresy URL:

Curl -X OPTIONS -i http://yourdomain.com/wp-json/

Mali by ste byť privítaní správou od HTTP. Tento príkaz môžete ďalej upraviť pomocou niektorých hlavných zdrojov. Teraz používame iba verziu GET curl.

Ak chcete získať zoznam JSON vašich príspevkov vo WordPress, môžete použiť nasledovné:

Po tomto skúste skontrolovať všetky existujúce stránky WordPress takto:

Curl -X GET -i http://yourdomain.com/wp-json/wp/v2/pages

Môžete experimentovať s každým z týchto prístupových bodov (a ďalšími!) v CLI, aby ste videli, akú odozvu každý z nich produkuje.

Krok 3: Naučte sa základy REST API Authentication

Teraz je čas dozvedieť sa viac o autentifikácii. Niektoré akcie a údaje v REST API sú verejné, zatiaľ čo iné vyžadujú, aby ste sa prihlásili ako správca. Toto je však REST API a nie je sa kam prihlásiť na autorizáciu. Namiesto toho sa môžete overiť počas žiadostí, ktoré vyžadujú prístup správcu, ako je prezeranie nezverejnených príspevkov alebo zmena príspevkov.

Začnime inštaláciou doplnku WordPress REST API Basic Auth. Toto je jednoduchý doplnok pre vývojárov, aby sa rýchlo naučili REST API, a nie je určený pre skutočné webové stránky. Proces inštalácie je však rovnaký ako pri akomkoľvek inom plugine.

Po nainštalovaní Basic Auth sa budete môcť autentifikovať cez CLI s príznakom užívateľ. Tu je príklad, ako použiť metódu overenia používateľa zvlniť ak chcete zobraziť nezverejnené príspevky:

Curl -X GET --user username:password -i http://yourdomain.com/wp-json/wp/v2/posts?status=draft

Overenie totožnosti sa bude vyžadovať pre všetky operácie okrem prezerania verejných informácií. Keď si osvojíte základnú autentifikáciu, môžete preskúmať ďalšie možnosti odporúčané dokumentáciou REST API pre váš vývoj.

Krok 4: Vyberte svoj prvý príspevok WordPress pomocou rozhrania REST API

Keď pochopíte, ako vykonávať základné volania REST API pomocou curl, skúste vybrať konkrétnu položku. Najprv zobrazme všetky publikácie, ako sme to urobili predtým:

Curl -X GET -i http://yourdomain.com/wp-json/wp/v2/posts

Tento trik s dodatkom ID môžete použiť pre akýkoľvek zdroj REST API, či už chcete zobraziť príspevok, stránku alebo taxonómiu.

Krok 5: Vykonávanie zmien vo svojom príspevku WordPress prostredníctvom rozhrania REST API

Nakoniec sa pokúsme vykonať zmeny vo vybratej publikácii. Namiesto príkazov MOŽNOSŤ alebo GET, tentoraz použijeme POST vykonať zmeny. GET sa používa na čítanie údajov pri POST- poslať ich.

Odoslaním žiadosti premenujeme váš príspevok POST spolu s autentifikačnými údajmi. Nové zmeny sa vykonajú pomocou vlajky d na konci príkazu. Odovzdáme používateľovi objekt JavaScript nastavením premennej title na jej hodnotu, ako napr Môj nový názov ako je uvedené v kóde nižšie:

Curl -X POST --user username:password http://yourdomain.com/wp-json/wp/v2/posts/ -d "("title":"Môj nový názov")"

Uistite sa, že ste nahradili používateľské meno, heslo, ID príspevku a názov vlastným. Danú publikáciu môžete znova vybrať a skontrolovať zmeny:

Curl -X GET -i http://yourdomain.com/wp-json/wp/v2/posts/

Gratulujem! Práve ste vykonali prvé administrátorské úpravy pomocou WordPress REST API. Samozrejme, že tento základný sprievodca len poškriabe povrch možností poskytovaných REST API, ale je to celkom solídny začiatok!

Záver

WordPress REST API je výkonná nová verzia jadra WordPress a mnoho vývojárov už začalo využívať jeho možnosti. V súlade s tým sa teraz zoznámili s tým, ako pracovať s nová príležitosť, zlepšíte svoje programátorské zručnosti a budete vedieť vytvoriť aplikáciu pomocou WordPress ako frameworku.

Aby sme to zhrnuli, prešli sme piatimi krokmi na našej ceste k učeniu interakcie s WordPress REST API:

  1. Úvod do základných konceptov REST API.
  2. Najužitočnejšie zdroje/prístupové body REST API.
  3. Naučte sa základy autentifikácie REST API.
  4. Načítanie príspevku na WordPress pomocou REST API.
  5. Upravte príspevok WordPress pomocou rozhrania REST API.

Aké otázky máte o WordPress REST API? Napíšte nám do komentárov!