API-ul MediaWiki este un set bine documentat de instrumente de dezvoltare care pot realiza majoritatea sarcinilor într-un singur script. API-ul este de obicei utilizat pentru dezvoltarea instrumentelor automate pentru utilizare în wiki. API-ul MediaWiki poate fi utilizat cu ușurință de majoritatea limbilor, în special PHP (funcțiile curl), precum și Perl și câteva altele..
Pași
Pasul 1. Citiți documentația API-ului MediaWiki
Se află la „api.php” în același director ca index.php obișnuit. Exemplu:
Pasul 2. Selectați un format de ieșire
MediaWiki oferă date de ieșire sub formă de JSON, JSONFM, PHP (format serializat), PHPFM, WDDX, WDDXFM, XML, XMLFM, YAML, YAMLFM și RAWFM. Formatele cu sufixul „FM” sunt destul de tipărite în HTML.
Pasul 3. Alegeți o acțiune
API-ul MediaWiki acceptă următoarele acțiuni:
- ajutor - Consultați ecranul de ajutor
- autentificare - Autentificare la MediaWiki
- opensearch - Implementați protocolul opensearch. (Nu toate instalațiile MediaWiki au acest lucru).
- feedwatchlist - Returnează un feed de listă de urmărire.
- interogare - Are o varietate de opțiuni. Consultați documentația API MediaWiki pentru acestea.
Pasul 4. Selectați o interogare sau o listă
Pe lângă acțiunile standard, MediaWiki acceptă diferite interogări și liste, cum ar fi listarea paginilor care conțin un link către un alt articol, numărul de modificări recente, diferențe, contribuții etc.
Pasul 5. Treceți datele postate către API prin utilizarea CURL sau a altui instrument care vă permite să utilizați metoda POST la script
Metoda GET poate funcționa, de asemenea.
Pasul 6. Asigurați-vă că păstrați cookie-urile trimise către o aplicație (Unele scripturi / aplicații ar putea dori să le stocheze într-un subfolder
Pasul 7. Când interacționați cu interfața cu utilizatorul MediaWiki, aveți în vedere jetonul de editare păstrat în majoritatea paginilor de editare
Jetonul de editare este folosit pentru a determina coliziunile de editare și pentru a evita suprascrierea unei alte editări deja efectuate (Aceasta este utilizată și în revenire.). Rețineți că lucrurile nu pot merge mai bine dacă acționați cu interfața de utilizare a wiki. Fiți atenți la orice regex pe care îl utilizați pentru a vă asigura că vor face doar rezultatul dorit.
Pasul 8. Citiți rezultatele trimise de wiki
Rezultatele vă vor fi trimise într-un răspuns HTTP, care poate fi citit de mulți analizatori. Aveți grijă suplimentară de formatul pe care îl alegeți. Asigurați-vă că utilizați analizorul adecvat pentru formatul respectiv. De obicei, este o bună practică să specificați în mod explicit formatul pe MediaWiki, chiar dacă acesta are un format implicit pe care doriți să îl utilizați.
sfaturi
- Asigurați-vă că aveți suport pentru scriptul local de pe wiki înainte de a utiliza API-ul.
- Puteți găsi mai multe despre MediaWiki folosind API-ul său.
