API:Tutorial/lt

Šiame vadove sužinosite apie MediaWiki Action API, kaip ją naudoti, užklausos formatą, paprastą užklausą ir projektų, naudojančių Action API, pavyzdžius.

[https://apps-gallery.toolforge.org/ Naršykite demonstracines programas „Toolforge“. ]



MediaWiki Action API apžvalga
MediaWiki Action API yra REST pilna žiniatinklio paslauga, leidžianti vartotojams atlikti tam tikrus wiki veiksmus, pvz. puslapio kūrimas, autentifikavimas, analizavimas, paieška ir kt. 1 USD yra geras atskaitos taškas norint suprasti API.

Jūsų programa siunčia užklausas API, kad gautų prieigą prie wiki funkcijų. Pavyzdžiui, prisijunkite prie wiki, kurkite ir redaguokite puslapį, ieškokite pavadinimo, ieškokite turinio teksto arba analizuokite turinį. Action API galima naudoti trečiųjų šalių kūrėjams, Wikimedia plėtinių kūrėjams ir wiki svetainių administratoriams.

Dešinėje šio puslapio šoninėje juostoje yra daug funkcijų, kurias palaiko API, sugrupuotų pagal kategorijas. Prieš siųsdami užklausas į wiki serverį, pirmiausia perskaitykite apžvalgos puslapius, tokius kaip duomenų formatai, klaidos ir įspėjimai ir Action API DUK.



Kaip naudotis MediaWiki Action API
Galite prašyti duomenų iš kliento pusės į serverį per HTTP ir gauti atsakymą standartiniu formatu (paprastai JSON). Užklausą sudaro galutinis taškas ir parametrų rinkinys. Galima pateikti dviejų tipų užklausas: GET ir POST. GET užklausos parametre URL būtų užklausos eilutė. Jei norite gauti POST užklausą, suformatuokite parametrus JSON formatu.



Užklausos formatas
Visi „Wikimedia Wiki“ turi galutinius taškus tokiu formatu  Norėdami prisijungti prie MediaWiki arba anglų kalbos Vikipedijos, naudokite susijusį galinį tašką. Pavyzdžiui, anglų Vikipedija kainuoja 2 USD Norėdami išbandyti naujas paskyras arba išbandyti puslapių redagavimus, naudokite bandomąjį wiki galutinį tašką

URL užklausos eilutėje pridėkite parametrą. Jis nurodo API, kurį veiksmą atlikti. Populiariausias veiksmas yra  (URL būtų ), kuris leidžia gauti duomenis iš wiki. Po  parametro pridėkite kitą parametrą, nurodydami, kurį iš trijų užklausos modulių tipų norite atlikti:


 * - gauti puslapių savybes
 * - gauti tam tikrą kriterijų atitinkančių puslapių sąrašą
 * - gauti meta informaciją apie wiki ir naudotoją

Galiausiai įtraukite parametrą, kuris nurodo API, kokiu formatu gauti rezultatus. Rekomenduojamas formatas yra JSON. API anksčiau palaikė kitus išvesties formatus, tačiau jie paprastai nerekomenduojami.



Paprasta užklausa
Paimkime paprastos užklausos pavyzdį, kad suprastume, kaip atrodytų tipiška GET užklausa ir atsakymas Veiksmo API kontekste.

Ieškokime pavadinimo wiki. Mes naudosime  modulį, dokumentuotą.



GAUTI užklausą
Norint ieškoti puslapių pavadinimų ar turinio, atitinkančio, HTTP GET užklausos URL būtų toks:Kiekvienos URL dalies paaiškinimas:


 * 1 USD yra pagrindinis galutinis taškas. Šiuo atveju tai yra angliška Vikipedija.
 * reiškia gauti duomenis iš wiki.
 * reiškia gauti kriterijus atitinkančių puslapių sąrašą.
 * nurodo puslapio pavadinimą arba turinį, kurio reikia ieškoti.  nurodo tarpo simbolį URL.
 * nurodo JSON išvestį, kuris yra rekomenduojamas išvesties formatas.

Atsakymas
Atsakymas yra JSON formato dokumentas su puslapių pavadinimų sąrašu, atitinkančiu „Craig Noone“:



Projektų, naudojančių Action API
, pavyzdžiai

Kai kurie „Wikimedia“ projektų, kuriuose naudojama „Action“ API, pavyzdžiai:


 * Wikipedia iOS App, kurioje viena iš funkcijų yra ieškoti wiki puslapių netoli jūsų vietos.
 * Botai, kurie veikia wiki. Pywikibot yra „Python“ parašyta roboto sistema, susieta su „MediaWiki“ API, kurią naudoja daugelis robotų kūrėjų.
 * API naudojimas vizualizuojant duomenis, gautus iš wiki. Pavyzdžiui, ši [$ 1 tvarkinga vizualizacija], kurioje rodomi Vikipedijoje atlikti pakeitimai realiuoju laiku.

Additional notes

 * Kelios svetainės naudoja MediaWiki. Jie visi gali naudoti skirtingą MediaWiki versiją ir savo ruožtu API. Kai kurie modulio parametrai, palaikomi vienoje versijoje, gali būti nebenaudojami arba pašalinti kitose. Apie tai galite sužinoti kiekvieno modulio dokumentacijoje, naudodami API pagalbos modulį.
 * Jei norite atlikti daug API skambučių ir galbūt paleisti labai užimtus ir aktyvius robotus, iš anksto pasikalbėkite su wiki administratoriais, kad jie jūsų neužblokuotų. Žr. Wikimedia projektų administratorių sąrašą. Skaitykite daugiau apie šią temą.
 * Visiems duomenų keitimo veiksmams, pvz., registravimui, redagavimui ar puslapio perkėlimui ir pakeitimų stebėjimui ar patruliavimui, reikės prieigos raktų. Norėdami tęsti, turėsite gauti žetonus per.

Resursai

 * Eksperimentuokite su Action API naudodami Special:APISandbox. Galite žaisti su palaikomais veiksmais, nurodyti parametrų vertę ir siųsti užklausas API, kad pamatytumėte rezultatus tame pačiame puslapyje.
 * Wikimedia dumps, kad galėtumėte dirbti su jais vietoje.
 * Perskaitykite mokymo programas: Įvadas į API ir Kas yra REST – paprastas paaiškinimas pradedantiesiems.
 * MediaWiki API žinynas teikia automatiškai sugeneruotą visų palaikomų modulių API dokumentaciją.
 * pateikiama Action API apžvalga.
 * įvadas į MediaWiki API, kurį atliko User:Roan_Kattouw_(WMF) San Francisko hakatone, 2012 m.. Šis mokymo vadovas yra kartu su vaizdo įrašu.
 * GitHub: MediaWiki API demonstracinės versijos