Помош со Извршникот на МедијаВики

Ова е самосоздадена документациска страница за извршникот на МедијаВики.

Документација и примери: https://www.mediawiki.org/wiki/API

Главен модул

Статус: Сите ставки на страницава би требало да работат, но Извршникот сепак е во активна разработка, што значи дека може да се смени во секое време. Објавите за измени можете да ги дознавате ако се пријавите на поштенскиот список „the mediawiki-api-announce“.

Погрешни барања: Кога Извршникот ќе добие погрешни барања, ќе се испрати HTTP-заглавие со клучот „MediaWiki-API-Error“ и потоа на вредностите на заглавието и шифрата на грешката што ќе се појават ќе им биде зададена истата вредност. Повеќе информации ќе најдете на Извршник: Грешки и предупредувања.

Параметри:
action

Кое дејство да се изврши.

block
Блокирај корисник.
changeauthenticationdata
Change authentication data for the current user.
changecontentmodel
Промени го содржинскиот модел на страница
checktoken
Проверка на полноважноста на шифрата од action=query&meta=tokens.
clearhasmsg
Ја отстранува ознаката „hasmsg“ од тековниот корисник.
clientlogin
Log in to the wiki using the interactive flow.
compare
Добивање на разлика помеѓу две страници.
createaccount
Создај нова корисничка сметка.
delete
Избриши страница.
edit
Создај или уреди страници.
emailuser
Испрати е-пошта на корисник.
expandtemplates
Ги проширува сите предлошки во викитекст.
feedcontributions
Дава тековник со придонеси на корисник.
feedrecentchanges
Дава тековник со скорешни промени.
feedwatchlist
Дава тековник со набљудуваните.
filerevert
Врати податотека на претходна верзија.
help
Прикажувај помош за укажаните модули.
imagerotate
Сврти една или повеќе слики.
import
Увези страница од друго вики или од XML-податотека.
linkaccount
Link an account from a third-party provider to the current user.
login
Најавете се и добијте колачиња за заверка.
logout
Одјави се и исчисти ги податоците на седницата.
managetags
Извршување на раководни задачи по промена на ознаки.
mergehistory
Спојување на истории на страници.
move
Премести страница.
opensearch
Пребарување на викито со протоколот OpenSearch.
options
Смени ги нагодувањата на тековниот корисник.
paraminfo
Набави информации за извршнички (API) модули.
parse
Parses content and returns parser output.
patrol
Испатролирај страница или преработка.
protect
Смени го степенот на заштита на страница.
purge
Purge the cache for the given titles.
query
Преземи податоци од и за МедијаВики.
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.
tag
Додавање или отстранување ознаки за промени од поединечни преработки или дневнички записи.
unblock
Одблокирај корисник.
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
Додај или отстрани страници од набљудуваните на тековниот корисник.
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.
stashedit
Внатрешен. Prepare an edit in shared cache.
Една од следниве вредности: 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, cspreport, stashedit
По основно: help
format

Формат на изводот.

json
Давај го изводот во JSON-формат.
jsonfm
Давај го изводот во JSON-формат (подобрен испис во HTML).
none
Не давај извод.
php
Давај го изводот во серијализиран PHP-формат.
phpfm
Давај го изводот во серијализиран PHP-формат (подобрен испис во HTML).
rawfm
Давај го изводот со елементи за отстранување грешки во JSON-формат (подобрен испис во HTML).
xml
Давај го изводот во XML-формат.
xmlfm
Давај го изводот во XML-формат (подобрен испис во HTML).
Една од следниве вредности: json, jsonfm, none, php, phpfm, rawfm, xml, xmlfm
По основно: jsonfm
maxlag

Најголемиот допуштен заостаток може да се користи кога МедијаВики е воспоставен на грозд умножен од базата. За да спречите дополнителни заостатоци од дејства, овој параметар му наложува на клиентот да почека додека заостатокот не се намали под укажаната вредност. Во случај на преголем заостаток, системт ја дава грешката со код maxlag со порака од обликот Го чекам $host: има заостаток од $lag секунди.
Погл. Прирачник: Параметар Maxlag за повеќе информации.

Вид: цел број
smaxage

Задајте му олку секунди на заглавието за контрола HTTP-меѓускладот s-maxage. Грешките никогаш не се чуваат во меѓускладот.

Вид: цел број
По основно: 0
maxage

Задајте му олку секунди на заглавието за контрола HTTP-меѓускладот s-maxage. Грешките никогаш не се чуваат во меѓускладот.

Вид: цел број
По основно: 0
assert

Провери дали корисникот е најавен ако е зададено user или дали го има корисничкото право на бот, ако е зададено bot.

Една од следниве вредности: anon, bot, user
assertuser

Verify the current user is the named user.

Вид: корисник, од корисничко име
requestid

Тука внесената вредност ќе биде вклучена во извештајот. Може да се користи за разликување на барањата.

servedby

Вклучи го домаќинското име што го услужило барањето во исходот.

Type: boolean (details)
curtimestamp

Вклучи тековно време и време и датум во исходот.

Type: boolean (details)
responselanginfo

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

Type: boolean (details)
origin

Кога му пристапувате на Пирлогот користејќи повеќедоменско AJAX-барање (CORS), задајте му го на ова изворниот домен. Ова мора да се вклучи во секое подготвително барање и затоа мора да биде дел од URI на барањето (не главната содржина во POST). Ова мора точно да се совпаѓа со еден од изворниците на заглавието Origin:, така што мора да е зададен на нешто како https://mk.wikipedia.org or https://meta.wikimedia.org. Ако овој параметар не се совпаѓа со заглавието Origin:, ќе се појави одговор 403. Ако се совпаѓа, а изворникот е на бел список (на допуштени), тогаш ќе се зададе заглавието Access-Control-Allow-Origin.

uselang

Јазик за преведување на пораките. action=query&meta=siteinfo со siprop=languages дава список на јазични кодови, или укажете user за да го користите тековно зададениот јазик корисникот, или пак укажете content за да го користите јазикот на содржината на ова вики.

По основно: user
variant

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

errorformat

Format to use for warning and error text output

plaintext
Wikitext with HTML tags removed and entities replaced.
wikitext
Нерасчистен викитекст.
html
HTML
raw
Message key and parameters.
none
Без текстуален излез, само кодови за грешки.
bc
Format used prior to MediaWiki 1.29. errorlang and errorsuselocal are ignored.
Една од следниве вредности: bc, html, none, plaintext, raw, wikitext
По основно: 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.

По основно: uselang
errorsuselocal

If given, error texts will use locally-customized messages from the МедијаВики namespace.

Type: boolean (details)
Примери:
Помош за главниот модул
api.php?action=help [open in sandbox]
Сета помош на една страница
api.php?action=help&recursivesubmodules=1 [open in sandbox]
Дозволи:
writeapi
Можност за запишување во извршникот
Доделена на: all, user и bot
apihighlimits
Употреба на повисоки ограничувања за приложни барања (бавни барања: 500; брзи барања: 5000). Ограничувањата за бавни барања важат и за повеќевредносни параметри.
Доделена на: bot и sysop

Типови на податоци

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

Boolean parameters work like HTML checkboxes: if the parameter is specified, regardless of value, it is considered true. For a false value, omit the parameter entirely.

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.

Признанија

Разработувачи на Извршникот:

  • Роан Катау (главен резработувач од септември 2007 до 2009 г.)
  • Виктор Василев
  • Брајан Тонг Мињ
  • Сем Рид
  • Јуриј Астрахан (создавач, главен разработувач од септември 2006 до септември 2007 г.)
  • Brad Jorsch (главен разработувач од 2013 г. до денес)

Вашите коментари, предлози и прашања испраќајте ги на mediawiki-api@lists.wikimedia.org а грешките пријавувајте ги на https://phabricator.wikimedia.org/.