Spring Boot 整合 Swagger

整合 Swagger

1. 在pom.xml中加入依赖

    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>2.9.2</version>
    </dependency>
    <!--swagger-ui-->
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.9.2</version>
    </dependency>

2. 添加swagger配置
   添加一个swagger配置类，在工程下新建config包并添加一个SwaggerConfig配置类。
   SwaggerConfig.java

package com.cnrmall.swaggerdemo.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {
   @Bean
   public Docket createRestApi(){
       return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
               .select()
               .apis(RequestHandlerSelectors.any())
               .paths(PathSelectors.any()).build();
   }

   private ApiInfo apiInfo(){
       return new ApiInfoBuilder()
               .title("SpringBoot API Doc")
               .description("This is a restful api document of Spring Boot.")
               .version("1.0")
               .build();
   }
}

注意



spring boot 使用了2.6，swagger使用了2.9.2由于两则版本不兼容，导致该错误，把spring boot降到2.5.6即可