API:Etiquette/ru

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

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

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


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

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

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

Параметр maxlag
Если ваша задача не интерактивна (то есть нет пользователя, ждущего результата), следует использовать параметр maxlag. The value of the  parameter should be an integer number of seconds. Например:

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

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

Заголовок User-Agent
It is best practice to set a descriptive User Agent header. To do so, use. For example in PHP:

Не копируйте механически юзер-агент популярных веб-браузеров (если только ваш API-клиент — не приложение на JavaScript, работающее через соответствующий браузер с помощью Ajax и не способное в связи с этим изменять его юзер-агент). Это гарантирует, что при возникновении проблемы отследить её источник будет легко.

If you are calling the API from browser-based JavaScript, you may not be able to influence the  header, depending on the browser. To work around this, use the  header.

См. API:Заглавная страница#Идентификация клиента и m:User-Agent policy для подробностей.

Data formats
All new API users. See for more details.

Performance
Если вы пытаетесь понять, почему вы получаете результаты медленнее, чем вам бы хотелось, попробуйте обратиться к, чтобы получить помощь в рассматривании производительности в общем.

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

См. также

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