API:Etiquette/ru

Эта страница находится в стадии разработки.

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

Помощь

 * 1) Прочтите ответы на часто задаваемые вопросы.
 * 2) Попробуйте найти ответ на свой вопрос в документации API здесь или на самодокументируемой странице API.
 * 3) Если вы не можете найти ответ на вопрос в интернете, задайте его в почтовой рассылке mediawiki-api.

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

Если вы выполняете запросы последовательно, а не параллельно (то есть вы ожидаете завершения одного запроса, прежде чем выполнить другой, таким образом одновременно выполняя не более одного запроса), проблем вы точно не вызовете. Также старайтесь объединять запросы. Например: указывайте несколько разделённых вертикальными чертами названий в параметре, а не выполняете новый запрос для каждого названия; используйте генератор, а не делайте запрос для каждого результата из ответа на другой запрос.

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


 * [//en.wikipedia.org/w/api.php?action=parse&format=xml&prop=images&oldid=254862759 en.wikipedia.org/w/api.php?action=parse&format=xml&prop=images&oldid=254862759]
 * [//en.wikipedia.org/w/api.php?action=parse&format=xml&prop=images&oldid=462841413 en.wikipedia.org/w/api.php?action=parse&format=xml&prop=images&oldid=462841413]

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

См.:

Заголовок User-Agent
Используйте содержательный заголовок, включающий имя вашего приложения и, возможно, адрес вашей электронной почты, если это уместно. Не копируйте механически юзер-агент популярных веб-браузеров (если только ваш API-клиент — не приложение на JavaScript, работающее через соответствующий браузер с помощью Ajax и не способное в связи с этим изменять его юзер-агент). Это гарантирует, что при возникновении проблемы отследить её источник будет легко. См. API:Заглавная страница#Идентификация клиента и m:User-Agent policy для подробностей.

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