Справка MediaWiki API
This is an auto-generated MediaWiki API documentation page.
Documentation and examples: https:/wiki/API
Главный модуль
- Источник: MediaWiki
- Лицензия: GPL-2.0+
- Документация
- ЧаВО
- Почтовая рассылка
- Новости API
- Ошибки и запросы
Статус: Все отображаемые на этой странице функции должны работать, однако API находится в статусе активной разработки, и может измениться в любой момент. Подпишитесь на почтовую рассылку mediawiki-api-announce, чтобы быть в курсе обновлений.
Ошибочные запросы: Если API получает запрос с ошибкой, вернётся заголовок HTTP с ключом "MediaWiki-API-Error", после чего значение заголовка и код ошибки будут отправлены обратно и установлены в то же значение. Более подробную информацию см. API: Ошибки и предупреждения.
- action
-
Действие, которое следует выполнить.
- One value: block, checktoken, clearhasmsg, compare, createaccount, delete, edit, emailuser, expandtemplates, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, help, imagerotate, import, login, logout, managetags, move, opensearch, options, paraminfo, parse, patrol, protect, purge, query, revisiondelete, rollback, rsd, setnotificationtimestamp, stashedit, tag, tokens, unblock, undelete, upload, userrights, watch
- По умолчанию: help
- format
-
Формат вывода.
- One value: dbg, dbgfm, json, jsonfm, none, php, phpfm, rawfm, txt, txtfm, xml, xmlfm, yaml, yamlfm
- По умолчанию: 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. - Тип: integer
- smaxage
-
Устанавливает значение HTTP-заголовка Cache-Control
s-maxage
в заданное число секунд. Ошибки никогда не кэшируются. - Тип: integer
- По умолчанию: 0
- maxage
-
Устанавливает значение HTTP-заголовка Cache-Control
s-maxage
в заданное число секунд. Ошибки никогда не кэшируются. - Тип: integer
- По умолчанию: 0
- assert
-
Удостовериться, что пользователь авторизован, если задано user, или что имеет права бота, если задано bot.
- One value: user, bot
- requestid
-
Любое заданное здесь значение будет включено в ответ. Может быть использовано для различения запросов.
- servedby
-
Включить в результаты имя хоста, обработавшего запрос.
- Тип: двоичный (details)
- curtimestamp
-
Включить в результаты временную метку.
- Тип: двоичный (details)
- origin
-
При обращении к API, используя кросс-доменный AJAX-запрос (CORS), задайте параметру значение исходного домена. Он должен быть включён в любой предварительный запрос и таким образом должен быть частью URI-запроса (не тела POST). Он должен точно соответствовать одному из источников в заголовке
Origin<code>, так что он должен быть задан наподобие https://ru.wikipedia.org или https://meta.wikimedia.org. Если параметр не соответствует заголовку <code>Origin<code>, будет возвращён ответ с кодом ошибки 403. Если параметр соответствует заголовку <code>Origin
, и источник находится в белом списке, будет установлен заголовокAccess-Control-Allow-Origin
. - uselang
-
Language to use for message translations. A list of codes may be fetched from action=query&meta=siteinfo with siprop=languages, or specify user to use the current user's language preference, or specify content to use this wiki's content language.
- По умолчанию: user
- Помощь по главному модулю.
- api.php?action=help
- Вся справка в одном разделе.
- api.php?action=help&recursivesubmodules=1
Типы данных
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
Создатели
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 [email protected] or file a bug report at https://phabricator.wikimedia.org/.