MediaWiki-API-Hilfe
Dies ist eine automatisch generierte MediaWiki-API-Dokumentationsseite.
Dokumentation und Beispiele: https://www.mediawiki.org/wiki/API/de
Hauptmodul
Status: Alle auf dieser Seite gezeigten Funktionen sollten funktionieren, allerdings ist die API in aktiver Entwicklung und kann sich zu jeder Zeit ändern. Abonniere die MediaWiki-API-Ankündigungs-Mailingliste, um über Aktualisierungen informiert zu werden.
Fehlerhafte Anfragen: Wenn fehlerhafte Anfragen an die API gesendet werden, wird ein HTTP-Header mit dem Schlüssel „MediaWiki-API-Error“ gesendet. Der Wert des Headers und der Fehlercode werden auf den gleichen Wert gesetzt. Für weitere Informationen siehe API: Fehler und Warnungen.
- action
Auszuführende Aktion.
- Ein Wert: block, checktoken, clearhasmsg, compare, createaccount, delete, edit, emailuser, expandtemplates, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, help, imagerotate, import, login, logout, managetags, move, opensearch, options, paraminfo, parse, patrol, protect, purge, query, revisiondelete, rollback, rsd, setnotificationtimestamp, sfautocomplete, sfautoedit, spamblacklist, stashedit, tag, tokens, unblock, undelete, upload, userrights, visualeditor, visualeditoredit, watch
- Standard: help
- format
Format der Ausgabe.
- Ein Wert: dbg, dbgfm, dump, dumpfm, json, jsonfm, none, php, phpfm, rawfm, txt, txtfm, wddx, wddxfm, xml, xmlfm, yaml, yamlfm
- Standard: jsonfm
- maxlag
maxlag kann verwendet werden, wenn MediaWiki auf einem datenbankreplizierten Cluster installiert ist. Um weitere Replikationsrückstände zu verhindern, lässt dieser Parameter den Client warten, bis der Replikationsrückstand kleiner als der angegebene Wert (in Sekunden) ist. Bei einem größerem Rückstand wird der Fehlercode maxlag zurückgegeben mit einer Nachricht wie Waiting for $host: $lag seconds lagged.
Siehe Handbuch: Maxlag parameter für weitere Informationen.- smaxage
Den
s-maxage-Header auf diese Anzahl Sekunden festlegen. Fehler werden niemals gecacht.- Standard: 0
- maxage
Den
max-age-Header auf diese Anzahl Sekunden festlegen. Fehler werden niemals gecacht.- Standard: 0
- assert
Sicherstellen, dass der Benutzer eingeloggt ist, wenn auf user gesetzt, oder Bot ist, wenn auf bot gesetzt.
- Ein Wert: user, bot
- requestid
Der angegebene Wert wird mit in die Antwort aufgenommen und kann zur Unterscheidung von Anfragen verwendet werden.
- servedby
Namen des bearbeitenden Hosts mit zurückgeben.
- curtimestamp
Aktuellen Zeitstempel mit zurückgeben.
- origin
Beim Zugriff auf die API mittels Cross-Domain-AJAX-Anfrage (CORS) ist dieser Parameter auf die veranlassende Domain zu setzen. Er muss in jedem Pre-Flight-Request angegeben werden und deshalb ein Teil der Anfrage-URI sein (nicht des POST-Bodys). Er muss genau einer der Angaben im
Origin-Header entsprechen, d. h. er muss auf etwas wie https://de.wikipedia.org oder https://meta.wikimedia.org gesetzt werden. Falls dieser Parameter nicht mit demOrigin-Header übereinstimmt, wird eine 403-Antwort zurückgegeben. Falls dieser Parameter demOrigin-Header entspricht und die Domain auf der Whitelist ist, wird einAccess-Control-Allow-Origin-Header gesetzt.- uselang
Zu verwendende Sprache für Nachrichtenübersetzungen. Eine Liste der Codes kann von action=query&meta=siteinfo mit siprop=languages abgerufen werden. Gib user zum Verwenden der aktuellen Benutzerspracheinstellung oder content an, um die Inhaltssprache des Wikis zu verwenden.
- Standard: user
- Hilfe für das Hauptmodul
- api.php?action=help
- Alle Hilfen in einer Seite
- api.php?action=help&recursivesubmodules=1
Danksagungen
API-Entwickler:
- Roan Kattouw (Hauptentwickler von September 2007 bis 2009)
- Victor Vasiliev
- Bryan Tong Minh
- Sam Reed
- Yuri Astrakhan (Autor, Hauptentwickler von September 2006 bis September 2007)
- Brad Jorsch (Hauptentwickler seit 2013)
Bitte sende deine Kommentare, Vorschläge und Fragen an mediawiki-api@lists.wikimedia.org oder reiche einen Fehlerbericht auf https://phabricator.wikimedia.org/ ein.