Що таке Swagger?

Мітки: QA Tools QA Automation

Хто хоч раз тестував свій WebAPI знає такі інструменти, як Postman або Advanced REST.

Swagger – це технологія, яка дозволяє документувати REST-сервіси.

Swagger підтримує безліч мов програмування і фреймворків. Також Swagger надає UI для перегляду документації, зрозумілому для користувача і комп’ютера.

Але Swagger – це не просто специфікація. Основна його перевага полягає в додаткових інструментах . Для нього існує величезна кількість безкоштовних утилітів, які можуть зробити життя QA трохи простішим. Ви можете встановити все це на свої власні сервера і подивитися, як це працює.

А можете переглянути Вебінар: Запити АРІ з Swagger і без за документацією з Олександром Панченком!
Він планується бути МАКСИМАЛЬНО практичним для Вас.
Після вебінару ви зможете налаштувати Swagger документацію для API, а також написати круту документацію для чергового свого проекту.

Як це працює?

У кожного сервісу у певній папці лежить файл зі Swagger описом і зберігається це все прямо в git-репозиторії. Описи можуть бути як згенеровані за допомогою Swagger generator, так і записані туди вручну. Їх легко розпарсити, і в процесі побудови проекту ми можемо автоматично перевіряти відповідність REST endpoints і документації.

Завдання Swagger полягає у збиранні файлів з усіх мікросервісів, вносити деякі мінімальні модифікації (дедублікація, видалення непотрібних атрибутів) і на виході генерує єдиний Swagger файл, який містить повну актуальну інформацію для всього проекту.

Централізоване зберігання і редагування документації – це тільки перший крок. Наступний – зробити її доступною для всіх розробників, тестерів та інших зацікавлених осіб.І Swagger UI – це саме те, що вам для цього знадобиться. За допомогою невеликої JavaScript бібліотеки Swagger UI генерує HTML елементи для всіх ваших REST endpoints, які надалі можна впорядковувати за допомогою HTML розмітки.

Це був короткий огляд, метою якого було надати загальну картину того, що таке Swagger, навіщо він потрібен і які основні плюси він дає, а попрактикуватись та задати свої запитання ви зможете на вебінарі з Олександром Панченко

Курси та події

Публікації

Відео