L'API MediaWiki è un insieme ben documentato di strumenti di sviluppo che possono svolgere la maggior parte delle attività in uno script. L'API viene in genere utilizzata per lo sviluppo di strumenti automatizzati da utilizzare nel wiki. L'API MediaWiki può essere facilmente utilizzata dalla maggior parte dei linguaggi, in particolare PHP (le funzioni curl) così come Perl e pochi altri.
Passi
Passaggio 1. Leggi la documentazione dell'API MediaWiki
Si trova in 'api.php' nella stessa directory del solito index.php. Esempio:
Passaggio 2. Seleziona un formato di output
MediaWiki offre output di dati sotto forma di JSON, JSONFM, PHP (formato serializzato), PHPFM, WDDX, WDDXFM, XML, XMLFM, YAML, YAMLFM e RAWFM. I formati con suffisso "FM" sono piuttosto stampati in HTML.
Passaggio 3. Scegli un'azione
L'API MediaWiki supporta le seguenti azioni:
- aiuto - Visualizza la schermata di aiuto
- login - Accedi a MediaWiki
- opensearch - Implementa il protocollo opensearch. (Non tutte le installazioni di MediaWiki hanno questo).
- feedwatchlist - Restituisce un feed di watchlist.
- query - Ha una varietà di opzioni. Consulta la documentazione dell'API MediaWiki per loro.
Passaggio 4. Selezionare una query o un elenco
Oltre alle azioni standard, MediaWiki supporta diverse query ed elenchi, come l'elenco delle pagine che contengono un collegamento a un altro articolo, il numero di differenze di modifiche recenti, i contributi, ecc.
Passaggio 5. Passare i dati pubblicati all'API tramite l'uso di CURL o un altro strumento che consente di utilizzare il metodo POST per lo script
Anche il metodo GET può funzionare.
Passaggio 6. Assicurati di conservare i cookie inviati a un'applicazione (alcuni script/applicazioni potrebbero volerlo memorizzare in una sottocartella
Passaggio 7. Quando interagisci con l'interfaccia utente di MediaWiki, fai attenzione al token di modifica conservato nella maggior parte delle pagine di modifica
Il token di modifica viene utilizzato per determinare le collisioni di modifica ed evitare di sovrascrivere un'altra modifica già eseguita (questo viene utilizzato anche nel rollback). Tieni presente che è più facile che le cose vadano male se agisci con l'interfaccia utente del wiki. Fai attenzione alle espressioni regolari che utilizzi per assicurarti che ottengano solo il risultato previsto.
Passaggio 8. Leggi i risultati inviati dal wiki
I risultati ti verranno inviati in una risposta HTTP, che può essere letta da molti parser. Prenditi cura del formato che scegli. Assicurati di utilizzare il parser appropriato per quel formato. Di solito è una buona pratica indicare esplicitamente il formato a MediaWiki anche se ha un formato predefinito che si desidera utilizzare.
Suggerimenti
- Assicurati di avere il supporto dello script della tua wiki locale prima di utilizzare l'API.
- Puoi trovare ulteriori informazioni su MediaWiki utilizzando la sua API.
