...
Інтерфейс користувача Swagger надає Фреймворк, який читає особливості OpenAPI та створює веб-сторінку з інтерактивною документацією.
Авторизація запиту
...
The Swagger user interface provides a framework that reads OpenAPI specifications, and then creates a web page with interactive documentation.
...
Request authorization
...
Authorization is required before making any requests. Press the Authorize button and complete the required information in the Authorization window shown below.
For the production environment: https://secure.ubki.ua/m2/webjars/swagger-ui/index.html?url=/m2/api
...
Для тестового середовищаFor the test environment:https://test.ubki.ua/m2/webjars/swagger-ui/index.html?url=/m2/api
...
Доступ до сервісів УБКІ здійснюється за наявності чинного сесійного ключа Access to the UBCH services is provided with a valid session key https://wiki-ubki.atlassian.net/wiki/spaces/SpecSpecification/pages/123666599124911935
...
...
Request generation
...
Розгортаємо кінцеву точку Expand the GET/data/{poolId}/journal -Журнал роботи пулу
Натискаємо кнопку endpoint – Pool operation log. Press the Try it out button
...
Після натискання кнопки Try it out значення прикладу в полі «Параметри» або «Тіло запиту» стане доступним для редагування
After pressing the Try it out button, you can edit the sample values in the Parameters or Request Body field.
...
При натисканні Execute інтерфейс користувача Swagger відправляє запит і вказує відправлений curl. Розділ Responses показує відповідь.
У списку Response content type, формат відповіді буде у форматі JSON.
...
Відповідь на запит
...
...
Приклад відповіді та опис
...
До кожного запиту додано приклад відповіді.
Schema-опис полів відповіді (dto)
В кінці сторінки swagger знаходиться Schemas опис параметрів. Див. у цьому розділі також When you click Execute, the Swagger user interface sends a request and specifies the sent curl. The response is shown in the Responses section.
The response format in the Response Content Type list will be in JSON format.
...
...
Response to a request
...
In response, we get the result of the request – Pool operation log. You can download the response by clicking Download.
...
Response sample and description
...
Response sample and description
Schema description of response fields (dto)
At the end of the swagger page, there is a Schemas description of parameters. Also see this section