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.

Testen: Zum einfachen Testen von API-Anfragen, siehe Special:ApiSandbox.

Parameter:
action

Auszuführende Aktion.

Einer der folgenden Werte: abusefiltercheckmatch, abusefilterchecksyntax, abusefilterevalexpression, abusefilterunblockautopromote, antispoof, ask, askargs, block, browsebyproperty, browsebysubject, categorytree, changeauthenticationdata, checktoken, clearhasmsg, clientlogin, compare, createaccount, delete, edit, emailuser, expandtemplates, ext.srf.slideshow.show, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, help, imagerotate, import, linkaccount, login, logout, managetags, mergehistory, move, opensearch, options, paraminfo, parse, patrol, protect, purge, query, removeauthenticationdata, resetpassword, revisiondelete, rollback, rsd, scribunto-console, setnotificationtimestamp, sfautocomplete, sfautoedit, smwinfo, stashedit, tag, tokens, unblock, undelete, unlinkaccount, upload, userrights, watch
Standard: help
format

Format der Ausgabe.

Einer der folgenden Werte: json, jsonfm, none, php, phpfm, rawfm, xml, xmlfm
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.

Typ: Ganzzahl
smaxage

Den s-maxage-HTTP-Cache-Control-Header auf diese Anzahl Sekunden festlegen. Fehler werden niemals gepuffert.

Typ: Ganzzahl
Standard: 0
maxage

Den max-age-HTTP-Cache-Control-Header auf diese Anzahl Sekunden festlegen. Fehler werden niemals gecacht.

Typ: Ganzzahl
Standard: 0
assert

Sicherstellen, dass der Benutzer eingeloggt ist, wenn auf user gesetzt, oder Bot ist, wenn auf bot gesetzt.

Einer der folgenden Werte: 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.

Typ: boolisch (Einzelheiten)
curtimestamp

Aktuellen Zeitstempel mit zurückgeben.

Typ: boolisch (Einzelheiten)
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 dem Origin-Header übereinstimmt, wird eine 403-Antwort zurückgegeben. Falls dieser Parameter dem Origin-Header entspricht und die Domain auf der Whitelist ist, wird ein Access-Control-Allow-Origin-Header gesetzt.

uselang

Zu verwendende Sprache für Nachrichtenübersetzungen. action=query&meta=siteinfo mit siprop=languages gibt eine Liste der Sprachcodes zurück. Gib user zum Verwenden der aktuellen Benutzerspracheinstellung oder content an, um die Inhaltssprache des Wikis zu verwenden.

Standard: user
Beispiele:
Hilfe für das Hauptmodul
api.php?action=help [in Spielwiese öffnen]
Alle Hilfen in einer Seite
api.php?action=help&recursivesubmodules=1 [in Spielwiese öffnen]
Berechtigungen:
writeapi
Benutzung der API mit Schreibzugriff
Gewährt an: all, user, bot
apihighlimits
Höhere Beschränkungen in API-Anfragen verwenden (langsame Anfragen: 500; schnelle Anfragen: 5000). Die Beschränkungen für langsame Anfragen werden auch auf Mehrwertparameter angewandt.
Gewährt an: bot, sysop

Datentypen

Some parameter types in API requests need further explanation:

boolean
Boolean parameters work like HTML checkboxes: if the parameter is specified, regardless of value, it is considered true. For a false value, omit the parameter entirely.
timestamp
Timestamps may be specified in several formats. ISO 8601 date and time is recommended. All times are in UTC, any included timezone is ignored.
  • ISO 8601 date and time, 2001-01-15T14:56:00Z (punctuation and Z are optional)
  • ISO 8601 date and time with (ignored) fractional seconds, 2001-01-15T14:56:00.00001Z (dashes, colons, and Z are optional)
  • MediaWiki format, 20010115145600
  • Generic numeric format, 2001-01-15 14:56:00 (optional timezone of GMT, +##, or -## is ignored)
  • EXIF format, 2001:01:15 14:56:00
  • RFC 2822 format (timezone may be omitted), Mon, 15 Jan 2001 14:56:00
  • RFC 850 format (timezone may be omitted), Monday, 15-Jan-2001 14:56:00
  • C ctime format, Mon Jan 15 14:56:00 2001
  • Seconds since 1970-01-01T00:00:00Z as a 1 to 13 digit integer (excluding 0)
  • The string now

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.

Abgerufen von „http://de.publicdomainproject.org/index.php/Spezial:API-Hilfe“