Die MediaWiki API is 'n goed gedokumenteerde stel ontwikkelingshulpmiddels wat die meeste take in een skrif kan verrig. Die API word tipies gebruik vir die ontwikkeling van outomatiese gereedskap vir gebruik in die wiki. Die MediaWiki API kan maklik deur die meeste tale gebruik word, veral PHP (The curl -funksies) sowel as Perl en 'n paar ander..
Stappe
Stap 1. Lees die MediaWiki API -dokumentasie
Dit is geleë op 'api.php' in dieselfde gids as die gewone index.php. Voorbeeld:
Stap 2. Kies 'n uitvoerformaat
Die MediaWiki bied data -uitvoer in die vorm van JSON, JSONFM, PHP (seriële formaat), PHPFM, WDDX, WDDXFM, XML, XMLFM, YAML, YAMLFM en RAWFM. Die formate met die agtervoegsel "FM" is redelik gedruk in HTML.
Stap 3. Kies 'n aksie
Die MediaWiki API ondersteun die volgende aksies:
- hulp - Sien die hulpskerm
- login - Meld aan by MediaWiki
- opensearch - Implementeer die opensearch -protokol. (Nie alle MediaWiki -installasies het dit nie).
- feedwatchlist - Stuur 'n kyklys -feed terug.
- navraag - het 'n verskeidenheid opsies. Sien die MediaWiki API -dokumentasie daarvoor.
Stap 4. Kies 'n navraag of 'n lys
Benewens die standaard aksies, ondersteun MediaWiki verskillende navrae en lyste, soos die lys van bladsye wat 'n skakel na 'n ander artikel bevat, die aantal onlangse veranderings, bydraes, ens.
Stap 5. Gee die geplaasde data aan die API deur die gebruik van CURL of 'n ander hulpmiddel waarmee u die POST -metode in die script kan gebruik
Die GET -metode kan ook werk.
Stap 6. Maak seker dat u koekies na 'n toepassing stuur (sommige skrifte/toepassings wil dit moontlik in 'n submap stoor
Stap 7. As u met die MediaWiki -gebruikerskoppelvlak omgaan, moet u let op u wysigingstoken wat op die meeste wysigingsbladsye gehou word
Die wysigingsteken word gebruik om wysigingsbotsings te bepaal en te vermy dat 'n ander wysiging wat reeds gedoen is, oorskry word (dit word ook gebruik in terugrol.). Hou in gedagte dat dinge makliker kan skeefloop as u met die gebruikerskoppelvlak van die wiki optree. Wees bedag op enige regse wat u gebruik om seker te maak dat dit slegs die beoogde resultaat sal behaal.
Stap 8. Lees die resultate wat deur die wiki gestuur is
Die resultate word aan u gestuur in 'n HTTP -antwoord, wat deur baie parsers gelees kan word. Let veral op die formaat wat u kies. Maak seker dat u die toepaslike ontleder vir die formaat gebruik. Dit is gewoonlik 'n goeie gebruik om die formaat eksplisiet aan MediaWiki te stel, selfs al het dit 'n standaardformaat wat u wil gebruik.
Wenke
- Maak seker dat u die plaaslike wiki se ondersteuning vir die script het voordat u die API gebruik.
- U kan meer oor MediaWiki vind deur die API te gebruik.
