MediaWiki API är en väldokumenterad uppsättning utvecklingsverktyg som kan utföra de flesta uppgifter i ett skript. API: et används vanligtvis för utveckling av automatiserade verktyg för användning i wiki. MediaWiki API kan enkelt användas av de flesta språk, särskilt PHP (curl -funktionerna) samt Perl och några andra..
Steg
Steg 1. Läs dokumentationen för MediaWiki API
Den ligger på 'api.php' i samma katalog som den vanliga index.php. Exempel:
Steg 2. Välj ett utmatningsformat
MediaWiki erbjuder datautmatning i form av JSON, JSONFM, PHP (seriellt format), PHPFM, WDDX, WDDXFM, XML, XMLFM, YAML, YAMLFM och RAWFM. Formaten med tillägget "FM" är ganska utskrivna i HTML.
Steg 3. Välj en åtgärd
MediaWiki API stöder följande åtgärder:
- hjälp - Se hjälpskärmen
- inloggning - Logga in på MediaWiki
- opensearch - Implementera opensearch -protokollet. (Inte alla MediaWiki -installationer har detta).
- feedwatchlist - Returnera en övervakningslista.
- fråga - Har en mängd olika alternativ. Se MediaWiki API -dokumentationen för dem.
Steg 4. Välj en fråga eller en lista
Förutom standardåtgärderna stöder MediaWiki olika frågor och listor, till exempel listningssidor som innehåller en länk till en annan artikel, antal senaste ändringar, bidrag osv.
Steg 5. Skicka den publicerade informationen till API: et med hjälp av CURL eller ett annat verktyg som låter dig använda POST -metoden till skriptet
GET -metoden kan också fungera.
Steg 6. Se till att behålla cookies skickade till en applikation (Vissa skript/program kanske vill lagra den i en undermapp
Steg 7. När du interagerar med MediaWiki -användargränssnittet, tänk på din redigeringstoken som finns på de flesta redigeringssidor
Redigeringstoken används för att avgöra redaktionskollisioner och undvika att åsidosätta en annan redigering som redan gjorts (Detta används också vid återgång.). Tänk på att det är lättare för saker att gå snett om du agerar med användargränssnittet på wikin. Var uppmärksam på alla regexer du använder för att se till att de bara kommer att göra det avsedda resultatet.
Steg 8. Läs resultaten som skickas av wiki
Resultaten skickas till dig i ett HTTP -svar, som kan läsas av många analysatorer. Var extra noga med det format du väljer. Se till att du använder lämplig parser för det formatet. Det är vanligtvis bra att uttryckligen ange formatet för MediaWiki även om det har ett standardformat som du vill använda.
Tips
- Se till att du har din lokala wikis stöd för skriptet innan du använder API: et.
- Du kan hitta mer om MediaWiki med hjälp av dess API.
