L'API MediaWiki est un ensemble bien documenté d'outils de développement qui peuvent effectuer la majorité des tâches dans un seul script. L'API est généralement utilisée pour le développement d'outils automatisés à utiliser dans le wiki. L'API MediaWiki peut être facilement utilisée par la plupart des langages, en particulier PHP (Les fonctions curl) ainsi que Perl et quelques autres.
Pas
Étape 1. Lisez la documentation de l'API MediaWiki
Il se trouve dans 'api.php' dans le même répertoire que l'habituel index.php. Exemple:
Étape 2. Sélectionnez un format de sortie
Le MediaWiki offre une sortie de données sous la forme de JSON, JSONFM, PHP (format sérialisé), PHPFM, WDDX, WDDXFM, XML, XMLFM, YAML, YAMLFM et RAWFM. Les formats suffixés "FM" sont joliment imprimés en HTML.
Étape 3. Choisissez une action
L'API MediaWiki prend en charge les actions suivantes:
- help - Voir l'écran d'aide
- connexion - Connectez-vous à MediaWiki
- opensearch - Implémentez le protocole opensearch. (Toutes les installations MediaWiki n'ont pas cela).
- feedwatchlist - Renvoie un flux de liste de surveillance.
- requête - A une variété d'options. Voir la documentation de l'API MediaWiki pour eux.
Étape 4. Sélectionnez une requête ou une liste
Outre les actions standard, MediaWiki prend en charge différentes requêtes et listes, telles que les pages de liste qui contiennent un lien vers un autre article, le nombre de modifications récentes, les différences, les contributions, etc.
Étape 5. Transmettez les données publiées à l'API via l'utilisation de CURL ou d'un autre outil qui vous permet d'utiliser la méthode POST pour le script
La méthode GET peut également fonctionner.
Étape 6. Assurez-vous de conserver les cookies envoyés à une application (Certains scripts/applications peuvent souhaiter les stocker dans un sous-dossier
Étape 7. Lorsque vous interagissez avec l'interface utilisateur de MediaWiki, faites attention à votre jeton d'édition conservé dans la plupart des pages d'édition
Le jeton d'édition est utilisé pour déterminer les collisions d'édition et éviter de remplacer une autre édition déjà effectuée (ceci est également utilisé dans la restauration.). Gardez à l'esprit qu'il est plus facile que les choses tournent mal si vous agissez avec l'interface utilisateur du wiki. Soyez attentif à toutes les expressions régulières que vous utilisez pour vous assurer qu'elles n'obtiendront que le résultat escompté.
Étape 8. Lisez les résultats envoyés par le wiki
Les résultats vous seront envoyés dans une réponse HTTP, qui peut être lue par de nombreux parseurs. Faites très attention au format que vous choisissez. Assurez-vous d'utiliser l'analyseur approprié pour ce format. C'est généralement une bonne pratique d'indiquer explicitement le format à MediaWiki même s'il a un format par défaut que vous souhaitez utiliser.
Des astuces
- Assurez-vous que votre wiki local prend en charge le script avant d'utiliser l'API.
- Vous pouvez en savoir plus sur MediaWiki en utilisant son API.
