API:Etiquette/ru

Эта страница содержит рекомендации, которые следует соблюдать при использовании API.

Поведение


Ограничение на запросы
Нет жёстко установленного ограничения на запросы чтения, но будьте учтивы и старайтесь не препятствовать работе сайта. Большинство системных администраторов оставляют за собой право заблокировать вас без предупреждения, если вы подвергаете угрозе стабильность их системы.

Выполнение ваших запросов последовательно, а не параллельно, с ожиданием завершения одного запроса перед отправкой нового запроса, должно обеспечить безопасную частоту запросов. Также рекомендуется запрашивать несколько элементов в одном запросе:


 * Используя символ вертикальной черты, когда это возможно, например, , вместо того, чтобы делать новый запрос для каждого заголовка.
 * Используя вместо выполнения запроса для каждого результата из другого запроса.


 * Используйте сжатие GZip при выполнении вызовов API, установив  для уменьшения использования полосы пропускания.

Запросы, которые вносят изменения, изменяют состояние или иным образом не являются запросами для чтения, подлежат ограничению по скорости. Точное применяемое ограничение скорости может зависеть от типа действия, ваших прав пользователя и настройки сайта, на который вы обращаетесь. Ограничения, которые применяются к вам, можно определить, посетив конечный пункт API action=query&meta=userinfo&uiprop=ratelimits.

Когда вы нажмете лимит запроса, вы получите ответ на ошибку в API с кодом ошибки. Если вы обнаружите эту ошибку, вы можете попробовать запрос снова, но вы должны увеличить время между последующими запросами. Общая стратегия для этого - Exponential backoff.



Обработка версий страниц парсером
Хотя с помощью параметра  можно запрашивать результаты из определённого номера версии, для серверов эта операция является ресурсоёмкой. Чтобы получить конкретную версию, используйте параметр. Например:



Параметр maxlag
Если ваша задача не интерактивна (то есть нет пользователя, ждущего результата), следует использовать параметр. Значение параметра  должно быть целым числом секунд. Например:

Это позволит избежать выполнения вашей задачи при высокой нагрузке на серверах. Более высокие значения означают более агрессивное поведение, более низкие значения — более сдержанное.

См. для более детальной информации.



Заголовок User-Agent
Рекомендуется задать описательный заголовок User Agent. Для этого используйте. Например, в PHP:

Не стоит просто копировать user-agent из популярного веб-браузера. Это гарантирует, что при возникновении проблемы отследить её источник будет легко.

Если вы вызываете API из JavaScript на основе браузера, вы можете не иметь возможности влиять на заголовок, зависящий от браузера. Чтобы обойти это, используйте заголовок.

См. Политику User-Agent для подробностей.



Форматы данных
Все новые пользователи API. См. для более детальной информации.

Производительность
Массовая загрузка данных с использованием Action API не всегда очень эффективна. На Wikimedia wikis есть более быстрые способы массивного получения данных, см. m:Research:Data и wikitech:Portal:Data Services для получения дополнительной информации.



Другие примечания
Если ваши запросы получают данные, которые могут быть заложены в кэше на некоторое время, вы должны предпринять шаги, чтобы сделать их в кэше, чтобы не запрашивать те же данные снова и снова. Некоторые клиенты могут сами кэшировать данные, но для других (особенно клиентов JavaScript) это невозможно.

Всякий раз, когда вы читаете данные из API веб-сервиса, вам следует по возможности использовать запросы GET, а не POST, поскольку последние не кэшируются.



См. также

 * - Краткое руководство по началу работы.