Ang MediaWiki API ay isang maayos na dokumentadong hanay ng mga tool sa pag-unlad na maaaring gumawa ng isang karamihan ng mga gawain sa isang script. Karaniwang ginagamit ang API para sa pagbuo ng mga automated na tool para magamit sa wiki. Ang MediaWiki API ay madaling magamit ng karamihan sa mga wika, partikular ang PHP (Ang curl function) pati na rin Perl at ilang iba pa..
Mga hakbang
Hakbang 1. Basahin ang dokumentasyon ng MediaWiki API
Matatagpuan ito sa 'api.php' sa parehong direktoryo tulad ng karaniwang index.php. Halimbawa:
Hakbang 2. Pumili ng isang format ng output
Nag-aalok ang MediaWiki ng output ng data sa anyo ng JSON, JSONFM, PHP (serialized format), PHPFM, WDDX, WDDXFM, XML, XMLFM, YAML, YAMLFM, at RAWFM. Ang mga format na nilagyan ng "FM" ay medyo naka-print sa HTML.
Hakbang 3. Pumili ng isang aksyon
Sinusuportahan ng MediaWiki API ang mga sumusunod na aksyon:
- tulong - Tingnan ang screen ng tulong
- pag-login - Mag-login sa MediaWiki
- opensearch - Ipatupad ang opensearch protocol. (Hindi lahat ng mga pag-install ng MediaWiki ay mayroon nito).
- feedwatchlist - Bumalik ng isang feed ng listahan.
- query - Mayroong iba't ibang mga pagpipilian. Tingnan ang dokumentasyon ng MediaWiki API para sa kanila.
Hakbang 4. Pumili ng isang query o isang listahan
Bukod sa mga karaniwang pagkilos, sinusuportahan ng MediaWiki ang iba't ibang mga query at listahan, tulad ng listahan ng mga pahina na naglalaman ng isang link sa isa pang artikulo, bilang ng mga kamakailang pagbabago na naiiba, mga naiambag, atbp.
Hakbang 5. Ipasa ang nai-post na data sa API sa pamamagitan ng paggamit ng CURL o ibang tool na nagbibigay-daan sa iyo upang magamit ang POST na pamamaraan sa script
Maaari ding gumana ang pamamaraang GET.
Hakbang 6. Siguraduhing panatilihin ang mga cookies na ipinadala sa isang application (Maaaring hilingin ng ilang mga script / application na iimbak ito sa isang subfolder
Hakbang 7. Kapag nakikipag-ugnay sa interface ng gumagamit ng MediaWiki, isipin ang iyong token sa pag-edit na itinatago sa karamihan ng mga pahina ng pag-edit
Ginagamit ang token ng pag-edit upang matukoy ang mga banggaan sa pag-edit at maiwasan ang pag-override sa isa pang nagawa na na pag-edit (Ginagamit din ito sa rollback.) Tandaan na mas madali para sa mga bagay na magulo kung kumikilos ka gamit ang interface ng gumagamit ng wiki. Maging maingat sa anumang mga regex na ginagamit mo upang matiyak na gagawin lamang nila ang nais na resulta.
Hakbang 8. Basahin ang mga resulta na ipinadala ng wiki
Ipapadala sa iyo ang mga resulta sa isang tugon sa HTTP, na maaaring mabasa ng maraming mga parser. Ingatan ang napili mong format. Tiyaking ginagamit mo ang naaangkop na parser para sa format na iyon. Karaniwan isang mahusay na kasanayan na tahasang isulat ang format sa MediaWiki kahit na mayroon itong isang default na format na nais mong gamitin.
Mga Tip
- Tiyaking mayroon kang suporta sa iyong lokal na wiki ng script bago gamitin ang API.
- Maaari kang makahanap ng higit pa tungkol sa MediaWiki sa pamamagitan ng paggamit ng API nito.
