Справка MediaWiki API
This is an auto-generated MediaWiki API documentation page.
Documentation and examples: https://www.mediawiki.org/wiki/API
Главный модуль
- Источник: MediaWiki
- Лицензия: GPL-2.0+
Статус: Все отображаемые на этой странице функции должны работать, однако API находится в статусе активной разработки и может измениться в любой момент. Подпишитесь на почтовую рассылку mediawiki-api-announce, чтобы быть в курсе обновлений.
Ошибочные запросы: Если API получает запрос с ошибкой, вернётся заголовок HTTP с ключом «MediaWiki-API-Error», после чего значение заголовка и код ошибки будут отправлены обратно и установлены в то же значение. Более подробную информацию см. API: Ошибки и предупреждения.
Тестирование: для удобства тестирования API-запросов, см. Special:ApiSandbox.
- action
Действие, которое следует выполнить.
- Одно из следующих значений: 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, tokens, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch
- По умолчанию: help
- format
Формат вывода.
- Одно из следующих значений: json, jsonfm, none, php, phpfm, rawfm, xml, xmlfm
- По умолчанию: jsonfm
- maxlag
Значение максимального отставания может использоваться, когда MediaWiki устанавливается на кластер из реплицируемых баз данных. Чтобы избежать ухудшения ситуации с отставанием репликации сайта, этот параметр может заставить клиента ждать, когда задержка репликации станет ниже указанного значения. В случае чрезмерной задержки возвращается код ошибки «maxlag» с сообщением «Waiting for $host: $lag seconds lagged».
См. подробнее на странице с описанием Manual: параметра Maxlag .- Тип: integer
- smaxage
Устанавливает значение HTTP-заголовка Cache-Control
s-maxage
в заданное число секунд. Ошибки никогда не кэшируются.- Тип: integer
- По умолчанию: 0
- maxage
Устанавливает значение HTTP-заголовка Cache-Control
s-maxage
в заданное число секунд. Ошибки никогда не кэшируются.- Тип: integer
- По умолчанию: 0
- assert
Удостовериться, что пользователь авторизован, если задано user, или что имеет права бота, если задано bot.
- Одно из следующих значений: user, bot
- assertuser
Убедитесь, что текущий пользователь является именем пользователя.
- Тип: user name
- requestid
Любое заданное здесь значение будет включено в ответ. Может быть использовано для различения запросов.
- servedby
Включить в результаты имя хоста, обработавшего запрос.
- Тип: двоичный (details)
- curtimestamp
Включить в результаты временную метку.
- Тип: двоичный (details)
- responselanginfo
Include the languages used for uselang and errorlang in the result.
- Тип: двоичный (details)
- origin
При обращении к API, используя кросс-доменный AJAX-запрос (CORS), задайте параметру значение исходного домена. Он должен быть включён в любой предварительный запрос и таким образом должен быть частью URI-запроса (не тела POST).
Для аутентифицированных запросов он должен точно соответствовать одному из источников в заголовке
Origin
, так что он должен быть задан наподобие https://ru.wikipedia.org или https://meta.wikimedia.org. Если параметр не соответствует заголовкуOrigin
, будет возвращён ответ с кодом ошибки 403. Если параметр соответствует заголовкуOrigin
, и источник находится в белом списке, будут установлены заголовкиAccess-Control-Allow-Origin
иAccess-Control-Allow-Credentials
.Для неаутентифицированных запросов укажите значение *. Это приведёт к установке заголовка
Access-Control-Allow-Origin
заголовка должен быть установлен, ноAccess-Control-Allow-Credentials
примет значениеfalse
и все пользовательские данные будут ограничены.- uselang
Язык, используемый для перевода сообщений. Запрос «action=query&meta=siteinfo» с «siprop=languages» возвращает список кодов языков; укажите «user», чтобы использовать текущие языковые настройки пользователя, или «content» для использования основного языка этой вики.
- По умолчанию: 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.
- Одно из следующих значений: plaintext, wikitext, html, raw, none, bc
- По умолчанию: bc
- errorlang
Язык, используемый для вывода предупреждений и сообщений об ошибках. Запрос «action=query&meta=siteinfo» с «siprop=languages» возвращает список кодов языков; укажите «content» для использования основного языка этой вики, или «uselang» для использования того же значения, что и в параметре «uselang».
- По умолчанию: uselang
- errorsuselocal
If given, error texts will use locally-customized messages from the MediaWiki namespace.
- Тип: двоичный (details)
- Помощь по главному модулю.
- api.php?action=help [open in sandbox]
- Вся справка в одном разделе.
- api.php?action=help&recursivesubmodules=1 [open in sandbox]
Типы данных
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.
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.
- timestamp
- Timestamps may be specified in several formats. ISO 8601 date and time is recommended. All times are in UTC, any included timezone is ignored.
- ISO 8601 date and time, 2001-01-15T14:56:00Z (punctuation and Z are optional)
- ISO 8601 date and time with (ignored) fractional seconds, 2001-01-15T14:56:00.00001Z (dashes, colons, and Z are optional)
- MediaWiki format, 20010115145600
- Generic numeric format, 2001-01-15 14:56:00 (optional timezone of GMT, +##, or -## is ignored)
- EXIF format, 2001:01:15 14:56:00
- RFC 2822 format (timezone may be omitted), Mon, 15 Jan 2001 14:56:00
- RFC 850 format (timezone may be omitted), Monday, 15-Jan-2001 14:56:00
- C ctime format, Mon Jan 15 14:56:00 2001
- Seconds since 1970-01-01T00:00:00Z as a 1 to 13 digit integer (excluding 0)
- The string now
- alternative multiple-value separator
- 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.
Создатели
API developers:
- Yuri Astrakhan (creator, lead developer Sep 2006–Sep 2007)
- Roan Kattouw (lead developer Sep 2007–2009)
- Victor Vasiliev
- Bryan Tong Minh
- Sam Reed
- Brad Jorsch (lead developer 2013–present)
Please send your comments, suggestions and questions to mediawiki-api@lists.wikimedia.org or file a bug report at https://phabricator.wikimedia.org/.