Адрес фактического центра электронной коммерции SpringBoot (40k+star):GitHub.com/macro-positive/…
Резюме
При использовании Swagger у вас возникает такое ощущение: отправленные параметры JSON и не могут быть отформатированы, параметры неверны и их сложно найти, возвращаемые результаты не могут быть свернуты, и это слишком долго для чтения! Эта ситуация сильно изменилась после использования Swagger в сочетании с Postman.Сегодня мы поговорим о том, как использовать Postman для расширения функций Swagger, и я надеюсь, что это будет полезно для всех!
Использование почтальона
Postman - это очень простой в использовании инструмент для отладки интерфейса. У него красивый интерфейс и мощные функции. Если вы не знаете Postman, то можете его прочитать.«Почтальон: инструмент отладки интерфейса API».
Использование Swagger с почтальоном
Ниже описано, как импортировать API Swagger в Postman, а затем использовать Postman для отладки интерфейса.
Импорт Swagger API Почтальон
- Во-первых, нам нужно запустить проект приложения, который использует Swagger, вот предыдущий
mall-tiny-swaggerПроект в качестве примера, найтиapi-docsПуть, адрес доступа:http://localhost:8088/swagger-ui/
- Что такое чванство
api-docsпуть доступа? Этот путь будет возвращать данные в формате JSON. Все данные для Swagger для рендеринга страницы документа API в приложении берутся отсюда. Почтальон также может использовать эти данные для рендеринга страницы документа API. Здесьapi-docsАдрес:http://localhost:8088/v2/api-docs
- нажмите в почтальоне
importкнопка, выберитеLink, введите Сваггерapi-docsПуть может импортировать интерфейс, сгенерированный Swagger, в Postman;
- Вы можете напрямую использовать параметры по умолчанию для импорта без изменений;
- После успешного импорта интерфейс в Swagger появится в Postman, а дальше нужно только изменить параметры в Postman, чтобы начать отладку интерфейса, не правда ли очень удобно!
Почтальон устанавливает переменные среды
- Мы случайным образом находим интерфейс для доступа, мы обнаружим, что доступ неправильный, потому что
baseUrlЕсть проблема с настройкой этой переменной окружения, из-за чего интерфейс становится недоступным;
- Мы просто установили его в Postman
baseUrlДоступ к этой переменной среды возможен в обычном режиме;
- После добавления переменных среды необходимо выбрать подходящую среду для применения.
Доступ к интерфейсу, для которого требуется аутентификация при входе
- В это время, если вы снова получите доступ к интерфейсу, вы обнаружите, что наш интерфейс требует аутентификации при входе в систему для нормального доступа к нему;
- Мы можем сначала вызвать интерфейс входа в систему, чтобы получить токен;
- Добавить в интерфейс, требующий авторизации при входе
Bearer Tokenтип токена, мы можем обнаружить, что нам нужно настроитьtokenпеременные окружения;
- добавить в переменную окружения
token;
- После добавления переменных среды вы обычно можете получить доступ к интерфейсу, который требует аутентификации входа.
Каковы недостатки
Этот метод использует Postman для отладки интерфейса, он очень мощный, но немного слаб для возможности отображения документов.
- Например, интерфейс в Swagger имеет очень полную аннотацию для параметров запроса и возврата;
- Почтенно, эта информация о документе не отражена. Почтальон - это только инструмент отладки интерфейса в конце концов.
Суммировать
Лучше использовать Swagger и Postman в комбинации, Swagger используется для просмотра информации документа интерфейса, а Postman — для отладки, Импорт интерфейса из Swagger в Postman может компенсировать недостатки Swagger в отладке интерфейса.
Адрес исходного кода проекта
Эта статьяGitHubGitHub.com/macro-positive/…Записано, приветствую всех на Star!