API:Data formats/uk

Вхідні дані
API отримує вхідні дані з параметрів, наданих в запиті HTTP у форматі  чи. Кожен модуль і підмодуль має власний набір параметрів, які перелічені в документації та в action=help. Їх також можна отримати за допомогою.

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



Параметри зі списком значень
Для параметрів, які отримують водночас кілька значень, ці значення зазвичай передаються розділеними вертикальною рискою, приміром,. Якщо одне зі значень такого параметру містить вертикальну риску, застосуйте U+001F (Unit Separator) як розділювач та почніть це значення із U+001F, приміром, як.

Чи може параметр набувати переліку значень, явно вказано в документації щодо його модулю.



Булеві параметри
Якщо в запиті HTTP вказано будь-яке значення булевого параметру, воно вважається еквівалентним істині. Для значення хиби пропустіть параметр як такий, не згадуючи його взагалі. Найкращий спосіб передавання значення істина в запиті HTTP виглядає так: ; знак   наприкінці гарантує, що браузер чи бібліотека HTTP не викине someParam як порожній.

Часові позначки
Параметри, які набувають значень часової позначки, приймають часову позначку в різних форматах:


 * формат ISO 8601:.
 * внутрішній формат часової позначки MySQL:.
 * формат часової позначки UNIX  (кількість секунд від 1 січня 1970 року).
 * формат часової позначки UNIX  (кількість секунд від 1 січня 1970 року).

Виводяться часові позначки завжди у форматі ISO 8601.

Вихід

 * Авторизуватися у вікі, отримати дані та відобразити результат — все за допомогою запитів HTTP до веб-служби

Формат виходу завжди має бути заданий за допомогою  із yourformat і є одним із:



Відповідь
Якщо не вказано інше, кожен модуль дозволяє виводити дані у всіх загальних форматах. Для спрощення налагодження всі загальні формати мають альтернативи типу «pretty-print in HTML», записані із суфіксом, як-от.



Параметри JSON
Наступні параметри можуть бути застосовані з  та  :





Технічні примітки

 * Формати виводу XML та PHP не рекомендовані, але все ще застосовуються. Клієнти, написані на PHP, мають уникати формату PHP, оскільки він фундаментально не забезпечує безпеки. Він підтримується досі лише внаслідок його популярності.
 * Існує багато бібліотек та онлайн-перетворювачів для перетворення відповідей JSON в інші формати — зокрема, JSON-CSV перетворює на перелік розділених комою значень.
 * Модулі завантаження на кшталт Завантаження нових змін застосовують відмінний від стандартного формат виводу, як-от RSS чи Atom, як указано в їхньому параметрі . В таких випадках формат, указаний параметром , застосовується лише при виникненні помилки.



Див. також

 * - Містить формати попереджень і помилок.