Требования и документация к REST API. OpenAPI, Swagger
Вставка
- Опубліковано 1 сер 2024
- В данном видео мы поговорим о способах представления требований и документации к REST API. Посмотрим на пример шаблона описания требований к веб-сервису. Узнаем базовую информацию про стандарт OpenAPI для создания спецификации на REST-сервис и разберем пример такой спецификации, сгенерированный при помощи инструмента Swagger.
Наши курсы по тестированию - www.qabuggage.com/courses
Таймкоды:
00:00 - О чем пойдет речь в выпуске
00:39 - Что такое требования к REST API
01:17 - Требования по шаблону, пример
02:08 - Описание требований в свободной форме, пример
03:22 - Документация на REST API
05:08 - Создание документации по стандартам, OpenAPI, пример спецификации
07:10 - Swagger, разбор примера документации в Swagger UI
12:07 - Создание документации из аннотаций в коде, Javadoc
12:55 - Публичная документация на REST API, пример
13:43 - Примеры публичных API
Источники из видео:
Шаблон требований к REST API - itnan.ru/post.php?c=1&p=667884
OpenAPI - www.openapis.org/
Swagger Petstore - petstore.swagger.io/
Javadoc - docs.oracle.com/javase/7/docs..., www.baeldung.com/javadoc
Примеры документации и API
Weather API - openweathermap.org/api
Any API - any-api.com/
API list - apilist.fun/
Public API - github.com/public-apis/public...
Google API Explorer - developers.google.com/apis-ex...
Vikunja API - try.vikunja.io/api/v1/docs#se...
Наши соц.сети:
Website: www.qabuggage.com/
Telegram: t.me/qabuggage
#багажтестировщика #тестирование #qa
Thanks for your work! Well done!
Thanks for the feedback :)
Здравствуйте! Подскажите, пожалуйста, является ли необходимым и достаточным ссылка на swagger и 'креды' для подключения к бд сервиса при тестировании api? Необходимо ли при тестировании например метода post после выполнения идти в базу данных и проверять запись данных? Или достаточно проверить через get?
Здравствуйте! Подробно эти вопросы мы разбираем в видео ua-cam.com/video/0JJx3SrZN1Y/v-deo.html
Если коротко.
При тестировании rest api вам нужна ссылка на swagger или другую документацию по api, ссылка на стенд, на котором это api развернуто (может быть и локально), инструмент для выполнения запросов (SwaggerUI, Postman и т.д.), с большой долей вероятности нужно будет разобраться с авторизацией (как получить токен, каким образом он передается в запросе) и получить доступ к базе данных.
Мы рекомендуем хотя бы 1 раз проверить данные в бд после создания объекта методом post. Потому что в методе get могут быть ошибки. И без доступа к базе вы можете не разобраться, в каком именно методе в итоге ошибка - post или get. Плюс метод/ы get могут возвращать не все данные, которые были записаны в базу в результате выполнения метода post.
@@qabuggage спасибо большое!