MediaWiki API er et veldokumenteret sæt udviklingsværktøjer, der kan udføre de fleste opgaver i et script. API'en bruges typisk til udvikling af automatiserede værktøjer til brug i wiki. MediaWiki API kan let bruges af de fleste sprog, især PHP (curl -funktionerne) samt Perl og et par andre..
Trin
Trin 1. Læs MediaWiki API -dokumentationen
Den er placeret på 'api.php' i samme bibliotek som den sædvanlige index.php. Eksempel:
Trin 2. Vælg et outputformat
MediaWiki tilbyder dataoutput i form af JSON, JSONFM, PHP (serialiseret format), PHPFM, WDDX, WDDXFM, XML, XMLFM, YAML, YAMLFM og RAWFM. Formaterne med endelsen "FM" er smukt printede i HTML.
Trin 3. Vælg en handling
MediaWiki API understøtter følgende handlinger:
- hjælp - Se hjælpeskærmen
- login - Log ind på MediaWiki
- opensearch - Implementér opensearch -protokollen. (Ikke alle MediaWiki -installationer har dette).
- feedwatchlist - Returner et feed over overvågningsliste.
- forespørgsel - Har en række muligheder. Se MediaWiki API -dokumentationen for dem.
Trin 4. Vælg en forespørgsel eller en liste
Udover standardhandlingerne understøtter MediaWiki forskellige forespørgsler og lister, f.eks. Opslagssider, der indeholder et link til en anden artikel, antallet af nylige ændringer, bidrag osv.
Trin 5. Send de bogførte data til API'en ved hjælp af CURL eller et andet værktøj, der giver dig mulighed for at bruge POST -metoden til scriptet
GET -metoden fungerer muligvis også.
Trin 6. Sørg for at beholde cookies sendt til et program (Nogle scripts/applikationer vil måske gemme det i en undermappe
Trin 7. Når du interagerer med MediaWiki -brugergrænsefladen, skal du huske på dit redigeringstoken, der opbevares på de fleste redigeringssider
Redigeringstokenet bruges til at bestemme redigeringskollisioner og undgå at tilsidesætte endnu en redigering, der allerede er udført (Dette bruges også ved tilbagesendelse). Husk, at det er lettere for ting at gå galt, hvis du handler med brugergrænsefladen på wiki. Vær opmærksom på alle regexer, du bruger, for at sikre, at de kun gør det tilsigtede resultat.
Trin 8. Læs resultaterne fra wiki
Resultaterne sendes til dig i et HTTP -svar, som kan læses af mange parsere. Pas ekstra godt på det format, du vælger. Sørg for at bruge den relevante parser til dette format. Det er normalt en god praksis at udtrykkeligt angive formatet til MediaWiki, selvom det har et standardformat, som du vil bruge.
Tips
- Sørg for, at du har din lokale wikis understøttelse af scriptet, før du bruger API'en.
- Du kan finde mere om MediaWiki ved at bruge dets API.
