SpringBootSwaggerStarter

В Spring-boot с помощью Swagger можно интегрировать Swagger в код без его внедрения.

Конфигурация проекта при использовании

Требуется использовать в проекте Spring Boot. Ниже представлено описание конфигурации с использованием Maven для сборки проекта и файла application.properties для настройки. При использовании других инструментов сборки или конфигурационных файлов необходимо внести соответствующие изменения.

Добавьте зависимость в конфигурационный файл Maven pom.xml:

<dependency>
    <groupId>cn.songxinqiang</groupId>
    <artifactId>swagger-spring-boot-starter</artifactId>
    <version>x.y.z.RELEASE</version>
</dependency>

Настройте информацию об API в файле application.properties:

swagger.api.name = # Информация о группе API
swagger.api.title = # Заголовок
swagger.api.description = # Описание
swagger.api.version = # Версия
swagger.api.contact.name = # Имя контактного лица
swagger.api.contact.url = # URL контактного лица
swagger.api.contact.email = # Электронная почта контактного лица
swagger.api.exclude-paths = # Исключаемые пути, разделенные запятыми

Для получения подробной информации обратитесь к блогу на сайте «Открытого Китая».

Настройка Swagger UI при использовании

Контроллер API будет прослушивать адрес v2/api-docs?group=<значение конфигурации swagger.api.name>. Для Swagger UI необходимо указать «базовый адрес» сервера как корневой адрес проекта.

Или можно просто добавить зависимость:

<dependency>
    <groupId>cn.songxinqiang</groupId>
    <artifactId>swagger-spring-boot-starter-ui</artifactId>
    <version>x.y.z.RELEASE</version>
</dependency>

Примечание

Этот компонент предназначен для использования в сценариях, где применяется Spring MVC. Он обрабатывает только аннотации @Controller, @RequestMapping и другие связанные с ними.

Основан на springfox-swagger2, этот компонент представляет собой простую конфигурацию. Спасибо им.