De MediaWiki API is een goed gedocumenteerde set ontwikkeltools die de meeste taken in één script kunnen uitvoeren. De API wordt meestal gebruikt voor de ontwikkeling van geautomatiseerde tools voor gebruik in de wiki. De MediaWiki API kan gemakkelijk worden gebruikt door de meeste talen, met name PHP (The curl-functies) evenals Perl en een paar andere..
Stappen
Stap 1. Lees de MediaWiki API-documentatie
Het bevindt zich op 'api.php' in dezelfde map als de gebruikelijke index.php. Voorbeeld:
Stap 2. Selecteer een uitvoerformaat
De MediaWiki biedt gegevensuitvoer in de vorm van JSON, JSONFM, PHP (serialized formaat), PHPFM, WDDX, WDDXFM, XML, XMLFM, YAML, YAMLFM en RAWFM. De formaten met het achtervoegsel "FM" zijn behoorlijk gedrukt in HTML.
Stap 3. Kies een actie
De MediaWiki API ondersteunt de volgende acties:
- help - Zie het helpscherm
- inloggen - Inloggen op MediaWiki
- opensearch - Implementeer het opensearch-protocol. (Niet alle MediaWiki-installaties hebben dit).
- feedwatchlist - Retourneer een watchlist-feed.
- query - Heeft een verscheidenheid aan opties. Zie de MediaWiki API-documentatie voor hen.
Stap 4. Selecteer een zoekopdracht of een lijst
Naast de standaard acties ondersteunt MediaWiki verschillende zoekopdrachten en lijsten, zoals het weergeven van pagina's die een link naar een ander artikel bevatten, aantal recente wijzigingen diffs, bijdragen, etc.
Stap 5. Geef de geposte gegevens door aan de API met behulp van CURL of een andere tool waarmee u de POST-methode voor het script kunt gebruiken
De GET-methode kan ook werken.
Stap 6. Zorg ervoor dat u cookies bewaart die naar een applicatie worden verzonden (sommige scripts/applicaties willen deze mogelijk in een submap opslaan
Stap 7. Let bij interactie met de MediaWiki-gebruikersinterface op uw bewerkingstoken dat op de meeste bewerkingspagina's wordt bewaard
Het bewerkingstoken wordt gebruikt om bewerkingsbotsingen te bepalen en te voorkomen dat een andere bewerking die al is uitgevoerd wordt overschreven (dit wordt ook gebruikt bij terugdraaien). Houd er rekening mee dat het gemakkelijker is om dingen mis te gaan als je handelt met de gebruikersinterface van de wiki. Houd rekening met eventuele regexes die u gebruikt om er zeker van te zijn dat ze alleen het beoogde resultaat opleveren.
Stap 8. Lees de resultaten die door de wiki zijn verzonden
De resultaten worden naar u verzonden in een HTTP-reactie, die door veel parsers kan worden gelezen. Let extra op het formaat dat u kiest. Zorg ervoor dat u de juiste parser voor dat formaat gebruikt. Het is meestal een goede gewoonte om het formaat expliciet aan MediaWiki te vermelden, zelfs als het een standaardformaat heeft dat je wilt gebruiken.
Tips
- Zorg ervoor dat uw lokale wiki het script ondersteunt voordat u de API gebruikt.
- U kunt meer over MediaWiki vinden door de API te gebruiken.
