Как работать со Swagger

Для работы с API bnMAP.pro можно воспользоваться инструментом Swagger.

Ссылка на Swagger bnMAP.pro:

https://swagger.apdocs.bndev.it/

Описание функциональностей Swagger

Swagger предоставляет:

• информацию о доступных к использованию серверах, конечных точках и методах
• подробное описание каждого метода: список параметров, формат запроса и ответа, пример и схему ответа
• возможность протестировать любой из доступных методов в интерфейсе сервиса

Тестирование API

Swagger позволяет протестировать API - посмотреть ответ сервера в интерфейсе сервиса.

Для этого нужно выбрать сервер и метод и нажать на кнопку Try it out.

После этого нужно ввести необходимые параметры запроса в соответствующие поля ввода и нажать кнопку Execute.

На выполнение запроса требуется время, длительность выполнения запроса зависит от объема передаваемых данных.

Для ограничения длительности выполнения запросов в API bnMap.pro добавлены специальные параметры, позволяющие выгружать данные постранично. В таком случае общее количество страниц будет указано в ответе сервера.

После выполнения запроса сервис отобразит ответ сервера в интерфейсе Swagger в разделе Responses под заголовоком Server response.

Пользователю доступна возможность скачать результат ответа из интерфейса, нажав на кнопку Download в конце окна ответа, и скопировать результат в буфер обмена.