Создание документов API с помощью плагина OpenAPI Maven
Я пытаюсь создать конечную точку документов API (например, /v3/api-docs) для приложения Spring REST, созданного из yaml OpenAPI 3.
Я заметил, что Плагин Maven имеет флаг generateApiDocumentation, хотя
Я не совсем уверен, что он делает.
К сожалению, СпрингФокс еще не поддерживает OpenAPI 3, а также было бы бессмысленно иметь генератор на основе отражения, когда все, что я хочу сделать, это предоставить исходный yaml как json.
Ответы 2
Я не уверен, что понял ваш вопрос, но могу попробовать проверить эту статью: https://www.baeldung.com/spring-rest-openapi-documentation
Также вы можете проверить документацию https://github.com/springdoc/springdoc-openapi
В основном вам просто нужно добавить эту зависимость maven
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-ui</artifactId>
<version>1.2.32</version>
</dependency>
После этого, когда вы запускаете свой сервис, вы можете проверить свой хост по пути: /swagger-ui.html в таком виде:
http//localhost:8080/swagger-ui.html
Я ожидаю, что помогу вам.
https://springdoc.org/faq.html
Как правильно настроить пользовательский интерфейс Swagger для использования предоставленного spec.yml?
С помощью этого свойства все bean-компоненты автоматической настройки springdoc-openapi отключены:
springdoc.api-docs.enabled=false
Затем включите минимальную конфигурацию bean-компонентов, добавив этот Bean-компонент:
@Bean
SpringDocConfiguration springDocConfiguration(){
return new SpringDocConfiguration();
}
@Bean
public SpringDocConfigProperties springDocConfigProperties() {
return new SpringDocConfigProperties();
}
Затем настройте путь к вашему пользовательскому файлу yaml пользовательского интерфейса.
springdoc.swagger-ui.url=/my-api-docs.yaml
В этом случае вы должны поместить 'my-api-docs.yaml' в папку 'источник/основной/ресурсы/статические/'!