MediaWiki API
- Сюда перенаправляется запрос «API». На эту тему, возможно, нужна отдельная статья.
MediaWiki API — программный интерфейс движка MediaWiki, позволяющий приложениям получать доступ к функционалу движка.
MediaWiki API обеспечивает прямой высокоуровневый доступ к информации, содержащейся в базах данных MediaWiki-проектов. В перспективе должен обеспечивать три основных функции:
- Авторизация в проекте
- Получение данных
- Изменение данных
Доступ осуществляется путём HTTP-запроса с набором параметров, отправляемых с помощью метода GET или POST (?). В ответ на запрос будет выдана структурированная информация, сформированная согласно отправленному набору параметров, в одном из доступных форматов.
Параметры[править | править код]
Основными являются три параметра, от которых зависит возможный набор уточняющих параметров — action, определяющий задание, которое должен выполнить движок, format, определяющий формат, в котором будут выданы данные и version — параметр без значения и уточняющих параметров.
Действия[править | править код]
- action
- help — выдаётся справка по интерфейсу
- login — производится авторизация пользователя. Совместно следует использовать следующие параметры:
- lgname — имя учётной записи
- lgpassword — пароль к учётной записи
- lgdomain — домен (?, опционально)
- opensearch — OpenSearch. Используется совместно с параметром:
- search — строка для поиска
- feedwatchlist — выдаёт в RSS/Atom формате список наблюдения.
- feedformat — формат. rss или atom.
- query — выдаёт нужные данные в зависимости от параметров:
- titles — список имён страниц, с которыми будет работать движок. Список составляется из названий страниц, разделённых символом |, например
Pywikipedia|SVG|CSS|Заглавная страница
. - pageids — список идентификаторов (pageid) страниц, с которыми будет работать движок. Идентификаторы также разделяются символом |.
- revids — список идентификаторов (revid) версий страниц, с которыми будет работать движок. Идентификаторы также разделяются символом |.
- titles — список имён страниц, с которыми будет работать движок. Список составляется из названий страниц, разделённых символом |, например
Формат[править | править код]
- format — формат, в котором будет выведен результат. Возможно одно значение из:
Версия[править | править код]
- version — выдаётся справка по интерфейсу с информацией о версии каждого модуля интерфейса.