MediaWiki 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) версий страниц, с которыми будет работать движок. Идентификаторы также разделяются символом |.


Формат[править]

  • format — формат, в котором будет выведен результат. Возможно одно значение из:
    • xml — XML
    • xmlfm - XML в HTML
    • wddx — WDDX
    • wddxfm — WDDX в HTML
    • yaml — YAML
    • yamlfm — YAML в HTML
    • php — PHP (?)
    • phpfm — PHP (?) в HTML
    • json — JSON
    • jsonfm — JSON в HTML
    • rawfm — данные в формате JSON с отладочной информацией.

Версия[править]

  • version — выдаётся справка по интерфейсу с информацией о версии каждого модуля интерфейса.

Ссылки[править]