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
 * - get list of pages matching a certain criterion
 * - get meta information about the wiki and user

Finally, include the  parameter, which tells the API in which format to get the results. The recommended format is JSON. The API has supported other output formats in the past, but they are not generally recommended.

A simple query
Let’s take an example of a simple query to understand what a typical GET request and response would look like in the context of the Action API.

Let's search for a title in a wiki. We will use the  module documented on.

GET request
To search for page titles or content matching, the URL for the HTTP GET request would be: Explanation of each part of the URL:


 * is the main endpoint. In this case it is English Wikipedia.
 * means fetch data from wiki.
 * means get list of pages matching a criteria.
 * indicates the page title or content to search for. The  indicates a space character in a URL.
 * indicates JSON output, which is the recommended output format.

Response
The response is a JSON format document with a list of pages titles that match Craig Noone:

Examples of projects using Action API
Some example of projects in Wikimedia that use Action API:


 * Wikipedia iOS App, in which one of the features is to search for wiki pages near your location.
 * 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