La API de MediaWiki es un conjunto bien documentado de herramientas de desarrollo que pueden realizar la mayoría de las tareas en un solo script. La API se utiliza normalmente para el desarrollo de herramientas automatizadas para su uso en la wiki. La API de MediaWiki puede ser utilizada fácilmente por la mayoría de los lenguajes, particularmente PHP (Las funciones curl), así como Perl y algunos otros.
Pasos
Paso 1. Lea la documentación de la API de MediaWiki
Se encuentra en 'api.php' en el mismo directorio que el index.php habitual. Ejemplo:
Paso 2. Seleccione un formato de salida
MediaWiki ofrece salida de datos en forma de JSON, JSONFM, PHP (formato serializado), PHPFM, WDDX, WDDXFM, XML, XMLFM, YAML, YAMLFM y RAWFM. Los formatos con el sufijo "FM" son bastante impresos en HTML.
Paso 3. Elija una acción
La API de MediaWiki admite las siguientes acciones:
- ayuda: consulte la pantalla de ayuda
- iniciar sesión - Iniciar sesión en MediaWiki
- opensearch: implementa el protocolo opensearch. (No todas las instalaciones de MediaWiki tienen esto).
- feedwatchlist: devuelve un feed de lista de seguimiento.
- consulta: tiene una variedad de opciones. Consulte la documentación de la API de MediaWiki.
Paso 4. Seleccione una consulta o una lista
Además de las acciones estándar, MediaWiki admite diferentes consultas y listas, como listas de páginas que contienen un enlace a otro artículo, número de diferencias de cambios recientes, contribuciones, etc.
Paso 5. Pase los datos publicados a la API mediante el uso de CURL u otra herramienta que le permita utilizar el método POST en el script
El método GET también puede funcionar.
Paso 6. Asegúrese de mantener las cookies enviadas a una aplicación (algunos scripts / aplicaciones pueden desear almacenarlas en una subcarpeta
Paso 7. Al interactuar con la interfaz de usuario de MediaWiki, tenga en cuenta el token de edición que se encuentra en la mayoría de las páginas de edición
El token de edición se usa para determinar las colisiones de edición y evitar anular otra edición ya realizada (esto también se usa en la reversión). Tenga en cuenta que es más fácil que las cosas salgan mal si está actuando con la interfaz de usuario de la wiki. Tenga en cuenta las expresiones regulares que utilice para asegurarse de que solo producirán el resultado deseado.
Paso 8. Lea los resultados enviados por la wiki
Los resultados se le enviarán en una respuesta HTTP, que muchos analizadores pueden leer. Tenga especial cuidado con el formato que elija. Asegúrese de utilizar el analizador adecuado para ese formato. Por lo general, es una buena práctica indicar explícitamente el formato en MediaWiki incluso si tiene un formato predeterminado que desea usar.
Consejos
- Asegúrese de tener el soporte del script de su wiki local antes de usar la API.
- Puede encontrar más información sobre MediaWiki utilizando su API.
