MediaWiki API on hästi dokumenteeritud arendustööriistade komplekt, mis suudab ühe skriptiga teha enamiku ülesandeid. API -d kasutatakse tavaliselt wikis kasutatavate automatiseeritud tööriistade väljatöötamiseks. MediaWiki API -d saavad hõlpsasti kasutada enamus keeled, eriti PHP (curl -funktsioonid), aga ka Perl ja mõned teised.
Sammud
Samm 1. Lugege MediaWiki API dokumentatsiooni
See asub aadressil "api.php" samas kataloogis kui tavaline index.php. Näide:
Samm 2. Valige väljundvorming
MediaWiki pakub andmete väljastamist JSON, JSONFM, PHP (serialiseeritud vorming), PHPFM, WDDX, WDDXFM, XML, XMLFM, YAML, YAMLFM ja RAWFM kujul. Sufiksiga "FM" vormingud on HTML-vormingus ilusad.
Samm 3. Valige toiming
MediaWiki API toetab järgmisi toiminguid.
- abi - vaadake abiekraani
- login - logige sisse MediaWiki
- opensearch - rakendage opensearchi protokolli. (Mitte kõigil MediaWiki installidel pole seda).
- feedwatchlist - jälgimisloendi voo tagastamine.
- päring - sellel on palju võimalusi. Vaadake nende kohta MediaWiki API dokumentatsiooni.
Samm 4. Valige päring või loend
Lisaks tavapärastele toimingutele toetab MediaWiki erinevaid päringuid ja loendeid, näiteks loendilehti, mis sisaldavad linki teisele artiklile, hiljutiste muudatuste arvu erinevusi, kaastöid jne.
Samm 5. Edastage postitatud andmed API -le, kasutades CURL -i või mõnda muud tööriista, mis võimaldab skripti jaoks kasutada POST -meetodit
GET -meetod võib samuti toimida.
Samm 6. Veenduge, et küpsised oleksid rakendusele saadetud (mõned skriptid/rakendused võivad soovida selle alamkausta salvestada
Samm 7. Kui suhtlete MediaWiki kasutajaliidesega, pidage meeles, et enamikul redigeerimislehtedel on teie muutmisluba
Redigeerimismärki kasutatakse muutmise kokkupõrgete määramiseks ja teise juba tehtud muudatuse alistamise vältimiseks (seda kasutatakse ka tagasipööramisel.) Pidage meeles, et kui te tegutsete wiki kasutajaliidesega, on asjad kergemini viltu. Pöörake tähelepanu kõikidele regulaaravaldistele, mida kasutate, veendumaks, et need annavad ainult soovitud tulemuse.
Samm 8. Lugege wiki saadetud tulemusi
Tulemused saadetakse teile HTTP -vastusena, mida saavad lugeda paljud parserid. Hoolitse valitud vormingu eest eriti. Veenduge, et kasutate selle vormingu jaoks sobivat parserit. Tavaliselt on hea tava vorming selgesõnaliselt MediaWikile teatada, isegi kui sellel on vaikevorming, mida soovite kasutada.
Näpunäiteid
- Enne API kasutamist veenduge, et kohalik viki toetaks skripti.
- MediaWiki kohta leiate lisateavet selle API abil.
