MediaWiki API er et veldokumentert sett med utviklingsverktøy som kan utføre de fleste oppgavene i ett skript. API brukes vanligvis for utvikling av automatiserte verktøy for bruk i wiki. MediaWiki API kan enkelt brukes av de fleste språk, spesielt PHP (Curl -funksjonene) samt Perl og noen andre.
Trinn
Trinn 1. Les MediaWiki API -dokumentasjonen
Den ligger på 'api.php' i samme katalog som den vanlige index.php. Eksempel:
Trinn 2. Velg et utdataformat
MediaWiki tilbyr datautgang i form av JSON, JSONFM, PHP (serialisert format), PHPFM, WDDX, WDDXFM, XML, XMLFM, YAML, YAMLFM og RAWFM. Formatene med "FM" er ganske trykte i HTML.
Trinn 3. Velg en handling
MediaWiki API støtter følgende handlinger:
- hjelp - Se hjelpeskjermen
- login - Logg inn på MediaWiki
- opensearch - Implementere opensearch -protokollen. (Ikke alle MediaWiki -installasjoner har dette).
- feedwatchlist - Returner en feed fra overvåkningslisten.
- spørring - Har en rekke alternativer. Se MediaWiki API -dokumentasjonen for dem.
Trinn 4. Velg en forespørsel eller en liste
I tillegg til standardhandlingene, støtter MediaWiki forskjellige spørsmål og lister, for eksempel oppføringssider som inneholder en lenke til en annen artikkel, antall nylige endringer, bidrag osv.
Trinn 5. Send de postede dataene til API -en ved bruk av CURL eller et annet verktøy som lar deg bruke POST -metoden til skriptet
GET -metoden kan også fungere.
Trinn 6. Sørg for å beholde informasjonskapsler sendt til et program (Noen skript/applikasjoner vil kanskje lagre det i en undermappe
Trinn 7. Når du samhandler med MediaWiki -brukergrensesnittet, må du huske på redigeringstokenet som finnes på de fleste redigeringssider
Redigeringstokenet brukes til å bestemme redigeringskollisjoner og unngå å overstyre en annen redigering som allerede er utført (Dette brukes også i tilbakeføring.). Husk at det er lettere for ting å gå galt hvis du handler med brukergrensesnittet til wikien. Vær oppmerksom på alle regexer du bruker for å sikre at de bare vil gjøre det tiltenkte resultatet.
Trinn 8. Les resultatene sendt av wiki
Resultatene blir sendt til deg i et HTTP -svar, som kan leses av mange analysatorer. Ta ekstra vare på formatet du velger. Sørg for at du bruker riktig parser for det formatet. Det er vanligvis en god praksis å eksplisitt oppgi formatet til MediaWiki selv om det har et standardformat du vil bruke.
Tips
- Sørg for at du har din lokale wikis støtte for skriptet før du bruker API.
- Du finner mer om MediaWiki ved å bruke API -en.
