Если вы создаете приложение или уже развернули его, вы, вероятно, использовали большое количество сторонних API. В конце концов, зачем создавать его самостоятельно, когда вы можете подключить API к необходимой вам функциональности? Тем не менее, естественно делать определенные ошибки при интеграции API, и эти ошибки могут негативно повлиять на производительность приложений и пользовательский опыт. В этом посте подчеркиваются некоторые общие ошибки, которые делают разработчики при интеграции API с приложениями и как их избежать.
1. Не упускайте из виду законность, касающиеся использования API и пользовательских данных
Когда дело доходит до условий использования, многие разработчики совершают ошибку, рассматривая только политику во время интеграции. Поставщики API иногда меняют условия использования для своих API, и они не всегда уведомляют пользователей. Если вы используете API и не следуете его текущим условиям использования, поставщик может запретить вам использовать API или вы можете столкнуться с юридическими последствиями.
Также важно учитывать законность данных, которые хранит ваше приложение. В нескольких странах есть правила, касающиеся пользовательских данных, и ваше приложение должно следовать всем применимым законам о конфиденциальности данных. В противном случае вы можете столкнуться с дорогими штрафами и жесткими штрафами.
2. Не думайте, что сторонние API всегда будут отвечать, как и ожидалось
Некоторые разработчики не могут потратить время на тестирование и контроль сторонних API на предмет ошибок. Разработчики также могут не добавить код, который позволяет приложению работать должным образом, даже если API не отвечает и не возвращает ошибку. API становятся не реагирующими или возвращающими ошибки по многим причинам, включая:
- Время простоя -Многие поставщики API совершают время безотказной работы API 99-99,99%. Но реальность такова, что каждый API в конечном итоге испытает закрытие, будь то запланирован или незапланирован.
- Тайм -аут подключения — Многие поставщики программируют свои API с значениями тайм -аута по умолчанию, которые слишком короткие.
- Ограничения скорости — Объем вызовов API, как правило, низкие во время разработки приложений, но после развертывания приложения объем вызовов может достичь предела.
- Плохой запрос — Есть много причин, по которым API может вернуть ошибку «400 плохих запросов». » Обычно требуется много копаний, чтобы выяснить основную причину.
Не совершайте ошибку, предполагая, что API, которые вы используете, работают отлично. У них могут быть скрытые проблемы, и вы хотите найти ошибки, прежде чем ваши клиенты.
3. Следите за изменениями API
Ошибочно предположить, что поставщики используемых вами API всегда предупредят вас об изменениях. В то время как большинство провайдеров предупреждают пользователей об изменениях с помощью своих API, некоторые этого не делают. И единственное указание, которое изменение API может быть погребено глубоко в документации.
Иногда поставщики меняют дизайн API или выпускают API. Они могут изменить то, как вызываются методы или удалить функциональность API. Они могут выпустить новую версию API, которая обычно означает новые URL -адреса конечной точки. Эти изменения API могут нарушить интеграцию и даже снизить ваше приложение.
Как вы можете избежать этих ошибок интеграции API?
С правильными инструментами и методами кодирования вы можете избежать вышеуказанных ошибок интеграции API. Вот несколько примеров:
Просмотреть условия использования и исследование законов о конфиденциальности данных
Если вы разрабатываете приложение, вам необходимо обратить пристальное внимание на условия обслуживания для каждого стороннего API, который вы используете. Вы также должны убедиться, что ваше приложение и любые API, которые вы используете, соответствуют применимым законам о конфиденциальности данных. Например, если какие -либо пользователи живут в Европе, то ваше приложение должно соответствовать GDPR Анкет У вас есть пользователи, проживающие в Калифорнии? Тогда вам нужно соблюдать CCPA . Вам необходимо провести исследование и кодировать свое приложение для соблюдения каждого применимого закона о конфиденциальности данных. Вы также должны использовать Инструменты Это позволяет вам отслеживать и управлять личными пользовательскими данными.
Кодируйте ваше приложение для обработки не реагирующих API и ошибок
Вы можете запрограммировать свое приложение для обработки не реагирующих API любым количеством способов. Например, вы можете добавить код для асинхронных сценариев, кэширования и автоматических повторений.
- Асинхронное сценарий — Пользователям приложений не нужно ждать всех внешних сценариев и API для загрузки, прежде чем они смогут просмотреть основной контент. Асинхронные сценарии позволяют загружать содержание приложения или веб -страницы без необходимости ждать внешних ресурсов. Таким образом, если API не реагирует, контент будет загружаться независимо. Многие языки сценариев имеют асинхронную функциональность, включая JavaScript.
- Кэш Ответы API — Кэширование ответов API позволяет хранить данные сторонних API на вашем сервере или в самом клиенте. Клиент получает данные из файла кэша, а не с сервера API напрямую. Кэширование лучше всего подходит для данных API, которые часто не меняются. Вы можете использовать кэширование для повышения производительности и потенциально избежать отключений или ограничений по цене.
- Автоматические повторения — Вы должны добавить код в свое приложение, которое включает Автоматические повторения Анкет Если API не реагирует или возвращается с ошибкой, код автоматически отправляет другой запрос API. Большинство неудачных вызовов API могут быть немедленно повторно с успешными результатами.
Вы также должны кодировать свое приложение для обработки кодов состояния HTTP для каждого используемого вами API. Некоторые провайдеры публикуют подробные учебники о том, как это сделать.
Мониторинг сторонних API для изменений
Крайне важно, чтобы вы контролировали каждый API для изменений в доступности, производительности, скорости и формате данных. Поскольку большинство поставщиков обновляют документацию API и ChangeLog, прежде чем отправлять обновление пользователям, вы можете периодически проверять эти элементы для каждого используемого вами API. Лучшим вариантом является использование программного обеспечения для управления API, поскольку оно контролирует сторонние API и предупреждает вас об изменении автоматически.
Выберите правильные инструменты и методы
Выберите свои инструменты разработки и методы кодирования с умом, и вы можете избежать ошибок общих интеграций API.
Hoss предоставляет Бесплатная видимость в API, которые вы потребляете Анкет Следите за производительностью, получайте оповещения о ошибках и сократите количество времени, затрачиваемого на интеграцию отладки.
Оригинал: «https://dev.to/hoss/3-common-api-integration-mistakes-and-how-to-avoid-them-1k51»