MediaWiki API súgó
Ez egy automatikusan generált MediaWiki-API-dokumentációs lap.
Dokumentáció és példák: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
Fő modul
- Forrás: MediaWiki
- Licenc: GPL-2.0-or-later
Állapot: A MediaWiki API egy érett és stabil interfész, ami aktív támogatásban és fejlesztésben részesül. Bár próbáljuk elkerülni, de néha szükség van visszafelé nem kompatibilis változtatásokra; iratkozz fel a mediawiki-api-announce levelezőlistára a frissítések követéséhez.
Hibás kérések: Ha az API hibás kérést kap, egy HTTP-fejlécet küld vissza „MediaWiki-API-Error” kulccsal, és a fejléc értéke és a visszaküldött hibakód ugyanarra az értékre lesz állítva. További információért lásd: API: Hibák és figyelmeztetések.
Tesztelés: Az API-kérések könnyebb teszteléséhez használható az API-homokozó.
- action
Milyen műveletet hajtson végre.
- abusefiltercheckmatch
- Check to see if an AbuseFilter matches a set of variables, an edit, or a logged AbuseFilter event.
- abusefilterchecksyntax
- Egy Vandálszűrő szintaxisának ellenőrzése.
- abusefilterevalexpression
- Evaluates an AbuseFilter expression.
- abusefilterunblockautopromote
- Unblocks a user from receiving autopromotions due to an abusefilter consequence.
- abuselogprivatedetails
- View private details of an AbuseLog entry.
- antispoof
- Check a username against AntiSpoof's normalisation checks.
- block
- Szerkesztő blokkolása
- changeauthenticationdata
- Change authentication data for the current user.
- changecontentmodel
- Change the content model of a page
- checktoken
- Egy action=query&meta=tokens kéréssel szerzett token érvényességének vizsgálata.
- clearhasmsg
- A
hasmsg
jelzés törlése az aktuális felhasználónak. - clientlogin
- Log in to the wiki using the interactive flow.
- compare
- Két lap közötti különbség kiszámítása.
- createaccount
- Ez a modul le lett tiltva.
- delete
- Lap törlése.
- echomarkread
- A jelenlegi felhasználó értesítéseinek olvasottnak jelölése.
- echomarkseen
- Értesítések látottnak jelölése az aktuális felhasználó számára.
- echomute
- Értesítések némítása vagy engedélyezése bizonyos felhasználóktól vagy bizonyos lapokhoz kapcsolódóan.
- edit
- Lapok létrehozása és szerkesztése.
- emailuser
- E-mail küldése
- expandtemplates
- Minden sablon kibontása a wikiszövegben.
- feedcontributions
- Egy felhasználó közreműködéseinek lekérése hírcsatornaként.
- feedrecentchanges
- A friss változtatások lekérése hírcsatornaként.
- feedwatchlist
- A figyelőlista lekérése hírcsatornaként.
- filerevert
- Egy fájl visszaállítása egy régebbi verzióra.
- help
- Súgó megjelenítése a megadott modulokhoz.
- imagerotate
- Egy vagy több kép elforgatása.
- import
- Egy lap importálása egy másik wikiből vagy XML-fájlból.
- linkaccount
- Egy harmadik fél szolgáltató fiókjának kapcsolása a jelenlegi felhasználóhoz.
- login
- Bejelentkezés és hitelesítő sütik lekérése.
- logout
- Kijelentkezés és munkamenetadatok törlése.
- managetags
- A változtatáscímkék kezelése.
- mergehistory
- Laptörténetek egyesítése
- move
- Egy lap átnevezése.
- opensearch
- Keresés a wikin az OpenSearch protokoll segítségével.
- options
- A jelenlegi felhasználó beállításainak módosítása.
- paraminfo
- Információk lekérése API-modulokról.
- parse
- Tartalom feldolgozása.
- patrol
- Egy lap vagy lapváltozat ellenőrzöttnek jelölése (patrol).
- pollsubmitvote
- AJAXPoll API module
- problemreportsgetform
- Fetch the HTML of the "report a problem" dialog.
- problemreportupdate
- Update or delete a problem report.
- protect
- Egy lap védelmi szintjének változtatása.
- purge
- A gyorsítótár ürítése a megadott lapoknál.
- query
- Adatok lekérése a MediaWikiből és a MediaWikiről.
- regexblock
- Block users' names and IP addresses via regular expressions.
- regexunblock
- Unblock users' names and IP addresses via regular expressions.
- removeauthenticationdata
- A jelenlegi felhasználó hitelesítési adatainak eltávolítása.
- reportproblem
- Report a problem with a wiki page.
- resetpassword
- Jelszó-visszaállító e-mail küldése a felhasználónak.
- revisiondelete
- Változatok törlése és helyreállítása.
- rollback
- A lap legutóbbi változtatásának visszavonása.
- rsd
- Egy RSD-séma (Really Simple Discovery) exportálása.
- setnotificationtimestamp
- A figyelt lapok értesítési időbélyegének frissítése.
- setpagelanguage
- Egy lap nyelvének módosítása.
- spamblacklist
- Validate one or more URLs against the SpamBlacklist.
- spamregex
- Add entries to SpamRegex or remove already blocked entries from it.
- tag
- Add or remove change tags from individual revisions or log entries.
- templatedata
- A TemplateData kiterjesztés által tárolt adatok lekérdezése.
- thank
- Köszönet küldése egy szerkesztőnek.
- themelist
- Get the list of all skins and their themes
- titleblacklist
- Validate a page title, filename, or username against the TitleBlacklist.
- 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.
- webapp-manifest
- Returns a webapp manifest.
- mobileview
- Elavult. A mobil nézetekhez szükséges adatokat adja vissza.
- tokens
- Elavult. Get tokens for data-modifying actions.
- categorytree
- Belső. A CategoryTree kiterjesztés belső modulja.
- cspreport
- Belső. 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.
- scribunto-console
- Belső. Belső modul a Scribunto konzolról érkező XHR-kérések kiszolgálására.
- stashedit
- Belső. Egy szerkesztés előkészítése a megosztott gyorsítótárban.
- visualeditor
- Belső. A Parsoid szolgáltatástól kapott oldalból HTML5 oldalt készít.
- visualeditoredit
- Belső. HTML5 oldal elmentése a wikiben (a Parsoid szolgáltatással wikiszöveggé konvertálva).
- A következő értékek egyike: abusefiltercheckmatch, abusefilterchecksyntax, abusefilterevalexpression, abusefilterunblockautopromote, abuselogprivatedetails, antispoof, block, changeauthenticationdata, changecontentmodel, checktoken, clearhasmsg, clientlogin, compare, createaccount, delete, echomarkread, echomarkseen, echomute, edit, emailuser, expandtemplates, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, help, imagerotate, import, linkaccount, login, logout, managetags, mergehistory, move, opensearch, options, paraminfo, parse, patrol, pollsubmitvote, problemreportsgetform, problemreportupdate, protect, purge, query, regexblock, regexunblock, removeauthenticationdata, reportproblem, resetpassword, revisiondelete, rollback, rsd, setnotificationtimestamp, setpagelanguage, spamblacklist, spamregex, tag, templatedata, thank, themelist, titleblacklist, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, webapp-manifest, mobileview, tokens, categorytree, cspreport, scribunto-console, stashedit, visualeditor, visualeditoredit
- Alapértelmezett: help
- format
A kimenet formátuma.
- json
- Output data in JSON format.
- jsonfm
- Output data in JSON format (pretty-print in HTML).
- none
- Output nothing.
- php
- Output data in serialized PHP format.
- phpfm
- Output data in serialized PHP format (pretty-print in HTML).
- rawfm
- Output data, including debugging elements, in JSON format (pretty-print in HTML).
- xml
- Output data in XML format.
- xmlfm
- Output data in XML format (pretty-print in HTML).
- A következő értékek egyike: json, jsonfm, none, php, phpfm, rawfm, xml, xmlfm
- Alapértelmezett: jsonfm
- maxlag
Maximum lag can be used when MediaWiki is installed on a database replicated cluster. To save actions causing any more site replication lag, this parameter can make the client wait until the replication lag is less than the specified value. In case of excessive lag, error code maxlag is returned with a message like Waiting for $host: $lag seconds lagged.
See Manual: Maxlag parameter for more information.- Típus: egész szám
- smaxage
Az
s-maxage
gyorsítótár-vezérlő HTTP-fejléc beállítása ennyi másodpercre. A hibák soha nincsenek gyorsítótárazva.- Típus: egész szám
- Alapértelmezett: 0
- maxage
Az
maxage
gyorsítótár-vezérlő HTTP-fejléc beállítása ennyi másodpercre. A hibák soha nincsenek gyorsítótárazva.- Típus: egész szám
- Alapértelmezett: 0
- assert
Annak ellenőrzése, hogy a felhasználó be van-e jelentkezve user érték esetén, illetve ki van-e jelentkezve anon esetén, vagy botjog ellenőrzése bot érték esetén.
- A következő értékek egyike: anon, bot, user
- assertuser
Annak ellenőrzése, hogy a jelenlegi felhasználó a megadott-e.
- Típus: felhasználó, felhasználónév segítségével megadva
- requestid
Az itt megadott bármilyen érték szerepelni fog a válaszban. Több kérés megkülönböztetésére használható.
- servedby
Tartalmazza a válasz kérést kiszolgáló gép nevét.
- Típus: logikai (részletek)
- curtimestamp
Tartalmazza a válasz az aktuális időbélyeget.
- Típus: logikai (részletek)
- responselanginfo
A válasz tartalmazza uselang és errorlang paraméterekben használt nyelveket.
- Típus: logikai (részletek)
- origin
When accessing the API using a cross-domain AJAX request (CORS), set this to the originating domain. This must be included in any pre-flight request, and therefore must be part of the request URI (not the POST body).
For authenticated requests, this must match one of the origins in the
Origin
header exactly, so it has to be set to something like https://en.wikipedia.org or https://meta.wikimedia.org. If this parameter does not match theOrigin
header, a 403 response will be returned. If this parameter matches theOrigin
header and the origin is whitelisted, theAccess-Control-Allow-Origin
andAccess-Control-Allow-Credentials
headers will be set.For non-authenticated requests, specify the value *. This will cause the
Access-Control-Allow-Origin
header to be set, butAccess-Control-Allow-Credentials
will befalse
and all user-specific data will be restricted.- uselang
Az üzenetfordításokhoz használandó nyelv. A action=query&meta=siteinfo a siprop=languages paraméterrel visszaadja a lehetséges nyelvkódok listáját, vagy user az aktuális felhasználó, illetve content a wiki nyelvbeállításához.
- Alapértelmezett: user
- errorformat
A figyelmeztetések és hibaüzenetek formátuma.
- plaintext
- Wikiszöveg eltávolított HTML-címkékkel és a HTML-entitások (pl. &) kicserélésével.
- wikitext
- Feldolgozatlan wikiszöveg.
- html
- HTML.
- raw
- Az üzenet azonosítója és paraméterei.
- none
- Szöveges kimenet mellőzése, csak hibakódok.
- bc
- A MediaWiki 1.29 előtti formátum. A errorlang és erroruselocal paraméterek figyelmen kívül lesznek hagyva.
- A következő értékek egyike: bc, html, none, plaintext, raw, wikitext
- Alapértelmezett: bc
- errorlang
A figyelmeztetésekhez és hibaüzenetekhez használandó nyelv. A action=query&meta=siteinfo a siprop=languages paraméterrel visszaadja a lehetséges nyelvkódok listáját, vagy content a wiki nyelvbeállításához, illetve uselang a uselang paraméter értékéhez.
- Alapértelmezett: uselang
- errorsuselocal
Ha meg van adva, a hibaüzenetek a helyileg testreszabott üzeneteket fogják használni a MediaWiki névtérből.
- Típus: logikai (részletek)
- Súgó megjelenítése a fő modulhoz.
- api.php?action=help [megnyitás a homokozóban]
- Minden súgó egy lapon.
- api.php?action=help&recursivesubmodules=1 [megnyitás a homokozóban]
Adattípusok
Input to MediaWiki should be NFC-normalized UTF-8. MediaWiki may attempt to convert other input, but this may cause some operations (such as edits with MD5 checks) to fail.
Parameters that take multiple values are normally submitted with the values separated using the pipe character, e.g. param=value1|value2 or param=value1%7Cvalue2. If a value must contain the pipe character, use U+001F (Unit Separator) as the separator and prefix the value with U+001F, e.g. param=%1Fvalue1%1Fvalue2.
Some parameter types in API requests need further explanation:
- boolean
A logikai paraméterek a HTML jelölőnégyzeteihez hasonlóan működnek: ha a paraméter meg van adva, az igazat jelent, függetlenül a paraméter értékétől. Hamis értékhez hagyd el a paramétert teljesen.
- expiry
Expiry values may be relative (e.g. 5 months or 2 weeks) or absolute (e.g. 2014-09-18T12:34:56Z). For no expiry, use infinite, indefinite, infinity or never.
- timestamp
Timestamps may be specified in several formats, see the Timestamp library input formats documented on mediawiki.org for details. ISO 8601 date and time is recommended: 2001-01-15T14:56:00Z. Additionally, the string now may be used to specify the current timestamp.
Templated parameters
Templated parameters support cases where an API module needs a value for each value of some other parameter. For example, if there were an API module to request fruit, it might have a parameter fruits to specify which fruits are being requested and a templated parameter {fruit}-quantity to specify how many of each fruit to request. An API client that wants 1 apple, 5 bananas, and 20 strawberries could then make a request like fruits=apples|bananas|strawberries&apples-quantity=1&bananas-quantity=5&strawberries-quantity=20.
Készítők
API-fejlesztők:
- Jurij Asztrahan (készítő, vezető fejlesztő 2006 szeptemberétől 2007 szeptemberéig)
- Roan Kattouw (vezető fejlesztő 2007 szeptemberétől 2009-ig)
- Viktor Vasziljev
- Bryan Tong Minh
- Sam Reed
- Brad Jorsch (vezető fejlesztő 2013-tól)
A megjegyzéseidet, javaslataidat és kérdéseidet a mediawiki-api@lists.wikimedia.org címre küldheted, vagy készíthetsz egy hibajelentést a https://phabricator.wikimedia.org/ oldalon.