Как использовать MediaWiki API: 8 шагов (с изображениями)

Оглавление:

Как использовать MediaWiki API: 8 шагов (с изображениями)
Как использовать MediaWiki API: 8 шагов (с изображениями)

Видео: Как использовать MediaWiki API: 8 шагов (с изображениями)

Видео: Как использовать MediaWiki API: 8 шагов (с изображениями)
Видео: Как установить ВПН для Oculus Quest 2 ► Обновление Quest 2 через VPN 2024, Май
Anonim

MediaWiki API - это хорошо документированный набор инструментов разработки, которые могут выполнять большинство задач в одном скрипте. API обычно используется для разработки автоматизированных инструментов для использования в вики. API MediaWiki можно легко использовать на большинстве языков, в частности на PHP (функции curl), а также на Perl и некоторых других.

Шаги

Используйте MediaWiki API, шаг 1
Используйте MediaWiki API, шаг 1

Шаг 1. Прочтите документацию MediaWiki API

Он расположен в api.php в том же каталоге, что и обычный index.php. Пример:

Используйте MediaWiki API, шаг 2
Используйте MediaWiki API, шаг 2

Шаг 2. Выберите выходной формат

MediaWiki предлагает вывод данных в форме JSON, JSONFM, PHP (сериализованный формат), PHPFM, WDDX, WDDXFM, XML, XMLFM, YAML, YAMLFM и RAWFM. Форматы с суффиксом "FM" довольно печатаются в HTML.

Используйте MediaWiki API, шаг 3
Используйте MediaWiki API, шаг 3

Шаг 3. Выберите действие

MediaWiki API поддерживает следующие действия:

  • help - см. экран справки.
  • вход - вход в MediaWiki
  • opensearch - Реализует протокол opensearch. (Не во всех инсталляциях MediaWiki это есть).
  • feedwatchlist - возвращает канал списка наблюдения.
  • запрос - имеет множество опций. См. Документацию по API MediaWiki для них.
Используйте MediaWiki API, шаг 4
Используйте MediaWiki API, шаг 4

Шаг 4. Выберите запрос или список

Помимо стандартных действий, MediaWiki поддерживает различные запросы и списки, такие как листинг страниц, содержащих ссылку на другую статью, количество последних изменений, различий, вклады и т. Д.

Используйте MediaWiki API, шаг 5
Используйте MediaWiki API, шаг 5

Шаг 5. Передайте опубликованные данные в API с помощью CURL или другого инструмента, который позволяет использовать метод POST для сценария

Также может работать метод GET.

Используйте MediaWiki API Шаг 6
Используйте MediaWiki API Шаг 6

Шаг 6. Обязательно сохраните файлы cookie, отправленные в приложение (некоторые сценарии / приложения могут захотеть сохранить их во вложенной папке

Используйте MediaWiki API, шаг 7
Используйте MediaWiki API, шаг 7

Шаг 7. При взаимодействии с пользовательским интерфейсом MediaWiki помните, что ваш токен редактирования хранится на большинстве страниц редактирования

Маркер редактирования используется для определения конфликтов редактирования и предотвращения отмены другого уже выполненного редактирования (это также используется при откате). Имейте в виду, что все может пойти наперекосяк, если вы работаете с пользовательским интерфейсом вики. Помните о любых регулярных выражениях, которые вы используете, чтобы быть уверенным, что они дадут только желаемый результат.

Используйте MediaWiki API, шаг 8
Используйте MediaWiki API, шаг 8

Шаг 8. Прочтите результаты, присланные вики

Результаты будут отправлены вам в виде HTTP-ответа, который может быть прочитан многими парсерами. Особо позаботьтесь о выбранном вами формате. Убедитесь, что вы используете соответствующий синтаксический анализатор для этого формата. Обычно рекомендуется явно указывать формат для MediaWiki, даже если он имеет формат по умолчанию, который вы хотите использовать.

подсказки

  • Перед использованием API убедитесь, что ваша локальная вики поддерживает сценарий.
  • Вы можете узнать больше о MediaWiki, используя его API.

Рекомендуемые: