В данном видео мы поговорим о способах представления требований и документации к REST API. Посмотрим на пример шаблона описания требований к веб-сервису. Узнаем базовую информацию про стандарт OpenAPI для создания спецификации на REST-сервис и разберем пример такой спецификации, сгенерированный при помощи инструмента Swagger.
Наши курсы по тестированию - https://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 - https://itnan.ru/post.php?c=1&p=667884
OpenAPI - https://www.openapis.org/
Swagger Petstore - https://petstore.swagger.io/
Javadoc - https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html, https://www.baeldung.com/javadoc
Примеры документации и API
Weather API - https://openweathermap.org/api
Any API - https://any-api.com/
API list - https://apilist.fun/
Public API - https://github.com/public-apis/public-apis
Google API Explorer - https://developers.google.com/apis-explorer?hl=ru
Vikunja API - https://try.vikunja.io/api/v1/docs#section/Authorization
Наши соц.сети:
Website: https://www.qabuggage.com/
Telegram: https://t.me/qabuggage
#багажтестировщика #тестирование #qa