MediaWiki API dobro je dokumentiran skup razvojnih alata koji mogu obaviti većinu zadataka u jednoj skripti. API se obično koristi za razvoj automatiziranih alata za upotrebu na wikiju. MediaWiki API može se lako koristiti u većini jezika, osobito u PHP -u (funkcije curl), kao i u Perlu i nekoliko drugih.
Koraci
Korak 1. Pročitajte dokumentaciju za MediaWiki API
Nalazi se na 'api.php' u istom direktoriju kao i uobičajeni index.php. Primjer:
Korak 2. Odaberite format izlaza
MediaWiki nudi izlaz podataka u obliku JSON, JSONFM, PHP (serijski format), PHPFM, WDDX, WDDXFM, XML, XMLFM, YAML, YAMLFM i RAWFM. Formati sa sufiksom "FM" prilično su ispisani u HTML-u.
Korak 3. Odaberite radnju
MediaWiki API podržava sljedeće radnje:
- pomoć - pogledajte zaslon za pomoć
- prijava - Prijavite se na MediaWiki
- opensearch - Implementirajte protokol opensearch. (Nemaju sve instalacije MediaWikija ovo).
- feedwatchlist - Vraća feed popisa za gledanje.
- upit - ima razne mogućnosti. Za njih pogledajte dokumentaciju za MediaWiki API.
Korak 4. Odaberite upit ili popis
Osim standardnih radnji, MediaWiki podržava različite upite i popise, kao što su stranice s popisom koje sadrže vezu do drugog članka, broj nedavnih izmjena, doprinosa itd.
Korak 5. Prenesite objavljene podatke API -ju pomoću CURL -a ili drugog alata koji vam omogućuje korištenje POST metode skripti
GET metoda također može djelovati.
Korak 6. Pazite da kolačići budu poslani aplikaciji (Neke skripte/aplikacije mogu ih htjeti pohraniti u podmapu
Korak 7. Prilikom interakcije s korisničkim sučeljem MediaWikija, vodite računa o tokenu za uređivanje koji se nalazi na većini stranica za uređivanje
Token za uređivanje koristi se za utvrđivanje sukoba uređivanja i izbjegavanje poništavanja drugog već uređenog uređivanja (Ovo se koristi i pri vraćanju.). Imajte na umu da je lakše krenuti naopako ako radite s korisničkim sučeljem wikija. Imajte na umu sve regularne izraze koje koristite kako biste bili sigurni da će postići samo željeni rezultat.
Korak 8. Pročitajte rezultate koje je poslala wiki
Rezultati će vam biti poslani u HTTP odgovoru koji mogu pročitati mnogi raščlanjivači. Posebno pazite na format koji odaberete. Upotrijebite odgovarajući raščlanjivač za taj format. Obično je dobra praksa izričito navesti format u MediaWikiju čak i ako ima zadani format koji želite koristiti.
Savjeti
- Prije korištenja API -ja provjerite imate li lokalnu wiki podršku za skriptu.
- Više o MediaWikiju možete pronaći pomoću njegovog API -ja.
