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
- Zdroj: MediaWiki
- Licence: GPL-2.0-or-later
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.
- action
Která akce se má provést.
- block
- Zablokovat uživatele.
- changeauthenticationdata
- Change authentication data for the current user.
- checktoken
- Check the validity of a token from action=query&meta=tokens.
- clearhasmsg
- Clears the
hasmsgflag 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.
- cspreport
- 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.
- 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.
- 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.
- stashedit
- Prepare an edit in shared cache.
- tag
- Add or remove change tags from individual revisions or log entries.
- unblock
- Unblock a user.
- undelete
- Restore 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.
- tokens
- Zastaralý. Get tokens for data-modifying actions.
- Jedna z následujÃcÃch hodnot: block, changeauthenticationdata, checktoken, clearhasmsg, clientlogin, compare, createaccount, cspreport, delete, edit, emailuser, expandtemplates, 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, setnotificationtimestamp, setpagelanguage, stashedit, tag, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, tokens
- Implicitnà hodnota: help
- format
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Ä).
- Jedna z následujÃcÃch hodnot: json, jsonfm, none, php, phpfm, rawfm, xml, xmlfm
- 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.- Typ: celé ÄÃslo
- smaxage
Nastavà HTTP hlaviÄku pro ÅÃzenà keÅ¡ovánÃ
s-maxagena uvedený poÄet sekund. Chyby se nekeÅ¡ujà nikdy.- Typ: celé ÄÃslo
- Implicitnà hodnota: 0
- maxage
Nastavà HTTP hlaviÄku pro ÅÃzenà keÅ¡ovánÃ
max-agena uvedený poÄet sekund. Chyby se nekeÅ¡ujà nikdy.- Typ: celé ÄÃslo
- 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 z následujÃcÃch hodnot: user, bot
- assertuser
Verify the current user is the named user.
- Type: user name
- 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.
- Typ: boolean (podrobnosti)
- curtimestamp
Zahrnout do odpovÄdi aktuálnà Äasové razÃtko.
- Typ: boolean (podrobnosti)
- responselanginfo
Include the languages used for uselang and errorlang in the result.
- Typ: boolean (podrobnosti)
- 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).
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ÄceOrigin, bude vrácena odpovÄÄ 403. Pokud parametr odpovÃdá hlaviÄceOrigina tento původ je na bÃlé listinÄ, budou nastaveny hlaviÄkyAccess-Control-Allow-OriginaAccess-Control-Allow-Credentials.U neautentizovaných požadavků uveÄte hodnotu *. To způsobà nastavenà hlaviÄky
Access-Control-Allow-Origin, ale hlaviÄkaAccess-Control-Allow-Credentialsbudefalsea budou omezena vÅ¡echna data specifická pro uživatele.- uselang
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.
- Implicitnà hodnota: user
- errorformat
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.
- Jedna z následujÃcÃch hodnot: plaintext, wikitext, html, raw, none, bc
- Implicitnà hodnota: bc
- errorlang
Language to use for warnings and errors. action=query&meta=siteinfo with siprop=languages returns a list of language codes, or specify content to use this wiki's content language, or specify uselang to use the same value as the uselang parameter.
- Implicitnà hodnota: uselang
- errorsuselocal
If given, error texts will use locally-customized messages from the MediaWiki namespace.
- Typ: boolean (podrobnosti)
- NápovÄda k hlavnÃmu modulu
- api.php?action=help [otevÅÃt v pÃskoviÅ¡ti]
- VeÅ¡kerá nápovÄda na jedné stránce
- api.php?action=help&recursivesubmodules=1 [otevÅÃt v pÃskoviÅ¡ti]
Datové typy
Vstupem do MediaWiki by mÄlo být UTF-8 normalizované do NFC. Jiný vstup se MediaWiki může pokusit pÅevést, ale tÃm se může stát, že nÄkteré operace (napÅ. editace s kontrolou MD5) selžou.
NÄkteré typy parametrů v API potÅebujà bližšà vysvÄtlenÃ:
- boolean
- Booleovské parametry fungujà jako zaÅ¡krtávacà polÃÄka v HTML: pokud je parametr uveden, bez ohledu na hodnotu, je považován za pravdivý. Pro nepravdivou hodnotu parametr zcela vynechte.
- Äasová znaÄka
- Äasové znaÄky lze uvádÄt v nÄkolika formátech. DoporuÄuje se datum a Äas podle ISO 8601. VÅ¡echny Äasy jsou v UTC a obsažené Äasové pásmo je ignorováno.
- Datum a Äas podle ISO 8601, 2001-01-15T14:56:00Z (interpunkce a Z jsou nepovinné)
- Datum a Äas podle ISO 8601 s (ignorovaným) zlomkem sekundy, 2001-01-15T14:56:00.00001Z (pomlÄky, dvojteÄky a Z jsou nepovinné)
- Formát MediaWiki, 20010115145600
- Obecný ÄÃselný formát, 2001-01-15 14:56:00 (nepovinné Äasové pásmo GMT, +## nebo -## se ignoruje)
- Formát EXIF, 2001:01:15 14:56:00
- Formát podle RFC 2822 (Äasové pásmo lze vynechat), Mon, 15 Jan 2001 14:56:00
- Formát podle RFC 850 (Äasové pásmo lze vynechat), Monday, 15-Jan-2001 14:56:00
- Formát podle céÄkové funkce ctime, Mon Jan 15 14:56:00 2001
- Sekundy od 1970-01-01T00:00:00Z jako celé ÄÃslo o 1â13 ÄÃslicÃch (s výjimkou 0)
- ÅetÄzec now
- alternativnà oddÄlovaÄ vÃcenásobných hodnot
- Parametry, které pÅijÃmajà nÄkolik hodnot, se zpravidla pÅedávajà s hodnotami oddÄlenými svislÃtkem, napÅ. param=hodnota1|hodnota2 nebo param=hodnota1%7Chodnota2. Pokud musà hodnota obsahovat svislÃtko, použijte jako oddÄlovaÄ znak U+001F (Unit Separator) a pÅed hodnotu pÅidejte U+001F, napÅ. param=%1Fhodnota1%1Fhodnota2.
Šablonované parametry
Å ablonované parametry umožÅujà situace, kdy modul API potÅebuje hodnotu pro každou hodnotu nÄjakého jiného parametru. Pokud by napÅÃklad existoval modul API pro zÃskánà ovoce, mohl by mÃt parametr ovoce, kterým se urÄà požadované druhy ovoce, a Å¡ablonovaný parametr {ovoce}-poÄet, kterým se urÄà požadované poÄty jednotlivých druhů. Klient API, který by chtÄl 1 jablko, 5 banánů a 20 jahod, by mohl vytvoÅit požadavek ovoce=jablka|banány|jahody&jablka-poÄet=1&banány-poÄet=5&jahody-poÄet=20.
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/.