Распространенные ошибки API и способы их исправления

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

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

При рассмотрении того, какие тесты включить в свой пакет покрытия, обратите внимание на тестирование API, так как это один из наиболее важных и широко используемых типов. API (интерфейсы прикладного программирования) присутствуют в любом приложении и отвечают за правильную связь между несколькими программными системами. Основные функции API включают указание запросов данных, которые могут быть переданы, и условий обработки этих запросов. 

Например, пользователь хочет добавить товар в корзину, нажимает соответствующую кнопку, которая запускает запрос API, получает ответ, и корзина обновляется. Если этот запрос не будет выполнен, функция «добавить в корзину» не работает.

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

Ошибки API могут быть разные, и здесь мы расскажем подробнее о 5 самых популярных из них: 

Неверный HTTP-метод

Самая простая, но широко распространенная ошибка API — неправильный метод HTTP. Часто проблема возникает из-за пробелов в документации. Одним из примеров может быть отправка запроса GET с указанием параметра данных, но без упоминания параметра -X GET. В результате он автоматически преобразуется в POST-запрос. Также проблемы с HTTP-методами могут возникнуть при переключении API-инструментов, потому что некоторые из них могут использовать один метод для создания тестовых сред и их модификации, а другие используют разные способы для этих действий. Именно поэтому важно тщательно проверять эти нюансы, а также придерживаться последовательного подхода к написанию собственной документации. 

Использование неправильного протокола

Еще одна распространенная ошибка — несоответствие протоколов https:// и http://. Некоторые API могут поддерживать только один из протоколов, скажем, http, поэтому указание https:// в таком случае приведет к некорректной обработке запроса. Даже если оба они поддерживаются, могут возникнуть проблемы с перенаправлением на https:// при указании http://. Также может иметь место случай, когда провайдеры сторонних API, которые вы планируете использовать, вносят какие-то изменения и не присылают об этом уведомление. Так что лучше время от времени перепроверять эти аспекты. Для создания собственного API лучше использовать протокол https://. Для этого необходимо установить SSL-сертификат.хозяину. Некоторое время назад SSL-сертификаты были немного дорогими, поэтому по этому поводу могли быть сомнения, но с бесплатными провайдерами, такими как Letsencrypt или Cloudflare, это становится проще, чем когда-либо.

Отсутствие осмысленных сообщений об ошибках

Если вы когда-либо сталкивались с « непредвиденной ошибкой API», вы знаете, как раздражает это может быть. Обычно предполагается, что сообщения об ошибках облегчают поиск и устранение неполадок для разработчиков, указывая точную причину ошибки или, по крайней мере, где ее искать. К сожалению, такие неинформативные ошибки могут привести к часам потерянного времени, увеличить время, необходимое для устранения ошибки, и, следовательно, вызвать больший всплеск негативных отзывов, которые вы получаете, поэтому лучше потратить немного больше времени на описание потенциальных ошибок и сделать сообщения информативными для тех, кому нужно будет их устранять. Хотя существует несколько десятков кодов ошибок HTTP, не обязательно использовать их все, но оставьте стандартные коды ошибок (200, 400 и 500) и рассмотрите возможность включения подсказок в сообщения, чтобы даже в случаях, когда что-то не работает,

Проблемы с авторизацией

Может показаться, что здесь все понятно, так как неправильная авторизация обычно предполагает неверный логин или пароль, но на самом деле даже смешение «авторизации» с «аутентификацией» в заголовках приводит к ошибке. Это особенно актуально при использовании протокола OAuth 2. Кроме того, важен синтаксис, потому что некоторые простые, но менее очевидные вещи могут создать путаницу. В большинстве случаев это токен носителя, пробел в префиксе «Basic», отсутствующий для полного добавления этого префикса и потерянный двоеточие в паре «имя пользователя: пароль». Даже когда имя пользователя используется отдельно в некоторых API, не требующих пароля, вам все равно придется использовать это двоеточие.

Невозможно указать заголовки Content-Type и Accept

Некоторые API толерантны к запросам, заголовки которых не содержат Content-Type или Accept, но соответствуют разрешенному формату данных. Другие более щепетильны и не пропустят запрос, выдав код ошибки 403 Permission Denied. На этом этапе устанавливается взаимодействие между клиентом и сервером относительно ожидаемого типа данных в запросе и ответе. Эта проверка заголовков реализована для снижения рисков нарушений безопасности и общих попыток взлома, поэтому лучше указывать эти заголовки, чтобы избежать проблем во время использования.

Заворачивать

Выполнение тестирования API вместе с другими типами тестирования, включая регрессионное, дымовое тестирование и, конечно же, модульное тестирование во время спринтов разработки, поможет ускорить выпуск вашего программного обеспечения. Логика проста: чем раньше будет замечена ошибка, недоработка или несоответствие бизнес-требованиям, тем проще ее исправить. И, как результат, предоставить первоклассный опыт вашим конечным пользователям, которые смогут наслаждаться взаимодействием с вашим программным обеспечением без непредвиденных ошибок в процессе, тем самым принося больше прибыли вашему бизнесу.