API:Data formats/ru

Ввод
API принимает входные данные через параметры, предоставляемые HTTP-запросом в формате  или. Каждый модуль и подмодуль обладает собственным набором параметров, которые перечислены в документации и в action=help. Их также можно получить через.

Кодировка
Все вводимые данные должны быть переданы в корректном коде UTF-8, в форме NFC. MediaWiki попытается преобразовать другие форматы. В ходе преобразования может возникнуть ошибка.

Параметры с списком значений
Parameters that take multiple values are normally submitted with the values separated using the pipe character, e.g.. If a value contains the pipe character in itself, use U+001F (Unit Separator) as the separator and prefix the value with U+001F, e.g..

Whether a parameter accepts multiple values is listed explicitly in its module documentation.

Boolean parameters
Булевы параметры работают, как флажки HTML: если параметр указан в HTTP-запросе, он вне зависимости от значения считается истинным. Для указания ложного значения параметр следует полностью опустить. Лучший способ указать истинный параметр в HTTP-запросе — это использование ; завершающий знак   не допускает отбрасывания «пустого» параметра браузером или HTTP-библиотекой.

Временные отметки
Параметры, принимающие временные отметки, способны принять несколько форматов временных отметок:


 * формат ISO 8601:.
 * Внутренний формат временных отметок MySQL:.
 * Формат временных отметок Unix  (время, прошедшее с 1 января 1970 года, в секундах).
 * Формат временных отметок Unix  (время, прошедшее с 1 января 1970 года, в секундах).

В выводе временные отметки всегда в формате ISO 8601.

Выход
The standard and default output format in MediaWiki is JSON. All other formats are discouraged.

The output format should always be specified using  with yourformat being one of the following:

Ответ
Если не указано иное, все модули поддерживают вывод данных во всех обобщённых форматах. Для облегчения отладки все обобщённые форматы имеют форматирующие в HTML альтернативы с окончанием.

Параметры JSON
The following parameters can be used with  and  :



Additional notes
Существует большое количество библиотек и онлайн-ресурсов для преобразования ответов в формате JSON в другие форматы, например, JSON-CSV преобразовывает JSON в CSV Модули лент, наподобие ленты свежих правок, переопределяют стандартный формат вывода, вместо этого используя RSS или Atom, как указано в их параметре. В этих случаях формат, указанный в параметре  используется только при возникновении ошибки.
 * XML and PHP output formats are depracated but still in use. Клиентам, написанным на PHP, следует избегать использования формата PHP, поскольку он фундаментально небезопасен. It is maintained for now only due to its popularity.

См. также

 * - Contains warning and error formats.