[Перевод] Тестирование API — проблемы и решения
Что такое API:
В разработке приложений термин API (интерфейс прикладного программирования) представляет собой промежуточный слой между графическим интерфейсом и уровнем базы данных. API-интерфейсы служат для установления связи и обмена данными между различными программными компонентами, обеспечивая эффективное взаимодействие между ними.
Что такое тестирование API:
Тестирование API представляет собой разновидность тестирования программного обеспечения, направленную на проверку соответствия разработанного API ожиданиям в контексте его функциональности, производительности, надежности и безопасности в приложении.
Почему требуется тестирование API:
Тестирование API проводится с целью верификации правильности и структурированности выходных данных, поступающих из первичного приложения или базы данных, и их пригодности для использования другим приложением. Это тестирование направлено на анализ возвращаемых значений, преимущественно ответов. Нам необходимо проверить, сколько времени требуется API для получения данных, какой тип аутентификации необходим, и передается ли конфиденциальная информация по сети безопасным образом и так далее.
Бизнес-запрос:
В контексте бизнес-запросов отмечается, что мы наблюдаем значительный рост компаний, использующих API.
API представляет собой фундаментальный элемент индустрии электронной коммерции, играющий ключевую роль в информационных технологиях, банковском секторе, финансовой сфере, страховании, компьютерном оборудовании, программном обеспечении, розничной торговле, здравоохранении и телекоммуникациях.
API тесты проходят значительно быстрее, чем функциональные тесты графического интерфейса, что обеспечивает проверку основной функциональности и позволяет легко интегрировать их с тестированием графического интерфейса. Однако в связи с увеличением спроса на API возникают определенные проблемы в процессе его тестирования.
Настройка API
Тестирование API может осуществляться как вручную, так и с использованием автоматизации тест-кейсов для оценки различных компонентов и параметров рабочего фреймворка. Автоматизированное тестирование способствует сокращению объема ручной работы, выявляя и автоматизируя частые проверки. Это включает в себя настройку системы API, создание и выполнение тестов что может быть трудоемкой задачей для тестировщика. Однако, после завершения первоначальной настройки инфраструктуры тестирования и готовности скриптов, можно начать проверку данных приложений с использованием запросов и тестов API, которые выполняются эффективно.
Тестовое покрытие
Поскольку внешний интерфейс приложения (GUI) недоступен, а тестирование API имеет дело с end points, следовательно, тестовое покрытие или тест-кейсы должны быть написаны должным образом, охватывая все возможные комбинации. Но сложность возрастает при увеличении количества параметров. Вот несколько важных моментов, которые следует учитывать.
Частое обновление схемы тестирования API
Одной из самых больших проблем тестирования API является частое обновление схемы на протяжении всего процесса тестирования. Для начала разберемся, что такое Schema, это форматирование данных, которое обрабатывает запросы и ответы для API. Вам необходимо настроить схему для проверки параметров ответа, таких как мок сервера, документация, тесты и т. д. Всякий раз, когда вносятся изменения, такие как добавление новых функций или обновление существующих, нам необходимо соответствующим образом обновить схему.
Решение заключается в том, чтобы проводить всесторонние тесты API в альфа- и бета-окружениях, что позволит снизить вероятность проблем на 80–90% при их тестировании в этих окружениях.
Тестирование всех возможных комбинаций
Красота API заключается в том, как он обеспечивает эффективное взаимодействие между системами. Обмен данными между API и системами осуществляется через передаваемые между ними данные. Эти данные присваиваются параметрам, которые затем передаются через запросы, и важно проверять эти параметры на соответствие данным. Таким образом, важно тестировать все возможные комбинации запросов параметров в API.
Для проверки этих параметров необходимо учитывать их тип данных, соответствие заданной длине и диапазону, а также проводить другие соответствующие проверки.
Включение методов исключения на основе ограничений с инструментами попарного тестирования, комбинаций граничных значений и классов эквивалентности обеспечит хорошее покрытие тест-кейсов.
Вы также можете внедрить системы непрерывного мониторинга API, которые обеспечат быструю проверку ошибок в системах.
Определите приложения, которые не являются сложными для повседневных операций. Таким образом, вы можете увидеть, как используется API, а также любые изменения конфигурации, необходимые для выпуска общедоступной версии.
Валидация параметров командой тестирования
Валидация параметров является одним из основных аспектов тестирования API, но в то же время представляет собой сложную задачу. Она должна демонстрировать, насколько быстро вы обрабатываете эти параметры. Команда должна быть уверена, что каждый важный параметр данных использует соответствующий строковый или числовой тип данных, соответствует установленному диапазону значений, соответствует ограничениям по длине и проходит другие критерии валидации.
Последовательность вызовов API
Вызовы API должны выполняться в упорядоченной последовательности, соответствующей функциональности. Именно здесь команды тестирования сталкиваются с проблемой упорядочения вызовов API.
Например, для размещения заказа на товар. Серия вызовов включает в себя вход в систему на веб-сайт → поиск конкретного товара → выбор товара → добавление товара в корзину → размещение заказа.
Здесь вывод одного API используется в качестве входных данных для следующего API, и любое расхождение в порядке вызовов API приводит к функциональным изменениям в системе. Это становится более сложным, когда в работе участвуют многозадачные приложения. Мы должны проверять эти последовательности при каждом изменении функциональности приложения.
Системная интеграция
Системная интеграция обеспечивает правильную работу системы API с системой отслеживания данных. Например, платформа отправлений, использующая API отслеживания отправлений, который представляет всю информацию по доступным перевозчикам и внешней платформе. Здесь нам нужно проверить все ответы, чтобы убедиться, что вызов работает правильно. Эта информация используется для измерения производительности API. Чтобы проверить это эффективно, на этапе проектирования нам нужно сосредоточиться на том, какие и насколько хорошо приложения интегрированы с другими системами. Реализация нагрузочного тестирования в CI/CD помогает решить эту задачу.
Ограниченное время
Когда временные рамки разработки ограничены, существует вероятность предоставления API низкого качества. Это увеличивает количество дефектов на этапе тестирования, что приводит к возвращению команды и устранению проблемы. Таким образом, правильная оценка и надлежащие сроки на этапах разработки и тестирования могут помочь свести этот риск к минимуму.
Обновления фреймворка
Одной из существующих проблем является возможное воздействие любых изменений в дизайне продукта или функциональности на существующую платформу автоматизации API. Следовательно, ретроспективный пересмотр существующих сценариев и их обновление становятся трудоемкой задачей в случае значительных изменений. Решением может быть регулярное обновление и пересмотр фреймворка с целью проверки его совместимости с тестированием API. Важно удостовериться, что фреймворк поддерживает расширение, выполнение тестов графического интерфейса, а также способен использовать инструменты управления сборками и библиотеки API.
10. Выбор инструментов
В настоящее время на рынке представлено множество инструментов, однако не все из них поддерживают функциональное, мобильное и тестирование безопасности API. Инструменты, такие как Postman, Soap-UI, Katalon, Apigee Studio, могут обеспечивать end-to-end тестирование API. Таким образом, требуется тщательное сравнение доступных инструментов, что помогает выбрать наилучший инструмент для вашего проекта.
Коммуникация
Существует вероятность недопонимания между разработчиками и тестировщиками, когда новая версия выпускается без закрытия предыдущей, и это может быть одной из причин риска безопасности, поскольку хакер может получить доступ к предыдущим параметрам и получить доступ к API, что может привести к утечке конфиденциальной информации. Таким образом, правильная коммуникация между командами по открытым каналам помогает свести к минимуму проблемы с безопасностью и сэкономить время.
Вывод:
Тестирование API в настоящее время переживает бум во всех отраслях. Несмотря на то, что мы сталкиваемся с многочисленными проблемами в тестировании API, давайте попробуем снизить риск, внедрив упомянутые выше решения и создав успешные системы API.
