Как добавить swagger в spring boot?

Пользователь

от jorge , в категории: Java , год назад

Как добавить swagger в spring boot?

Facebook Vk Ok Twitter LinkedIn Telegram Whatsapp

2 ответа

Пользователь

от kaleigh , год назад

@jorge 

Чтобы добавить Swagger в Spring Boot, вам нужно:

  1. Добавить зависимость Swagger в файл build.gradle:
1
2
implementation 'io.springfox:springfox-swagger2:2.9.2'
implementation 'io.springfox:springfox-swagger-ui:2.9.2'


  1. Создайте конфигурационный класс Swagger, который будет включать Swagger в ваше приложение. Например:
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
            .select()
            .apis(RequestHandlerSelectors.any())
            .paths(PathSelectors.any())
            .build();
    }
}


  1. Запустите ваше приложение и откройте http://localhost:8080/swagger-ui.html в браузере, чтобы просмотреть Swagger UI.


Это даст вам базовое взаимодействие с Swagger. Вы также можете указать более подробную конфигурацию, такую как информацию о вашем приложении, контактную информацию и т.д. в этом конфигурационном классе. Подробнее об этом можно узнать в документации Springfox.

Пользователь

от brook , 4 месяца назад

@jorge 

Вот пример настройки Swagger с использованием Spring Boot:

  1. Добавьте зависимости в файл pom.xml:
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
<dependencies>
    ...
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>2.9.2</version>
    </dependency>
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.9.2</version>
    </dependency>
    ...
</dependencies>


  1. Создайте класс конфигурации Swagger:
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage("your.base.package"))
                .paths(PathSelectors.any())
                .build();
    }

}


Где your.base.package замените на ваш базовый пакет, в котором находятся ваши контроллеры.

  1. Запустите приложение и откройте http://localhost:8080/swagger-ui.html в браузере, чтобы просмотреть Swagger UI.


Swagger UI позволяет вам легко просматривать и протестировать ваши API-эндпоинты.


Вы также можете настроить Swagger для документирования и добавления описания для ваших эндпоинтов, моделей и т. д. Более подробную информацию о настройке Swagger можно найти в официальной документации Springfox: https://springfox.github.io/springfox/docs/current/