Nápověda k MediaWiki API
Toto je automaticky generovaná dokumentační stránka k MediaWiki API.
Dokumentace a příklady: https://www.mediawiki.org/wiki/API
Hlavní modul
Stav: Všechny funkce uvedené na této stránce by měly fungovat, ale API se stále aktivně vyvíjí a může se kdykoli změnit. Upozornění na změny získáte přihlášením se k e-mailové konferenci mediawiki-api-announce.
Chybné požadavky: Pokud jsou do API zaslány chybné požadavky, bude vrácena HTTP hlavička s klíčem „MediaWiki-API-Error“ a hodnota této hlavičky a chybový kód budou nastaveny na stejnou hodnotu. Více informací najdete v dokumentaci.
- action
Jaká akce se má provést.
- Jedna hodnota: 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, spamblacklist, stashedit, tag, tokens, unblock, undelete, upload, userrights, watch
- Implicitní hodnota: help
- format
Formát výstupu.
- Jedna hodnota: dbg, dbgfm, dump, dumpfm, json, jsonfm, none, php, phpfm, rawfm, txt, txtfm, wddx, wddxfm, xml, xmlfm, yaml, yamlfm
- Implicitní hodnota: jsonfm
- maxlag
Maximální zpoždění lze použít, když je MediaWiki nainstalováno na cluster s replikovanou databází. Abyste se vyhnuli zhoršování už tak špatného replikačního zpoždění, můžete tímto parametrem nechat klienta čekat, dokud replikační zpoždění neklesne pod uvedenou hodnotu. V případě příliš vysokého zpoždění se vrátí chybový kód „maxlag“ s hlášením typu „Waiting for $host: $lag seconds lagged“.
Více informací najdete v příručce.- smaxage
Nastaví hlavičku
s-maxagena uvedený počet sekund. Chyby se nekešují nikdy.- Implicitní hodnota: 0
- maxage
Nastaví hlavičku
max-agena uvedený počet sekund. Chyby se nekešují nikdy.- Implicitní hodnota: 0
- assert
Pokud je nastaveno na „user“, ověří, že je uživatel přihlášen, pokud je nastaveno na „bot“, ověří, že má oprávnění „bot“.
- Jedna hodnota: user, bot
- requestid
Libovolná zde uvedená hodnota bude zahrnuta v odpovědi. Lze použít pro rozlišení požadavků.
- servedby
Zahrnout do odpovědi název hostitele, který požadavek obsloužil.
- curtimestamp
Zahrnout do odpovědi aktuální časové razítko.
- origin
Pokud k API přistupujete pomocí mezidoménového AJAXového požadavku (CORS), nastavte tento parametr na doménu původu. Musí být součástí všech předběžných požadavků, takže musí být součástí URI požadavku (nikoli těla POSTu). Hodnota musí přesně odpovídat jednomu z původů v hlavičce Origin:, takže musí být nastavena na něco jako http://en.wikipedia.org nebo https://meta.wikimedia.org. Pokud parametr neodpovídá hlavičce Origin:, bude vrácena odpověď 403. Pokud parametr odpovídá hlavičce Origin: a tento původ je na bílé listině, bude nastavena hlavička Access-Control-Allow-Origin.
- uselang
Jazyk, který se má použít pro překlad hlášení. Seznam kódů lze načíst z action=query&meta=siteinfo se siprop=languages, nebo zadejte „user“ pro použití předvoleného jazyka aktuálního uživatele či „content“ pro použití jazyka obsahu této wiki.
- Implicitní hodnota: user
- Nápověda k hlavnímu modulu
- api.php?action=help
- Veškerá nápověda na jedné stránce
- api.php?action=help&recursivesubmodules=1
Zásluhy
Vývojáři API:
- Roan Kattouw (hlavní vývojář září 2007–2009)
- Viktor Vasiljev
- Bryan Tong Minh
- Sam Reed
- Jurij Astrachan (tvůrce, hlavní vývojář září 2006–září 2007)
- Brad Jorsch (hlavní vývojář od 2013)
Své komentáře, návrhy či dotazy posílejte na mediawiki-api@lists.wikimedia.org nebo založte chybové hlášení na https://phabricator.wikimedia.org/.