API:Data formats/ru

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

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



Параметры с списком значений
Параметры, которые принимают несколько значений, обычно передаются со значениями, разделенными символом вертикальной черты, например. Если значение содержит в себе символ вертикальной черты, используйте U+001F (Unit Separator) в качестве разделителя и начните перечисление с U+001F, например.

Если параметр принимает несколько значений, это явно указано в документации к модулю.



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

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


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

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

Выход
Стандартный формат и формат вывода по умолчанию в MediaWiki — JSON. Все остальные форматы не рекомендуется.

Выходной формат всегда должен указываться с помощью, где yourformat являются одним из следующих:



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



Параметры JSON
Следующие параметры могут использоваться с  и  :





Дополнительная информация

 * Выходные форматы XML и PHP устарели, но все еще используются. Клиентам, написанным на PHP, следует избегать использования формата PHP, поскольку он фундаментально небезопасен. Он поддерживается на данный момент только ввиду его популярности.
 * Существует большое количество библиотек и онлайн-ресурсов для преобразования ответов в формате JSON в другие форматы, например, JSON-CSV преобразовывает JSON в CSV.
 * Модули лент, наподобие ленты свежих правок, переопределяют стандартный формат вывода, вместо этого используя RSS или Atom, как указано в их параметре . В этих случаях формат, указанный в параметре   используется только при возникновении ошибки.



См. также

 * - Содержит форматы предупреждений и ошибок.