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, posebno 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:
- help - Pogledajte ekran za pomoć
- prijava - Prijavite se na MediaWiki
- opensearch - Implementirajte opensearch protokol. (Nemaju sve instalacije MediaWiki ovo).
- feedwatchlist - Vraća feed sa liste za praćenje.
- upit - ima razne opcije. Za njih pogledajte dokumentaciju za MediaWiki API.
Korak 4. Odaberite upit ili listu
Osim standardnih radnji, MediaWiki podržava različite upite i liste, poput stranica sa spiskom koje sadrže vezu do drugog članka, broj nedavnih izmjena, doprinose itd.
Korak 5. Prenesite objavljene podatke API -ju upotrebom CURL -a ili nekog drugog alata koji vam omogućava da koristite POST metodu za skriptu
GET metoda također može funkcionirati.
Korak 6. Obavezno zadržite kolačiće poslane aplikaciji (Neke skripte/aplikacije mogu ih htjeti pohraniti u podmapu
Korak 7. Prilikom interakcije s korisničkim sučeljem MediaWiki, imajte na umu da se vaš token za uređivanje čuva na većini stranica za uređivanje
Token za uređivanje se koristi za određ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 čitati mnogi raščlanjivači. Posebno vodite računa o formatu koji odaberete. Uvjerite se da koristite odgovarajući parser za taj format. Obično je dobra praksa izričito navesti format na MediaWiki č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.
