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/API
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.
- 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
hasmsgjelzé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
- Ãj felhasználói fiók létrehozása.
- delete
- Lap törlése.
- 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).
- 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.
- removeauthenticationdata
- A jelenlegi felhasználó hitelesÃtési adatainak eltávolÃtása.
- 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.
- 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
- Elavult. Get tokens for data-modifying actions.
- 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.
- stashedit
- BelsÅ. Egy szerkesztés elÅkészÃtése a megosztott gyorsÃtótárban.
- A következŠértékek egyike: block, changeauthenticationdata, changecontentmodel, checktoken, clearhasmsg, clientlogin, compare, createaccount, 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, tag, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, tokens, cspreport, stashedit
- Default: 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
- Default: 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.- Type: integer
- smaxage
Az
s-maxagegyorsÃtótár-vezérlÅ HTTP-fejléc beállÃtása ennyi másodpercre. A hibák soha nincsenek gyorsÃtótárazva.- Type: integer
- Default: 0
- maxage
Az
maxagegyorsÃtótár-vezérlÅ HTTP-fejléc beállÃtása ennyi másodpercre. A hibák soha nincsenek gyorsÃtótárazva.- Type: integer
- Default: 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
Originheader 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 theOriginheader, a 403 response will be returned. If this parameter matches theOriginheader and the origin is whitelisted, theAccess-Control-Allow-OriginandAccess-Control-Allow-Credentialsheaders will be set.For non-authenticated requests, specify the value *. This will cause the
Access-Control-Allow-Originheader to be set, butAccess-Control-Allow-Credentialswill befalseand 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.
- Default: 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
- Default: 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.
- Default: 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 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 [email protected] cÃmre küldheted, vagy készÃthetsz egy hibajelentést a https://phabricator.wikimedia.org/ oldalon.