#spring-boot #yaml #swagger-2.0
#spring-boot #yaml #swagger-2.0
Вопрос:
Пытаюсь сгенерировать документацию API для приложения spring boot с использованием swagger. Использование swagger-maven-plugin для генерации документации yaml из кода. После компиляции сгенерированный файл yaml / json не содержит никакого пути. Однако класс контроллера, в котором определены API, сканируется. Но ни один из определенных там API не отображается в документации. Однако доступ http://localhost:8080/api-docs показывает json, в котором перечислены все API, как и ожидалось. В чем может быть проблема? Я убедился в следующем:
- контроллер аннотируется с помощью @Api
- значение тега равно false в pom.xml
- базовый путь одинаков для pom и класса контроллера
Все пути API имеют вид http://localhost:8080 /{идентификатор}/
Ответ №1:
Моя проблема решена. Методы класса контроллера не были объявлены общедоступными и, следовательно, не отображались в swagger.файлы yaml и json, хотя в api-документах они перечислены.
Ответ №2:
Попробуйте сопоставить ваш контроллер с путем. Например: — @Controller @RequestMapping(значение = «/api»)
Для получения дополнительных разъяснений вы можете обратиться к этой статье: https://www.baeldung.com/spring-controllers
Комментарии:
1. ДА. Это также уже сделано. Поскольку API-интерфейсы имеют вид localhost:8080 {id}, я добавил @Controller @RequestMapping(значение = «/»)