L’API MediaWiki és un conjunt d’eines de desenvolupament ben documentat que pot realitzar la majoria de tasques en un script. L'API s'utilitza normalment per al desenvolupament d'eines automatitzades per al seu ús a la wiki. L'API MediaWiki es pot utilitzar fàcilment per la majoria dels idiomes, especialment PHP (Les funcions curl), així com Perl i alguns altres.
Passos
Pas 1. Llegiu la documentació de l'API MediaWiki
Es troba a 'api.php' al mateix directori que el index.php habitual. Exemple:
Pas 2. Seleccioneu un format de sortida
El MediaWiki ofereix sortida de dades en forma de JSON, JSONFM, PHP (format serialitzat), PHPFM, WDDX, WDDXFM, XML, XMLFM, YAML, YAMLFM i RAWFM. Els formats amb el sufix "FM" estan força impresos en HTML.
Pas 3. Trieu una acció
L'API MediaWiki admet les accions següents:
- ajuda: vegeu la pantalla d'ajuda
- login - Inicieu la sessió a MediaWiki
- opensearch: implementeu el protocol opensearch. (No totes les instal·lacions de MediaWiki tenen això).
- feedwatchlist: torna un feed de llista de seguiment.
- consulta: té diverses opcions. Consulteu la documentació de l'API MediaWiki.
Pas 4. Seleccioneu una consulta o una llista
A més de les accions estàndard, MediaWiki admet diferents consultes i llistes, com ara llistar pàgines que contenen un enllaç a un altre article, diferències de canvis recents, contribucions, etc.
Pas 5. Passeu les dades publicades a l'API mitjançant l'ús de CURL o d'una altra eina que us permet utilitzar el mètode POST a l'script
El mètode GET també pot funcionar.
Pas 6. Assegureu-vos de conservar les galetes enviades a una aplicació (és possible que alguns scripts / aplicacions vulguin emmagatzemar-les a una subcarpeta
Pas 7. Quan interactueu amb la interfície d'usuari de MediaWiki, tingueu en compte el vostre testimoni d'edició guardat a la majoria de pàgines d'edició
El testimoni d’edició s’utilitza per determinar les col·lisions d’edició i evitar anul·lar una altra edició ja feta (també s’utilitza en la recuperació). Tingueu en compte que és més fàcil que les coses es torcin si actueu amb la interfície d'usuari del wiki. Tingueu en compte els requisits regulars que utilitzeu per assegurar-vos que només obtindran el resultat previst.
Pas 8. Llegiu els resultats enviats per la wiki
Els resultats us seran enviats en una resposta HTTP, que poden llegir molts analitzadors. Tingueu especial cura del format que trieu. Assegureu-vos que utilitzeu l’analitzador adequat per a aquest format. Normalment és una bona pràctica indicar explícitament el format a MediaWiki encara que tingui un format per defecte que vulgueu utilitzar.
Consells
- Assegureu-vos que teniu el suport del script de la vostra wiki local abans d’utilitzar l’API.
- Podeu trobar més informació sobre MediaWiki mitjançant la seva API.
