Pískoviště API

Pomocí této stránky můžete experimentovat s webovými službami MediaWiki API. Podrobnosti využití API najdete v jeho dokumentaci. Příklad: hledání názvů stránek obsahujících určité klíčové slovo. Další příklady uvidíte vybráním parametru action. Uvědomte si, že přestože jste na pískovišti, mohou akce provedené na této stránce wiki změnit.

main

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.

Testování: Pro jednoduché testování požadavků na API zkuste Special:ApiSandbox.

Příklady

Která akce se má provést.

acquiretempusername: Acquire a temporary user username and stash it in the current session, if temp account creation is enabled and the current user is logged out. If a name has already been stashed, returns the same name.
block: Zablokovat uživatele.
cargoautocomplete: Autocompletion call used by the Cargo extension.
cargofields: Fetches all the fields in the specified table
cargoformatparams: Gets the set of display parameters for each Cargo query format.
cargoquery: Runs a query on the Cargo data.
cargoqueryautocomplete: Autocompletion call used by the CargoQuery (previously ViewData) special page.
cargorecreatedata: Re-populates the data in a Cargo table.
cargorecreatespecialtable: Creates a special Cargo table.
cargorecreatetables: Recreates one or more Cargo tables.
cargotables: Fetches all the tables in the system
changeauthenticationdata: Change authentication data for the current user.
changecontentmodel: Change the content model of a page
checktoken: Check the validity of a token from action=query&meta=tokens.
clearhasmsg: Clears the hasmsg flag for the current user.
clientlogin: Log in to the wiki using the interactive flow.
compare: Vrátí rozdíl dvou stránek.
createaccount: Vytvořit nový uživatelský účet.
delete: Smazat stránku.
edit: Vytvářet a upravovat stránky.
emailuser: Poslat uživateli e-mail.
expandtemplates: Rozbalí všechny šablony ve wikitextu.
feedcontributions: Vrátí kanál příspěvků uživatele.
feedrecentchanges: Returns a recent changes feed.
feedwatchlist: Returns a watchlist feed.
filerevert: Revertovat soubor na starší verzi.
help: Zobrazuje nápovědu k uvedeným modulům.
imagerotate: Otočit jeden nebo více obrázků.
import: Import a page from another wiki, or from an XML file.
linkaccount: Link an account from a third-party provider to the current user.
login: Log in and get authentication cookies.
logout: Log out and clear session data.
managetags: Perform management tasks relating to change tags.
mergehistory: Merge page histories.
move: Přesunout stránku.
opensearch: Vyhledávání na wiki pomocí protokolu OpenSearch.
options: Change preferences of the current user.
paraminfo: Obtain information about API modules.
parse: Parses content and returns parser output.
patrol: Patrol a page or revision.
pfautocomplete: Automatické dokončování používané rozšířením Formuláře stránek.
pfautoedit: Vytvořte nebo upravte stránku pomocí formuláře definovaného v rozšíření Formuláře stránek.
protect: Změnit úroveň zamčení stránky.
purge: Purge the cache for the given titles.
query: Fetch data from and about MediaWiki.
removeauthenticationdata: Remove authentication data for the current user.
resetpassword: Send a password reset email to a user.
revisiondelete: Delete and undelete revisions.
rollback: Undo the last edit to the page.
rsd: Export an RSD (Really Simple Discovery) schema.
setnotificationtimestamp: Update the notification timestamp for watched pages.
setpagelanguage: Change the language of a page.
spamblacklist: Validate one or more URLs against the spam block list.
tag: Add or remove change tags from individual revisions or log entries.
unblock: Unblock a user.
undelete: Undelete revisions of a deleted page.
unlinkaccount: Remove a linked third-party account from the current user.
upload: Upload a file, or get the status of pending uploads.
userrights: Change a user's group membership.
validatepassword: Validate a password against the wiki's password policies.
watch: Add or remove pages from the current user's watchlist.
categorytree: Internal. Internal module for the CategoryTree extension.
cspreport: Internal. Used by browsers to report violations of the Content Security Policy. This module should never be used, except when used automatically by a CSP compliant web browser.
editcheckreferenceurl: Internal. Check the status of a URL for use as a reference.
stashedit: Internal. Prepare an edit in shared cache.
visualeditor: Internal. Returns HTML5 for a page from the Parsoid service.
visualeditoredit: Internal. Save an HTML5 page to MediaWiki (converted to wikitext via the Parsoid service).

Formát výstupu.

json: Vypisuje data ve formátu JSON.
jsonfm: Vypisuje data ve formátu JSON (v čitelné HTML podobě).
none: Nevypisuje nic.
php: Vypisuje data v serializačním formátu PHP.
phpfm: Vypisuje data v serializačním formátu PHP (v čitelné HTML podobě).
rawfm: Data včetně ladicích prvků vypisuje ve formátu JSON (v čitelné HTML podobě).
xml: Vypisuje data ve formátu XML.
xmlfm: Vypisuje data ve formátu XML (v čitelné HTML podobě).

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.

Nastaví HTTP hlavičku pro řízení kešování s-maxage na uvedený počet sekund. Chyby se nekešují nikdy.

The value must be no less than 0.

Nastaví HTTP hlavičku pro řízení kešování max-age na uvedený počet sekund. Chyby se nekešují nikdy.

The value must be no less than 0.

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“.

Ověřit, že současným uživatelem je uvedený uživatel.

Libovolná zde uvedená hodnota bude zahrnuta v odpovědi. Lze použít pro rozlišení požadavků.

Zahrnout do odpovědi název hostitele, který požadavek obsloužil.

Zahrnout do odpovědi aktuální časové razítko.

Include the languages used for uselang and errorlang in the result.

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).

U autentizovaných požadavků hodnota musí přesně odpovídat jednomu z původů v hlavičce Origin, takže musí být nastavena na něco jako https://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ě, budou nastaveny hlavičky Access-Control-Allow-Origin a Access-Control-Allow-Credentials.

U neautentizovaných požadavků uveďte hodnotu *. To způsobí nastavení hlavičky Access-Control-Allow-Origin, ale hlavička Access-Control-Allow-Credentials bude false a budou omezena všechna data specifická pro uživatele.

Jazyk, který se má použít pro překlad hlášení. Pomocí action=query&meta=siteinfo se siprop=languages získáte seznam jazykových kódů 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.

Variant of the language. Only works if the base language supports variant conversion.

Format to use for warning and error text output

plaintext: Wikitext with HTML tags removed and entities replaced.
wikitext: Unparsed wikitext.
html: HTML
raw: Message key and parameters.
none: No text output, only the error codes.
bc: Format used prior to MediaWiki 1.29. errorlang and errorsuselocal are ignored.

Language to use for warnings and errors. action=query&meta=siteinfo&siprop=languages returns a list of language codes. Specify content to use this wiki's content language or uselang to use the same value as the uselang parameter.

If given, error texts will use locally-customized messages from the MediaWiki namespace.

Speciální