MediaWiki API je dobro dokumentiran nabor razvojnih orodij, ki lahko opravijo večino nalog v enem skriptu. API se običajno uporablja za razvoj avtomatiziranih orodij za uporabo na wikiju. API MediaWiki lahko preprosto uporablja večina jezikov, zlasti PHP (funkcije curl), Perl in še nekateri drugi.
Koraki
Korak 1. Preberite dokumentacijo za MediaWiki API
Nahaja se na naslovu 'api.php' v istem imeniku kot običajni index.php. Primer:
Korak 2. Izberite izhodno obliko
MediaWiki ponuja izpis podatkov v obliki JSON, JSONFM, PHP (zaporedna oblika), PHPFM, WDDX, WDDXFM, XML, XMLFM, YAML, YAMLFM in RAWFM. Oblike s pripono »FM« so precej natisnjene v HTML-ju.
Korak 3. Izberite dejanje
API MediaWiki podpira naslednja dejanja:
- help - Oglejte si zaslon za pomoč
- prijava - Prijava v MediaWiki
- opensearch - Implementirajte protokol opensearch. (Tega nimajo vse instalacije MediaWiki).
- feedwatchlist - Vrnite vir seznama za spremljanje.
- poizvedba - ima različne možnosti. Oglejte si dokumentacijo za MediaWiki API.
Korak 4. Izberite poizvedbo ali seznam
Poleg standardnih dejanj MediaWiki podpira različne poizvedbe in sezname, na primer strani s seznami, ki vsebujejo povezavo do drugega članka, število nedavnih sprememb, prispevkov itd.
Korak 5. Posredovane podatke posredujte API -ju z uporabo CURL ali drugega orodja, ki vam omogoča uporabo metode POST v skriptu
Metoda GET lahko deluje tudi.
Korak 6. Poskrbite, da bodo piškotki poslani v aplikacijo (Nekateri skripti/aplikacije jih bodo morda želeli shraniti v podmapo
Korak 7. Pri interakciji z uporabniškim vmesnikom MediaWiki pazite, da vaš žeton za urejanje ostane na večini strani za urejanje
Žeton za urejanje se uporablja za določanje kolizij urejanja in izogibanje preglasitvi drugega že opravljenega urejanja (to se uporablja tudi pri vračanju.). Ne pozabite, da je lažje, če delate z uporabniškim vmesnikom wikija. Bodite pozorni na vse regularne izraze, ki jih uporabljate, da zagotovite, da bodo dosegli le predvideni rezultat.
Korak 8. Preberite rezultate, ki jih je poslala wiki
Rezultati vam bodo poslani v odgovoru HTTP, ki ga lahko preberejo številni razčlenjevalci. Bodite še posebej pozorni na obliko, ki jo izberete. Za to obliko uporabite ustrezen razčlenjevalnik. Običajno je dobra praksa, da izrecno navedete obliko v MediaWiki, tudi če ima privzeto obliko, ki jo želite uporabiti.
Nasveti
- Pred uporabo API -ja se prepričajte, da vaš lokalni wiki podpira skript.
- Več o MediaWikiju lahko najdete z njegovim API -jem.
