Робота зі Swagger UI

Owned by Оксана Нечепоренко
Last updated: Aug 29, 2022
2 min read

 

Інтерфейс користувача Swagger надає Фреймворк, який читає особливості OpenAPI та створює веб-сторінку з інтерактивною документацією.

Авторизація запиту


Перш ніж робити будь-які запити, необхідна авторизація. Натискаємо кнопку Authorize та заповнюємо інформацію, необхідну у вікні «Авторизація», зображеному нижче.

Для бойового середовища:https://secure.ubki.ua/m2/webjars/swagger-ui/index.html?url=/m2/api

Для тестового середовища:https://test.ubki.ua/m2/webjars/swagger-ui/index.html?url=/m2/api

 

 

 

Доступ до сервісів УБКІ здійснюється за наявності чинного сесійного ключа https://wiki-ubki.atlassian.net/wiki/spaces/Spec/pages/123666599


 

Створення запиту

 

Розгортаємо кінцеву точку GET/data/{poolId}/journal -Журнал роботи пулу
Натискаємо кнопку Try it out

 

Після натискання кнопки Try it out значення прикладу в полі «Параметри» або «Тіло запиту» стане доступним для редагування.

 

 

 

 

При натисканні Execute інтерфейс користувача Swagger відправляє запит і вказує відправлений curl. Розділ Responses показує відповідь.

 

У списку Response content type, формат відповіді буде у форматі JSON.

 

Відповідь на запит

 

В відповіді отримуємо результат запиту- Журнал роботи пулу.
При натисканні Dowload відповідь можна завантажити.

 

 

Приклад відповіді та опис

 

До кожного запиту додано приклад відповіді.

 

 

 

 

 

 

 

 

 

 

Schema-опис полів відповіді (dto)

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

В кінці сторінки swagger знаходиться Schemas опис параметрів. Див. у цьому розділі також