A MediaWiki API jól dokumentált fejlesztőeszköz-készlet, amely a feladatok többségét egy szkriptben képes elvégezni. Az API -t általában a wikiben használt automatizált eszközök fejlesztésére használják. A MediaWiki API -t a legtöbb nyelv könnyen használhatja, különösen a PHP (A curl funkciók), valamint a Perl és néhány más.
Lépések
1. lépés. Olvassa el a MediaWiki API dokumentációját
Az "api.php" címen található, ugyanabban a könyvtárban, mint a szokásos index.php. Példa:
2. lépés. Válassza ki a kimeneti formátumot
A MediaWiki adatkimenetet kínál JSON, JSONFM, PHP (sorosított formátum), PHPFM, WDDX, WDDXFM, XML, XMLFM, YAML, YAMLFM és RAWFM formában. Az "FM" toldalékkal ellátott formátumok szép nyomtatásúak HTML-ben.
3. lépés. Válasszon egy műveletet
A MediaWiki API a következő műveleteket támogatja:
- help - Lásd a súgó képernyőt
- bejelentkezés - Jelentkezzen be a MediaWiki -be
- opensearch - Az opensearch protokoll végrehajtása. (Nem minden MediaWiki telepítés rendelkezik ezzel).
- feedwatchlist - Visszaad egy figyelőlista feedet.
- lekérdezés - Számos lehetőség közül választhat. Lásd a MediaWiki API dokumentációját.
4. lépés. Válasszon lekérdezést vagy listát
A szokásos műveleteken kívül a MediaWiki különböző lekérdezéseket és listákat is támogat, például olyan oldalakat, amelyek egy másik cikkre mutató linket tartalmaznak, a legutóbbi módosítások számát, hozzájárulásokat stb.
5. lépés: A CURL vagy más olyan eszköz segítségével továbbítsa a közzétett adatokat az API -nak, amely lehetővé teszi a POST módszer használatát a szkriptben
A GET módszer is működhet.
6. lépés: Ügyeljen arra, hogy a cookie -kat elküldje egy alkalmazásnak (egyes szkriptek/alkalmazások esetleg almappában akarják tárolni
7. lépés: Amikor a MediaWiki felhasználói felületével lép kapcsolatba, vegye figyelembe a legtöbb szerkesztési oldalon megtartott szerkesztési jogkivonatot
A szerkesztési jogkivonatot a szerkesztési ütközések meghatározására és a már elvégzett szerkesztések felülbírálásának elkerülésére használják (Ezt a visszaállításnál is használják.) Ne feledje, hogy a dolgok könnyebben elromolhatnak, ha a wiki felhasználói felületével cselekszik. Ügyeljen a használt regexekre, hogy megbizonyosodjon arról, hogy csak a kívánt eredményt hozza.
8. lépés. Olvassa el a wiki által küldött eredményeket
Az eredményeket HTTP válaszban küldjük el Önnek, amelyet sok elemző olvashat. Különösen ügyeljen a választott formátumra. Győződjön meg arról, hogy az adott formátumnak megfelelő elemzőt használja. Általában jó gyakorlat, ha kifejezetten megadja a formátumot a MediaWiki -nek, még akkor is, ha az alapértelmezett formátumot szeretné használni.
Tippek
- Az API használata előtt győződjön meg arról, hogy a helyi wiki támogatja a szkriptet.
- A MediaWikiről többet megtudhat az API használatával.
