Википедия:API/Новичкам
Как известно, Википедия работает на движке MediaWiki. Движок MediaWiki имеет свой API, который является веб-службой, обеспечивающей доступ к таким функциям вики, как аутентификация, операции над страницами, поиск по вики и множество других операций. MediaWiki API может обрабатывать запросы через обработчик(скрипт) api.php, который написан на языке программирования PHP. Обработчик принимает запросы через отправку HTTP запросов на адрес(url) обработчика. Для Википедии url обработчика находится по адресу https://ru.wikipedia.org/w/api.php.
Способы взаимодействия с API[править код]
Прямая отправка запросов[править код]
При переходе по прямой ссылке обработчика без указания аргументов, обработчик выдаст Справку MediaWiki API. Попробовать функции обработчика в интерактивной песочнице. Для более полного понимания работы обработчика, рекомендуется делать запросы через адресную строку браузера.
Синтаксис запроса[править код]
Аргументы http запроса начинаются со знака "?", который разделяет путь к обработчику, и тело запроса. К примеру в запросе https://ru.wikipedia.org/w/api.php?action=help&format=json адрес https://ru.wikipedia.org/w/api.php является путем к обработчкику, а ?action=help&format=json аргументами запроса. Аргументы запроса указываются последовательно, каждый аргумент отделяется знаком "&" без пробелов.
В запросах к обработчику есть основной(но не обязательный) аргумент:
- action: Действие, которое следует выполнить.
А так же дополнительные, один из которых:
- format: Формат вывода, т.е. в каком виде вы хотите получить ответ на запрос.
Все аргументы вы можете узнать на странице странице встроенной справки
Примеры запросов[править код]
Не требующие авторизации:
Получить справку MediaWiki API в формате json.
Требующие авторизацию:
Большая часть запросов требует авторизации при помощи токенов, в том числе и анонимное редактирование. Для получения csrf токена, выполните запрос:
Использование библиотек[править код]
На практике редко отправляют http запросы напрямую. Разработчики используют специальные библиотеки API, которые значительно облегчают разработчикам жизнь. В библиотеках содержатся готовые методы, параметры, классы и объекты, которые обернуты в выбранный разработчиком язык программирования, и взаимодействуют с MediaWiki API в более удобной для разработчика форме.
Ботов можно писать практически на любом языке программирования. Выбор языка часто зависит от опыта автора бота (какие языки ему знакомы) или от наличия предварительно разработанных библиотек для выполнения желаемой задачи. Если вы хотите начать писать ботов, определитесь с языком программирования. Вы можете ознакомится с существующими библиотеками на основной странице.