Справка MediaWiki API

Это автоматически сгенерированная страница документации MediaWiki API.

Документация и примеры: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

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

Источник: MediaWiki
Лицензия: GPL-2.0-or-later

//lists.wikimedia.org/postorius/lists/mediawiki-api.lists.wikimedia.org/Почта таратыу]

[https

//lists.wikimedia.org/postorius/lists/mediawiki-api-announce.lists.wikimedia.org/ API яңылыҡтары]

[https

//phabricator.wikimedia.org/maniphest/query/GebfyV4uCaLd/#R Хаталар һәм һорауҙар]

Статус: Был биттә күрһәтелгән бар функциялар ҙа эшләргә тейеш, шулай ҙа API әүҙем эшкәртеү хәлендә тора һәм теләгән бер ваҡытта үҙгәрергә мөмкин. Яңыртылыуҙарҙы һәр саҡ белеп торор өсөн почта таратыу mediawiki-api-announce, ошоға яҙыл.

Хаталы һоратыуҙар: Әгәр API хаталы һоратыу алһа, HTTP баш һүҙе «MediaWiki-API-Error» асҡысы менән кире ҡайтарыла, бынан һуң баш һүҙҙең мәғәнәһе һәм хата коды кире ебәреләсәк һәм кире шул уҡ мәғәнәлә кире ҡуйыласаҡ. Киңерәк мәғлүмәтте ошонан ҡара API: Хаталар һәм иҫкәртеүҙәр.

Тестлау: API-һоратыуҙарҙы тестлау уңайлы булһын өсөн ҡара. Special:ApiSandbox

Определённые параметры:

action

Үтәлергә тейешле ғәмәлдәр.

acquiretempusername: Получить временное имя пользователя и сохраните его в текущем сеансе, если создание временной учетной записи включено и текущий пользователь вышел из системы. Если имя уже сохранено, возвращается то же имя.
block: Ҡатнашыусыны бикләү.
changeauthenticationdata: Смена параметров аутентификации для текущего участника.
changecontentmodel: Изменить модель содержимого страницы
checktoken: action=query&meta=tokens токенының дөрөҫлөгөн тикшерегеҙ.
clearhasmsg: Ағымдағы ҡатнашыусының hasmsg флагын таҙарта.
clientlogin: Вход в вики с помощью интерактивного потока.
compare: Ике бит араһындағы айырма алыу.
createaccount: Ҡатнашыусыларҙың яңы иҫәп яҙмаларын булдырыу.
delete: Битте юйырға.
edit: Биттәрҙе төҙөргә һәм мөхәррирләргә.
emailuser: Ҡатнашыусыға хат.
expandtemplates: wikitext ҡалыптарын аса.
feedcontributions: Ҡатнашыусылар өлөшө менән теҙмәне ҡайтара.
feedrecentchanges: Һуңғы үҙгәрештәр теҙмәһен ҡайтара.
feedwatchlist: Күҙәтеү каналын ҡайтара.
filerevert: Файлды иҫке өлгөһөнә ҡайтарырға.
help: Күрһәтелгән модулдәр белешмәһен күрһәтергә.
imagerotate: Бер йәки бер нисә һүрәтте бороу.
import: Импорт страницы из другой вики или XML-файла.
linkaccount: Связать учётную запись третьей стороны с текущим участником.
login: Вход и получение аутентификационных файлов cookie.
logout: Сығырға һәм сессия мәғлүмәтен юйырға.
managetags: Тамғаларҙы үҙгәртеүгә бәйле мәсьәләләрҙе тормошҡа ашырыу.
mergehistory: Үҙгәртеүҙәр тарихын берләштереү.
move: Биттең исемен үҙгәртергә.
opensearch: OpenSearch протоколын ҡулланып, вики буйынса эҙләү.
options: Смена настроек текущего участника.
paraminfo: API модуле тураһында мәғлүмәт алырға.
parse: Парсит содержимое и возвращает результат парсинга.
patrol: Патрулирование страницы или версии.
protect: Битте һаҡлау кимәлен үҙгәртергә.
purge: Очистка кэша заданных страниц.
query: Запросить данные с и о MediaWiki.
removeauthenticationdata: Удаление аутентификационных данных для текущего участника.
resetpassword: Отправить участнику письмо для сброса пароля.
revisiondelete: Удаление и восстановление версий страниц.
rollback: Отмена последней правки на странице.
rsd: Экспорт схемы RSD (Really Simple Discovery).
setnotificationtimestamp: Обновление временной метки уведомления для отслеживаемых страниц.
setpagelanguage: Изменить язык страницы.
tag: Добавление или удаление меток отдельных правок или записей журналов.
unblock: Разблокировка участника.
undelete: Восстановление версий удалённой страницы.
unlinkaccount: Удаление связанного стороннего аккаунта с текущим участником.
upload: Загрузка файла или получение статуса незавершённых загрузок.
userrights: Изменение групп участника.
validatepassword: Проверка пароля на удовлетворение политики вики.
watch: Добавление или удаление страниц из списка наблюдения текущего участника.
cspreport: Внутренний. Используется браузерами, чтобы сообщать о нарушениях политики безопасности (CSP). Этот модуль никогда не должен использоваться, за исключением случаев автоматического использования совместимыми с CSP браузерами.
stashedit: Внутренний. Подготовка правки в общем кэше.

Одно из следующих значений: acquiretempusername, 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

Значение максимального отставания может использоваться, когда MediaWiki установлена на кластер из реплицируемых баз данных. Чтобы избежать ухудшения ситуации с отставанием репликации сайта, этот параметр может заставить клиента ждать, когда задержка репликации станет ниже указанного значения. В случае чрезмерной задержки возвращается код ошибки «maxlag» с сообщением «Waiting for $host: $lag seconds lagged».
См. подробнее на странице с описанием Manual: параметра Maxlag.

Тип: целочисленное значение

smaxage

HTTP-атаманың мәғәнәһен s-maxage бирелгән секунд эсендә билдәләргә. Хаталар бер ваҡытта ла кэшланмай.

Тип: целочисленное значение

Значение должно быть не меньше 0.

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

maxage

HTTP-атаманың мәғәнәһен s-maxage бирелгән секунд эсендә билдәләргә. Хаталар бер ваҡытта ла кэшланмай.

Тип: целочисленное значение

Значение должно быть не меньше 0.

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

assert

Әгәр user бирелһә - танылған ҡатнашыусы, not булһа anon - аноним, bot икән робот хоҡуҡтарына эйә икәненә инанығыҙ.

Одно из следующих значений: anon, bot, user

assertuser

Проверить, что ник текущего участника совпадает с заданным.

Төр: ҡатнашыусы, теләһә ниндәй ҡатнашыусы исеме һәм Ваҡытлыса ҡатнашыусы

requestid

Бында бирелгән һәр мәғәнә яуапҡа индереләсәк. Һорауҙарҙы айырыу өсөн файҙаланылырға мөмкин

servedby

Һөҙөмтәләргә һоратыуҙы эшкәрткән хост исемен индерергә.

Тип: булева (подробнее)

curtimestamp

Һөҙөмтәләргә ағымдағы ваҡыт тамғаһы ҡуйырға.

Тип: булева (подробнее)

responselanginfo

Включить языки, использованные для uselang и errorlang, в результат.

Тип: булева (подробнее)

origin

API мөрәжәғәт иткәндә AJAX-һорау (CORS) кросс-домены ҡулланһағыҙ, параметрға тәүге домен мәғәнәһен бирегеҙ. Ул алдағы һорауҙа булырға һәм шул рәүешле URI-һорауҙың (POST түгел) бер өлөшө булырға тейеш. Ул атамалағы бер сығанаҡҡа Origin тап килергә тейеш, мәҫәлән, https://ru.wikipedia.org йәки https://meta.wikimedia.org. Әгәр ҙә параметр атамаға Origin тура килмәһә, яуап 403 хата коды менән кире ҡайтарыла. Әгәр параметр Origin атамаға тура килһә, һәм сығанаҡ рөхсәт ителгән исемлектә икән, Access-Control-Allow-Origin тигән атама ҡуйыласаҡ.

crossorigin

When accessing the API using a cross-domain AJAX request (CORS) and using a session provider that is safe against cross-site request forgery (CSRF) attacks (such as OAuth), use this instead of origin=* to make the request authenticated (i.e., not logged out). This must be included in any pre-flight request, and therefore must be part of the request URI (not the POST body).

Note that most session providers, including standard cookie-based sessions, do not support authenticated CORS and cannot be used with this parameter.

Тип: булева (подробнее)

uselang

Язык, используемый для перевода сообщений. Запрос action=query&meta=siteinfo&siprop=languages возвращает список кодов языков. Вы можете указать user, чтобы использовать текущие языковые настройки участника, или content для использования основного языка этой вики.

По умолчанию: user

variant

Вариант языка. Работает только в том случае, если базовый язык поддерживает преобразование вариантов.

errorformat

Формат, используемый для вывода текста предупреждений и ошибок

plaintext: Вики-текст с удалёнными HTML-метками и заменёнными энтити.
wikitext: Нераспарсированный вики-текст.
html: HTML
raw: Ключ сообщения и параметры.
none: Не выводит текст, только коды ошибок.
bc: Формат, использовавшийся до MediaWiki 1.29. errorlang и errorsuselocal игнорируются.

Одно из следующих значений: bc, html, none, plaintext, raw, wikitext

По умолчанию: bc

errorlang

Язык, используемый для вывода предупреждений и сообщений об ошибках. Запрос action=query&meta=siteinfo&siprop=languages возвращает список кодов языков. Укажите content для использования основного языка этой вики, или uselang для использования того же значения, что и в параметре uselang.

По умолчанию: uselang

errorsuselocal

Если задан, тексты ошибок будут использовать локально модифицированные сообщения из пространства имён MediaWiki.

Тип: булева (подробнее)

Примеры:

Төп модулгә ярҙам.: api.php?action=help [открыть в песочнице]
Бар белешмә бер биттә.: api.php?action=help&recursivesubmodules=1 [открыть в песочнице]

Разрешение:

apihighlimits: Использовать высокие лимиты в запросах API (медленные запросы: 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 may 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.

Шаблонные параметры

Шаблонные параметры используются в случаях, когда модулю API нужно получить по параметру со значением на каждое значение другого параметра. Например, если бы был модуль API, запрашивающий фрукты, у него мог бы быть параметр фрукты, указывающий, какие фрукты запрашиваются, и шаблонный параметр {фрукт}-в-количестве, указывающий, сколько фруктов каждого вида запросить. Клиент API, который хочет запросить 1 яблоко, 5 бананов и 20 апельсинов, мог бы тогда сделать запрос наподобие фрукты=яблоки|бананы|апельсины&яблоки-в-количестве=1&бананы-в-количестве=5&апельсины-в-количестве=20.

Создатели

Разработчики API:

Yuri Astrakhan (создатель, ведущий разработчик с сентября 2006 по сентябрь 2007)
Roan Kattouw (ведущий разработчик 2007—2009)
Victor Vasiliev
Bryan Tong Minh
Sam Reed
Brad Jorsch (ведущий разработчик 2013—2020)

Пожалуйста, присылайте ваши комментарии, предложения и вопросы на адрес mediawiki-api@lists.wikimedia.org или присылайте отчёты об ошибках на https://phabricator.wikimedia.org/.