Ограничения скорости определяют, как часто можно осуществлять запросы по конкретной конечной точке. Обычно компании имеют разные уровни (например, бесплатные и профессиональные) и лицензии (с открытым исходным кодом, бизнес, коммерческие), соответствующие различным возможностям или ограничениям скорости API.
Что покрывать при помощи ограничения скорости
Пример разделов "Ограничения скорости"
Практическое занятие: Ограничения скорости
Компании, имеющие API зарабатывают деньги, взимая плату за доступ к API. Обычно различают низкое и высокое использование, часто освобождая варианты с низким использованием, чтобы разработчики могли исследовать и экспериментировать с API. На примере API OpenWeatherMap Weather, который мы используем на этом курсе, можно увидеть, где начинается уровень ценообразования:
Уровни ценообразования для API OpenWeatherMap. Каждый вызов - это запрос к API. Если на странице отображается только один запрос о погоде, и приходит более 60 посетителей в секунду, необходимо пройти мимо бесплатного уровня пользования.
Если сайт посещает сотни тысяч человек в день и каждая перезагрузка страницы дергает конечную точку API, нужно быть уверенным, что API может поддерживать такой тип трафика.
Ценообразование, относящееся к ограничениям скорости, - это, вероятно, информация, которая находится в области маркетинга, а не в области документации. Тем не менее, разработчикам стоит знать ключевые варианты поведения, включающие пороги ограничения скорости. Например:
- Замедляется ли получение ответов при превышении порога скорости?
- Приходится ли платить за каждый дополнительный запрос?
- Возвращает ли ответ определенный код состояния при превышении порога скорости (если да, то какой?)
Как разработчики обрабатывают ситуации, если, при внедрении кода в приложения, API не отвечает из-за нарушений ограничения скорости? Существуют ли условия и проверки для обработки таких сценариев с ограничениями? Может зависать виджет (или что-то еще, что может реализовывать API), или будет отображаться пустым, или будет происходит сбой?
Ограничение скорости может показаться маркетинговой темой, но политики ограничения скорости и их влияние на вызовы API могут оказать существенное влияние на разработку.
Ниже приведены несколько примеров с разделами "Ограничения скорости" в API
Ограничения скорости GitHub
Документация GitHub объясняет:
- ограничения скорости для аутентифицированных и не аутентифицированных запросов, которые возвращает заголовок,
- значение ограничивающих скорость заголовков (
X-RateLimit-Limit,X-RateLimit-RemainingиX-RateLimit-Reset), - как проверить текущее использование,
- как увеличить лимиты скорости для конкретного приложения,
- что происходит при злоупотреблении лимитами и многое другое.
Ограничения скорости LinkedIn
Документация Linkedin по ограничению скорости объясняет, что разные конечные точки API имеют разные ограничения. Существует три различных типа регулирования:
- регулирование приложений,
- регулирование пользователей;
- регулирование разработчиков.
Их документация также объясняет часовой пояс, используемый для отслеживания начала и конца дня.
Bitly предоставляет основную информацию на странице выше, а также ссылки на лучшие практики для избегания проблем с ограничением скорости. Эти передовые практики включают советы о кэшировании, проблемах безопасности, длинных загрузок страниц, пакетной обработке, запросах большого объема, кодирования URL и многое другое.
Глядя на примеры, можно увидеть, что, хотя ограничение скорости может показаться простой темой, существуют уровни глубины и сложности, которые необходимо охватить. Актуальность темы зависит от нашего API и политики ограничений, установленных вашей компанией, но эта информация не может быть полностью загружена в маркетинг для обработки. Большая часть информации об ограничении скорости напрямую влияет на развитие.
В своем найденном опен-сорс проекте найдем информацию об ограничениях в API документации. Ответим на следующие вопросы:
- Есть ли у API ограничения?
- Что произойдет в результате превышения ограничений?
- Какой код статуса появится при превышении ограничений?
- Какие ограничения скорости существуют для свободных (или разрабатываемых) уровней API?