Довідка API MediaWiki

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

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

action=opensearch

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

Шукати у вікі з використанням протоколу OpenSearch.

Параметри:
search

Рядок пошуку.

Цей параметр є обов'язковим.
namespace

Простори назв, у яких шукати. Ігнорується, якщо search починається з валідного префікса простору назв.

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

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

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

Більше не використовується.

Тип: логічний (подробиці)
redirects

Як обробляти перенаправлення:

return
Видати саме перенаправлення.
resolve
Видати цільову сторінку. Може видати менше, ніж limit результати.

З історичних причин, за замовчуванням стоїть «return» для format=json і «resolve» — для інших форматів.

Одне з наступних значень: resolve, return
format

Формат виводу.

Одне з наступних значень: json, jsonfm, xml, xmlfm
Стандартно: json
warningsaserror

Якщо при format=json з'являються попередження, видати помилку API замість того, щоб їх ігнорувати.

Тип: логічний (подробиці)
Приклад:
Знайти сторінки, що починаються з Te.
api.php?action=opensearch&search=Te [відкрити в пісочниці]