OpenAPI спецификации — это набор инструкций и инструментов, который описывает взаимодействие для Rest-приложений. Она не зависит от языков программирования и может использоваться на большом количестве проектов. OpenAPI рассматривается как универсальный интерфейс для пользователей (клиентов) по взаимодействию с сервисами (серверами). Получалось, что все члены команды имели разные подходы к автоматизации тестирования. К тому же есть ещё одна важная проблема — наши REST API активно развиваются. Это означает, что при новых релизах в наших сервисах нам нужно править тестовый клиент.
Поэтому важно проводить тестирование производительности API и выбирать оптимальные методы запросов в каждой конкретной ситуации. Бывает так, что проект автотестов не компилируется из-за изменений спецификации сервиса. Необходимо понимать, почему это происходит. Для этого нам надо получить разницу в документации, например, используя swagger-diff. Для тестировщиков головная боль — именование тестовых методов и тестовых классов.
Relaxation Api
Это произошло в связи с независимым развитием Swagger Codegen three.X и Swagger Codegen 2.X. Из-за этого нарушилась обратная совместимость. Очень много клиентов исчезли и не были поддержаны. И ещё одна причина ручное тестирование api — это нестабильность релизного цикла. Релизы в Swagger Codegen были довольно редкие, тесты часто падали и комьюнити это не устраивало. Наш Swagger UI и строится на основе этого файла спецификации — swagger.json.
Переходим на вкладку Authorization, указываем данные для идентификации пользователя. Postman поддерживает множество типов авторизации, параметры для каждого из них отличаются. Используем авторизацию по API Key, полученному из личного кабинета в Test IT. Чтобы рассказать, как использовать Postman, напишем несколько тестов на базе реального проекта, используя для этого API системы управления тестированием Test IT. Представьте, что вы сидите в ресторане, выбираете блюдо в меню.
Урок Three — Изучаем Swagger При Помощи Petstoreswaggerio
Это может быть JSON, которая понятна для машин и не очень понятна для человека и YAML-спецификация, которая более или менее читаема для человека.
OpenAPI-спецификацию часто можно встретить в формате JSON для определения «объектов», «массивов», «свойств», «полей» и так далее. Мы решили, что нам нужен инструмент, который позволит измерить это покрытие на основе OpenAPI-спецификации. Я хочу рассказать про Swagger-coverage, который мы недавно реализовали.
А тот в ответ отправляет найденные в базе данных товары. Мы познакомились с отправкой и параметризацией запросов, а когда же приступим к тестированию? Мы на пороге написания первого теста в Postman. Теперь создадим другое окружение, с другими URL и token, и поменяем их с помощью переключения в выпадающем списке. Протестируем продукт на двух разных окружениях, используя одну коллекцию запросов.
Когда мы посылали запрос методом POST, нам нужно было указать данные. Она принимает разные типы данных, выбор решения будет зависеть от API. Когда пользователь ищет товар в интернет-магазине, код фронтенда посылает запрос к API сайта.
Если лицевую часть приложения просто открывают в браузере и имитируют шаги пользователя, то получить доступ к бэкенду нельзя, так как визуального интерфейса у него нет. В запросе убираем продублированную проверку, а на вкладке авторизации укажем «Inherit auth from parent». Чтобы программам общаться между собой, их API нужно построить по единому стандарту. Одним из них является REST — стандарт архитектуры взаимодействия приложений и сайтов, использующий протокол HTTP.
В правой части она у вас отображается в красивом виде. Человеческая жизнь слишком коротка, чтобы тратить ее на https://deveducation.com/ интеграцию и документацию. Тесты — это скрипты, которые помогают удостовериться, что API работает корректно.
Преимущества Postman
Они должны ловить такие случаи, но сейчас получается, что всё работает. Чтобы отлавливать такие случаи, мы используем diff-спецификации, о которых чуть позже. Ещё вариант — поиск с множеством параметров.
Также вы получите другие различные проблемы. Например, опечатки, потому что Swagger Annotation пишется руками разработчиков. Опечатки можно поправить — это не проблема. Могут быть различные проблемы с повторением моделей. Это достаточно легко решается, если к модели добавить имя пакета. И ещё одна проблема — неполнота спецификаций.
Главное, для чего создавался клиент, — чтобы добавление нового в спецификацию почти никогда не ломало компиляцию клиента. Понятно, что если мы добавим параметры, как я рассматривал раньше, всё будет хорошо. В том же REST Assured мы использовали builder-паттерн, и у каждого вызова параметра собственный метод.
- Самое приятное, что всё это легко исправляется.
- Этого метода в API api.pet нет — и получаем ошибку компиляции.
- Это означает, что при новых релизах в наших сервисах нам нужно править тестовый клиент.
- Теперь создадим другое окружение, с другими URL и token, и поменяем их с помощью переключения в выпадающем списке.
- Поменяется только одна константа внутри нашей операции.
Подробнее узнать про инструменты создания документации и познакомиться с правилами коммерческой разработки вы можете на курсах. Мы уже упоминали этот компонент выше — он может генерировать код на основе правил. Автоматически сгенерированный код решает только шаблонные задачи, так что Codegen не заменяет программиста, но серьезно облегчает ему задачу. OpenAPI — универсальный инструмент, который используется для решения задач разработчиков и аналитиков. Но и тестировщики могут применить его для повышения эффективности работы.
Вы можете создавать запросы REST, SOAP и GraphQL. Инструмент поддерживает множество протоколов авторизации (я расскажу об этом позже) и управление сертификатами. Пожалуйста, посетите официальный сайт, чтобы узнать больше. Swagger используется, когда, например, разработчику нужно свериться с документацией при доработке продукта, или он хочет сгенерировать ее из кода. Иногда требуется обратный процесс — генерация кода на основе документации, возможная благодаря компоненту Swagger Codegen.
Кстати, Swagger было первичным оригинальным названием OpenAPI. Между POST и PUT запросами скорость также зависит от конкретной ситуации. Если требуется создание нового объекта, то используется POST-запрос, который может быть быстрее, если передача данных в теле запроса не занимает много времени. Если требуется обновление объекта, то используется PUT-запрос, который может быть быстрее, если изменения касаются большинства полей объекта. Между PATCH и DELETE запросами скорость также зависит от логики сервера и конкретной ситуации. Оба запроса могут работать быстро, если используются оптимальные методы обработки данных на сервере.
Официант передаёт ваш заказ на кухню, там происходит магия, и через некоторое время перед вами появляется готовое блюдо. API работает по такому же принципу — принимает ваш запрос, передаёт информацию системе, обрабатывает её и возвращает ответ. API — это Application Programming Interface, или программный интерфейс приложения, с помощью которого одна программа может взаимодействовать с другой. API позволяет слать информацию напрямую из одной программы в другую, минуя интерфейс взаимодействия с пользователем.
В Postman есть встроенный компонент Collection Runner, с его помощью можно запустить наполненную запросами и тестами коллекцию. Postman автоматически добавил код на JS, который проверяет, что код ответа равен 200. В ранее созданном запросе выделим в переменные два параметра — URL стенда, к которому мы обращаемся, и токен для авторизации. Создаём две переменные url и token и укажем их значения. На скриншоте ниже их значения скрыты из соображений безопасности.
Вам надо только добавить набор mustache-шаблонов, и у вас готовый клиент. И третья очень крутая фича — эти клиенты очень легко кастомизировать. Достаточно добавить свои шаблоны, которые просто будут использоваться при генерации. Там есть и клиент, и тест, даже скрипт, который пушит код на GitHub. По факту этот проект уже можно использовать. Но как только вы его начнёте использовать, то поймёте, что что-то идёт не так.
В качестве библиотеки мы выбрали REST Assured. Она имеет fluent interface, эта библиотека предназначена для тестирования. В ней есть механизм Request specification и Response specification. То есть у нас получается два , для версии v1 и для версии v2.
Спецификация — набор правил, которые описывают, как должна выглядеть и работать та или иная технология. Это теоретический «каркас» для будущего программного проекта. На его основе пишется код, реализация, которая работает по описанной в спецификации логике. Соответственно, OpenAPI — это набор правил и стандартов для описания API. Мы знаем, какие операции у нас полностью покрыты, какие частично, какие вообще не покрыты. Также, если мы рассмотрим подробнее операцию, то увидим условия.
