MediaWiki API help

This is an auto-generated MediaWiki API documentation page.

Documentation and examples: https://www.mediawiki.org/wiki/API

Главный модуль

Status: All features shown on this page should be working, but the API is still in active development, and may change at any time. Subscribe to the mediawiki-api-announce mailing list for notice of updates.

Erroneous requests: When erroneous requests are sent to the API, an HTTP header will be sent with the key "MediaWiki-API-Error" and then both the value of the header and the error code sent back will be set to the same value. For more information see API: Errors and warnings.

Параметры:
action

Действие, которое следует выполнить.

One value: aggregategroups, block, checktoken, cirrus-config-dump, cirrus-mapping-dump, cirrus-settings-dump, clearhasmsg, compare, createaccount, delete, edit, emailuser, expandtemplates, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, flagconfig, geocode, groupreview, hardmessages, help, imagerotate, import, languagesearch, login, logout, managetags, move, opensearch, options, paraminfo, parse, patrol, protect, purge, query, review, reviewactivity, revisiondelete, rollback, rsd, scribunto-console, setnotificationtimestamp, stabilize, stashedit, tokens, translatesandbox, translateuser, translationaids, translationreview, translationstash, ttmserver, ulslocalization, unblock, undelete, upload, userrights, visualeditor, visualeditoredit, watch
По умолчанию: help
format

Формат вывода.

One value: dbg, dbgfm, dump, dumpfm, json, jsonfm, none, php, phpfm, rawfm, txt, txtfm, wddx, wddxfm, 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.

smaxage

Устанавливает заголовок s-maxage в заданное число секунд. Ошибки никогда не кэшируются.

По умолчанию: 0
maxage

Устанавливает заголовок max-age в заданное число секунд. Ошибки никогда не кэшируются.

По умолчанию: 0
assert

Удостовериться, что пользователь авторизован, если задано "user", или что имеет права бота, если задано "bot".

One value: user, bot
requestid

Любое значение, заданное здесь, будет включено в ответ. Может быть использовано для различения запросов.

servedby

Включить в результаты имя хоста, обработавшего запрос.

curtimestamp

Включить в результаты временную метку.

origin

При обращении к API, используя кросс-доменный AJAX запрос (CORS), задайте параметру значение исходного домена. Он должен быть включён в любой предварительный запрос и таким образом должен быть частью URI запроса (не тела POST). Он должен точно соответствовать одному из источников в заголовке Origin:, так что он должен быть задан наподобие http://en.wikipedia.org или https://meta.wikimedia.org. Если параметр не соответствует заголовку Origin:, будет возвращён ответ с кодом ошибки 403. Если параметр соответствует заголовку 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
Примеры:
Help for the main module.
api.php?action=help
All help in one page.
api.php?action=help&recursivesubmodules=1
Permissions:
writeapi
использование API для записи
Granted to: user, bot
apihighlimits
Use higher limits in API queries (slow queries: 500; fast queries: 5000). The limits for slow queries also apply to multivalue parameters.
Granted to: bot, sysop

Создатели

API developers:

  • Roan Kattouw (lead developer Sep 2007–2009)
  • Victor Vasiliev
  • Bryan Tong Minh
  • Sam Reed
  • Yuri Astrakhan (creator, lead developer Sep 2006–Sep 2007)
  • 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/.