Довідка API MediaWiki

Це автоматично генерована сторінка документації API MediaWiki.

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

prop=info (in)

  • Цей модуль вимагає прав на читання.
  • Джерело: MediaWiki
  • Ліцензія: GPL-2.0-or-later

Отримати основні відомості про сторінку.

Параметри:
inprop

Які додаткові властивості отримати:

protection
Вивести рівень захисту кожної сторінки.
talkid
Ідентифікатор сторінки обговорення для кожної сторінки, що не є обговоренням.
watched
Вивести статус спостереженості кожної сторінки.
watchers
Кількість спостерігачів, якщо це дозволено.
visitingwatchers
Кількість спостерігачів для кожної сторінки, які відвідували останні редагування таких сторінок, якщо це дозволено.
notificationtimestamp
Часова мітка сповіщення списку спостереження кожної сторінки.
subjectid
Ідентифікатор батьківської сторінки для кожної сторінки обговорення.
associatedpage
Назва префіксу відповідної теми або сторінки обговорення.
url
Дає повний URL, URL редагування та канонічний URL для кожної сторінки.
readable
Застарілий. Чи користувач може читати цю сторінку. Використовуйте intestactions=read натомість.
preload
Дає текст, виданий EditFormPreloadText.
displaytitle
Дає спосіб, у який відображається назва сторінки.
varianttitles
Видає вигляд заголовка всіма варіантами мов контенту цього сайту.
linkclasses
Дає додаткові класи CSS (наприклад, кольори посилань), що використовуються для посилань на цю сторінку, якщо вони мають з’являтися на сторінці, названої in linkcontext.
Значення (розділені через | або альтернативу): associatedpage, displaytitle, linkclasses, notificationtimestamp, preload, protection, subjectid, talkid, url, varianttitles, visitingwatchers, watched, watchers, readable
inlinkcontext

Заголовок контексту для використання при визначенні додаткових класів CSS (наприклад, кольорів посилань), коли inprop містить linkclasses.

Тип: назва сторінки
Приймати сторінки, що не існують.
Стандартно: Головна сторінка
intestactions

Перевірити, чи поточний користувач може виконувати певні дії на сторінці.

Розділіть значення з допомогою | або альтернативу.
Максимальна кількість значень — 50 (500 для клієнтів дозволено вищі ліміти).
intestactionsdetail

Рівень деталізації для intestactions. Використовуйте параметри errorformat та errorlang головного модуля, щоб контролювати формат отримуваних повідомлень.

boolean
Вивести значення логічного типу даних для кожної дії.
full
Вивести повідомлення з поясненням, чому така дія заборонена, або порожній рядок, якщо така дія дозволена.
quick
Так само як full, але без затратних перевірок.
Одне з наступних значень: boolean, full, quick
Стандартно: boolean
incontinue

Коли доступно більше результатів, використовуйте це, щоб продовжити.

Приклади:
Отримати інформацію про сторінку Main Page.
api.php?action=query&prop=info&titles=Main%20Page [відкрити в пісочниці]
Отримати загальну інформацію і дані про захист сторінки Main Page.
api.php?action=query&prop=info&inprop=protection&titles=Main%20Page [відкрити в пісочниці]

list=categorymembers (cm)

  • Цей модуль вимагає прав на читання.
  • Цей модуль може бути використаний як генератор.
  • Джерело: MediaWiki
  • Ліцензія: GPL-2.0-or-later

Перерахувати усі сторінки у поданій категорії.

Параметри:
cmtitle

Яку категорію вивести (обов'язково). Мусить включати префікс Категорія:. Не можна використати разом з cmpageid.

cmpageid

ID сторінки категорії для виведення. Не можна використати разом з cmtitle.

Тип: ціле число
cmprop

Які відомості включати:

ids
Додає ID сторінки.
title
Додає назву й ID простору назв сторінки.
sortkey
Додає ключ сортування, використаний для сортування у категорії (шістнадцятковий рядок).
sortkeyprefix
Додає ключ сортування, використаний для сортування у категорії (людиночитна частина).
type
Додає тип, за яким категоризується сторінка (page, subcat або file).
timestamp
Додає мітку часу, коли сторінка була включена.
Значення (розділені через | або альтернативу): ids, sortkey, sortkeyprefix, timestamp, title, type
Стандартно: ids|title
cmnamespace

Включати лише сторінки у цих просторах назв. Зверніть увагу, що cmtype=subcat чи cmtype=file можна використовувати замість cmnamespace=14 чи 6.

Значення (розділені через | або альтернативу): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 2300, 2301, 2302, 2303
Щоб зазначити всі значення, використовуйте *.
cmtype

Який тип елементів категорії включати. Ігнорується, коли вказано cmsort=timestamp.

Значення (розділені через | або альтернативу): file, page, subcat
Стандартно: page|subcat|file
cmcontinue

Коли доступно більше результатів, використовуйте це, щоб продовжити.

cmlimit

Максимальна кількість сторінок для виведення.

Тип: ціле число або max
Значення має перебувати між 1 та 500.
Стандартно: 10
cmsort

Властивість, за якою сортувати.

Одне з наступних значень: sortkey, timestamp
Стандартно: sortkey
cmdir

У якому напрямку сортувати.

Одне з наступних значень: asc, ascending, desc, descending, newer, older
Стандартно: ascending
cmstart

Часова мітка, з якої почати список. Можна використати лише разом з cmsort=timestamp.

Тип: часова мітка (дозволені формати)
cmend

Часова мітка, якою закінчити список. Можна використати лише разом з cmsort=timestamp.

Тип: часова мітка (дозволені формати)
cmstarthexsortkey

Ключ сортування, з якого почати список, як видає cmprop=sortkey. Можна використати лише разом з cmsort=sortkey.

cmendhexsortkey

Ключ сортування, з якого почати список, як видає cmprop=sortkey. Можна використати лише разом з cmsort=sortkey.

cmstartsortkeyprefix

Префікс ключа сортування, з якого почати список. Можна використати лише разом з cmsort=sortkey. Перевизначає cmstarthexsortkey.

cmendsortkeyprefix

Префікс ключа сортування, перед яким закінчити список (не на; якщо це значення зустрінеться, його не буде включено!). Можна використати лише разом з cmsort=sortkey. Перевизначає cmendhexsortkey.

cmstartsortkey
Застарілий.

Використати натомість cmstarthexsortkey.

cmendsortkey
Застарілий.

Використати натомість cmendhexsortkey.

Приклади:
Отримати перші 10 сторінок у Category:Physics.
api.php?action=query&list=categorymembers&cmtitle=Category:Physics [відкрити в пісочниці]
Отримати інформацію про перші 10 сторінок у Category:Physics.
api.php?action=query&generator=categorymembers&gcmtitle=Category:Physics&prop=info [відкрити в пісочниці]