A API MediaWiki é um conjunto bem documentado de ferramentas de desenvolvimento que pode realizar a maioria das tarefas em um script. A API é normalmente usada para desenvolvimento de ferramentas automatizadas para uso no wiki. A API MediaWiki pode ser facilmente usada pela maioria das linguagens, particularmente PHP (as funções curl), bem como Perl e algumas outras.
Passos
Etapa 1. Leia a documentação da API MediaWiki
Ele está localizado em 'api.php' no mesmo diretório que o index.php usual. Exemplo:
Etapa 2. Selecione um formato de saída
O MediaWiki oferece saída de dados na forma de JSON, JSONFM, PHP (formato serializado), PHPFM, WDDX, WDDXFM, XML, XMLFM, YAML, YAMLFM e RAWFM. Os formatos com o sufixo "FM" são impressos em HTML.
Etapa 3. Escolha uma ação
A API MediaWiki suporta as seguintes ações:
- ajuda - Veja a tela de ajuda
- login - Faça login no MediaWiki
- opensearch - Implemente o protocolo opensearch. (Nem todas as instalações do MediaWiki têm isso).
- feedwatchlist - Retorna um feed da lista de observação.
- consulta - tem uma variedade de opções. Veja a documentação da API MediaWiki para eles.
Etapa 4. Selecione uma consulta ou lista
Além das ações padrão, o MediaWiki suporta diferentes consultas e listas, como páginas de listagem que contêm um link para outro artigo, número de diferenças de mudanças recentes, contribuições, etc.
Etapa 5. Passe os dados postados para a API por meio do uso de CURL ou outra ferramenta que permita usar o método POST para o script
O método GET também pode funcionar.
Etapa 6. Certifique-se de manter os cookies enviados para um aplicativo (alguns scripts / aplicativos podem desejar armazená-los em uma subpasta
Etapa 7. Ao interagir com a interface de usuário do MediaWiki, preste atenção ao token de edição mantido na maioria das páginas de edição
O token de edição é usado para determinar as colisões de edição e evitar sobrescrever outra edição já feita (isso também é usado na reversão). Lembre-se de que é mais fácil as coisas darem errado se você estiver agindo com a interface do usuário do wiki. Esteja atento a quaisquer regexes que você usar para ter certeza de que elas farão apenas o resultado pretendido.
Etapa 8. Leia os resultados enviados pelo wiki
Os resultados serão enviados a você em uma resposta HTTP, que pode ser lida por vários analisadores. Tome muito cuidado com o formato que você escolher. Certifique-se de usar o analisador apropriado para esse formato. Normalmente, é uma boa prática declarar explicitamente o formato para o MediaWiki, mesmo se ele tiver um formato padrão que você deseja usar.
Pontas
- Certifique-se de ter o suporte do seu wiki local para o script antes de usar a API.
- Você pode encontrar mais sobre o MediaWiki usando sua API.
