MediaWiki API je dobre zdokumentovaná sada vývojových nástrojov, ktoré môžu vykonávať väčšinu úloh v jednom skripte. API sa zvyčajne používa na vývoj automatizovaných nástrojov na použitie vo wiki. Rozhranie API MediaWiki môže ľahko používať väčšina jazykov, najmä PHP (funkcie zvlnenia), Perl a niekoľko ďalších..
Kroky
Krok 1. Prečítajte si dokumentáciu API MediaWiki
Nachádza sa na adrese „api.php“v rovnakom adresári ako obvyklý index.php. Príklad:
Krok 2. Vyberte výstupný formát
MediaWiki ponúka dátový výstup vo forme JSON, JSONFM, PHP (serializovaný formát), PHPFM, WDDX, WDDXFM, XML, XMLFM, YAML, YAMLFM a RAWFM. Formáty s príponou „FM“sa dajú vytlačiť v HTML.
Krok 3. Vyberte akciu
MediaWiki API podporuje nasledujúce akcie:
- pomoc - pozrite si obrazovku pomocníka
- prihlásenie - Prihláste sa do MediaWiki
- opensearch - Implementujte protokol opensearch. (Nie všetky inštalácie MediaWiki to majú).
- feedwatchlist - vráti informačný kanál sledovaného zoznamu.
- dotaz - má množstvo možností. Pozrite si ich dokumentáciu k API MediaWiki.
Krok 4. Vyberte dotaz alebo zoznam
Okrem štandardných akcií MediaWiki podporuje rôzne dotazy a zoznamy, ako sú stránky so zoznamom, ktoré obsahujú odkaz na iný článok, rozdiely v posledných zmenách, príspevky atď.
Krok 5. Odošlite zverejnené údaje do rozhrania API pomocou CURL alebo iného nástroja, ktorý vám umožní použiť metódu POST na skript
Fungovať môže aj metóda GET.
Krok 6. Uistite sa, že súbory cookie budú odoslané do aplikácie (niektoré skripty/aplikácie ich môžu chcieť uložiť do podpriečinka
Krok 7. Pri interakcii s používateľským rozhraním MediaWiki pamätajte na svoj token úprav uložený na väčšine stránok úprav
Úpravný token sa používa na určenie kolízií úprav a zabránenie prepísaniu ďalšej už vykonanej úpravy (používa sa aj pri vrátení.) Majte na pamäti, že veci sa môžu pokaziť, ak konáte pomocou používateľského rozhrania wiki. Nezabudnite na všetky regexy, ktoré použijete, aby ste sa uistili, že prinesú iba zamýšľaný výsledok.
Krok 8. Prečítajte si výsledky zaslané wiki
Výsledky vám budú odoslané v odpovedi HTTP, ktorú môže prečítať veľa analyzátorov. Dávajte si obzvlášť pozor na formát, ktorý si vyberiete. Uistite sa, že používate príslušný analyzátor pre daný formát. Obvykle je dobrým zvykom explicitne uviesť formát MediaWiki, aj keď má predvolený formát, ktorý chcete použiť.
Tipy
- Pred použitím rozhrania API sa presvedčte, či skript podporuje vaša miestna wiki.
- Ďalšie informácie o MediaWiki nájdete pomocou jeho API.
