API:Extensions/es

Este documento cubre la creación de un módulo API en una extensión para usar con MediaWiki 1.30 y versiones posteriores.

Creación y registro de módulo
Todos los módulos API son subclases de, pero algunos tipos de módulos usan una clase base derivada. El método de registro también depende del tipo de módulo.


 * Módulos de acción
 * Módulos que proporcionan un valor para el parámetro principal  deben subclasificar . Ellos deberían ser registrados en   utilizando la clave.


 * Módulos de formato
 * Los módulos que proporcionan un valor para el principal  parámetro tendría subclase . Ellos deberían ser registrados en   utilizando la clave  . Es muy raro para una extensión necesitar agregar un módulo de formato.


 * Submódulos de consulta
 * Módulos que proporcionan un valor para los parámetros,   o  , para   tiene subclase,  (si no se puede usar como generador) o  (si se puede usar como generador). Deberían ser registrados en   utilizando la clave  ,   o.

En todos los casos, el valor de la clave de registro es un objeto con el nombre de módulo (es decir, el valor del parámetro) como clave y el nombre de la clase como valor. Los módulos también pueden ser registrados condicionalmente utilizando (para módulos de acción y formato) y  (para submódulos de consulta).

Prefijo
En el constructor de tu módulo API, cuando llamas a  puedes especificar un prefijo opcional para los parámetros de tu módulo. (En la documentación generada para un módulo, este prefijo, si lo hay, aparece entre paréntesis en el encabezado del módulo). Si tu módulo es un submódulo de consulta, entonces se requiere un prefijo, desde que un cliente puede invocar múltiples submódulos, cada uno con sus propios parámetros en una sola solicitud. Para los módulos de acción y formato, el prefijo es opcional.

Parámetros
La mayoría de los módulos requieren parámetros. Estos se definen implementando. El valor de retorno es una matriz asociativa donde las claves son los nombres de parámetros (sin prefijo) y los valores son, ya sea el valor escalar por defecto para el parámetro o una matriz que define las propiedades del parámetro utilizando el  constantes definidas por.

El ejemplo ilustra la sintaxis y algunas de las más comunes constantes.

Los parámetros son documentados utilizando el mecanismo i18n de MediaWiki. Ver #Documentation para más detalles.

Ejecución y salida
El código que actualmente implementa el módulo va en el método. Este código generalmente usará para obtener los parámetros de entrada y usará  para obtener el objeto  al que se agregar cualquier salida.

Query prop submodules tendrían que utilizar para acceder al conjunto de páginas para operar.

Query submodules que pueden ser usados como generadores también necesitarán implementar que es pasado a una  que debería ser completado con las páginas generadas. En este caso, el  generalmente "no" debe usarse.

Caching
Por defecto las respuestas de la API están marcadas como no almacenables en caché, ¡('Cache-Control: private')! Para los módulos de acción, puedes permitir el almacenamiento en caché llamando. Esto todavía requiere que los clientes pasen los parámetros  o   para habilitar realmente el almacenamiento en caché. Puede forzar el almacenamiento en caché llamando también.

Para los módulos de consulta, no llames a esos métodos. Puedes permitir el almacenamiento en caché, por el contrario implementando.

En cualquier caso, asegúrate de que la infomación privada no esté expuesta.

Manejo de token
Si tu módulo de acción cambia el wiki de alguna manera, deberías requerir un token de algún tipo. Para que esto se maneje automáticamente, implemente el método, devolviendo el token que requiere su módulo (probablemente el   Edit token). El código base API validará automáticamente el token que los clientes proporcionen en las solicitudes API de un parámetro.

Si no deseas utilizar un token que es parte del núcleo, sino más bien un token personalizado con tus propias verificaciones de permisos, usa hook para registrar tu token.

Acceso a la base de datos maestra
Si tu módulo accede a la base de datos maestra, debería implementar el método  para devolver.

Errores de retorno
incluye varios métodos para realizar diversas comprobaciones, por ejemplo,


 * Si necesitas afirmar que se proporcionó exactamente uno de un conjunto de parámetros, use.
 * Si necesitas afirmar que se suministró como máximo uno de un conjunto de parámetros, usa.
 * Si necesitas afirmar que se suministró al menos uno de un conjunto de parámetros, usa
 * Si necesitas afirmar que el usuario tiene ciertos derechos, usa.
 * Si necesitas afirmar que el usuario puede realizar una acción en una página en particular, usa.
 * Si el usuario está bloqueado (y eso es importante para su módulo), pasa el objeto  a.

Pero a menudo te encontrarás con casos en los que necesitas generar un error propio. La forma habitual de hacerlo es llamar, aunque si tienes un  con la información del error, podrías pasarlo a  en su lugar.

Si necesitas emitir una advertencia en lugar de un error, usa, o si es una advertencia de desaprobación.

Documentación
La API se documentó utilizando el mecanismo i18n de MediaWiki. Los mensajes necesitados generalmente tienen nombres predeterminados basados ​​en la "ruta" del módulo. Para los módulos de acción y formato, la ruta es la misma que el nombre del módulo utilizado durante el registro. Para submódulos de consulta, es el nombre con el prefijo "query+".

Cada módulo necesitará un mensaje, que debe ser una descripción de una línea del módulo. Si se necesita texto de ayuda adicional, también se puede crear. Cada parámetro necesitará un mensaje, y los parámetros que usan   también necesitarán un   para cada valor.

Más detalles sobre la documentación de la API están disponibles en.

Las extensiones también pueden mantener documentación API adicional en WikiMedia.org. Esto debe ubicarse en la página principal de la extensión o, si se requiere más espacio, en páginas llamadas  o subpáginas de las mismas (p. Ej.,  o ). El espacio de nombres de la API está reservado para la API del núcleo de MediaWiki.

Módulos principales extendidos
Desde MediaWiki 1.14, es posible extender la funcionalidad de los módulos del núcleo utilizando los siguientes ganchos:


 * - para agregar o modificar la lista de parámetros del módulo
 * - para agregar o modificar las descripciones de los parámetros del módulo
 * - para hacer algo después de que se haya ejecutado el módulo (pero antes de que se haya generado el resultado)
 * Usa para los módulos ,   y
 * Si el módulo se ejecuta en modo generador, se llamará en su lugar

Lista de extensiones con funcionalidad API
Consulte para ver ejemplos de extensiones que agregan o extienden la API.

Probando tu extensión

 * Visita [/api.php api.php] y navegue a la ayuda generada para su módulo o submódulo de consulta. La información de ayuda de tu extensión debería ser correcta.
 * Las URL de ejemplo que proporcionó en  deberían aparecer en "Ejemplos", intente hacer clic en ellas.
 * Omitir y exprimir parámetros de URL en la cadena de consulta, verifique la respuesta de su extensión.
 * Visita Special:ApiSandbox y explora interactivamente tu API.
 * Visita para ver información adicional sobre tu extensión.