„MediaWiki“API yra gerai dokumentuotas kūrimo įrankių rinkinys, galintis atlikti daugumą užduočių vienu scenarijumi. API paprastai naudojama kuriant automatinius įrankius, skirtus naudoti wiki. „MediaWiki“API gali lengvai naudotis dauguma kalbų, ypač PHP („Curl“funkcijos), taip pat „Perl“ir kelios kitos.
Žingsniai
1 žingsnis. Perskaitykite „MediaWiki“API dokumentaciją
Jis yra „api.php“tame pačiame kataloge kaip ir įprastas index.php. Pavyzdys:
Žingsnis 2. Pasirinkite išvesties formatą
„MediaWiki“siūlo duomenų išvestį JSON, JSONFM, PHP (serijinis formatas), PHPFM, WDDX, WDDXFM, XML, XMLFM, YAML, YAMLFM ir RAWFM. Formatai, pažymėti „FM“, yra gana atspausdinti HTML.
Žingsnis 3. Pasirinkite veiksmą
„MediaWiki“API palaiko šiuos veiksmus:
- pagalba - žr. pagalbos ekraną
- login - Prisijunkite prie „MediaWiki“
- opensearch - Įdiekite „opensearch“protokolą. (Ne visuose „MediaWiki“įrenginiuose tai yra).
- feedwatchlist - grąžina stebėjimo sąrašo kanalą.
- užklausa - turi įvairių variantų. Žiūrėkite „MediaWiki“API dokumentaciją.
Žingsnis 4. Pasirinkite užklausą arba sąrašą
Be standartinių veiksmų, „MediaWiki“palaiko įvairias užklausas ir sąrašus, pvz., Sąrašų puslapius, kuriuose yra nuoroda į kitą straipsnį, naujausių pakeitimų skaičių, skirtumus ir pan.
Žingsnis 5. Perduokite paskelbtus duomenis API naudodami CURL arba kitą įrankį, kuris leidžia scenarijui naudoti POST metodą
GET metodas taip pat gali veikti.
Žingsnis 6. Įsitikinkite, kad slapukai siunčiami į programą (kai kurie scenarijai/programos gali norėti juos išsaugoti poaplanke
Žingsnis 7. Sąveikaudami su „MediaWiki“vartotojo sąsaja, nepamirškite savo redagavimo žetono, esančio daugumoje redagavimo puslapių
Redagavimo prieigos raktas naudojamas nustatant redagavimo susidūrimus ir išvengiant kito jau atlikto redagavimo (jis taip pat naudojamas atšaukiant.). Atminkite, kad viskas gali būti nesėkminga, jei naudojate „wiki“vartotojo sąsają. Atminkite bet kokius naudojamus reguliarius veiksnius, kad įsitikintumėte, jog jie duos tik numatytą rezultatą.
Žingsnis 8. Perskaitykite wiki atsiųstus rezultatus
Rezultatai bus išsiųsti jums kaip HTTP atsakymas, kurį gali perskaityti daugelis analizatorių. Ypač rūpinkitės pasirinktu formatu. Įsitikinkite, kad naudojate tam formatui tinkamą analizatorių. Paprastai gera praktika yra aiškiai nurodyti formatą „MediaWiki“, net jei jis turi numatytąjį formatą, kurį norite naudoti.
Patarimai
- Prieš naudodami API, įsitikinkite, kad vietinis „wiki“palaiko scenarijų.
- Daugiau apie „MediaWiki“galite rasti naudodami jos API.
