spring boot中整合swagger2

1、引入包

<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>

2、添加spring boot web依赖包

<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
</dependency>

3、添加swagger配置文件，重写WebMvcConfigurer的addResourceHandlers方法是因为在整合后，访问接口文档页面提示404，找不到文件，所以这里要指定接口文档的静态文件地址。

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
@ComponentScan(basePackages = {"swagger2.demo"})
@EnableWebMvc
public class Swagger2Config implements WebMvcConfigurer{
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .paths(PathSelectors.any())
                .build();
    }



    private ApiInfo apiInfo() {
        Contact contact = new Contact("Rolay", "https://www.cnblogs.com/rolayblog/", "pengbenleihehe@outlook.com");
        return new ApiInfoBuilder()
                .title("spring boot swagger2")
                .termsOfServiceUrl("https://www.cnblogs.com/rolayblog/")
                .description("接口文档示例")
                .contact(contact)
                .version("1")
                .build();

    }
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/**")
                .addResourceLocations("classpath:/static/");

        registry.addResourceHandler("swagger-ui.html")
                .addResourceLocations("classpath:/META-INF/resources/");

        registry.addResourceHandler("/webjars/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/");
    }

}

4、添加controller，在这里要说一下，dont-speak方法我没有加swagger的注解。

import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiOperation;
import org.springframework.util.Assert;
import org.springframework.util.StringUtils;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/hi")
public class SayHiController {

    @ApiOperation(value="say hi", notes="say hi to name")
    @ApiImplicitParam(name = "name", value = "name", paramType = "string", required = true)
    @GetMapping("/hello")
    public String sayHi(String name)
    {
        Assert.isTrue(!StringUtils.isEmpty(name),"name must be not null");
        return  "hi "+name+"!nice to meet you!";
    }
    @GetMapping("/dont-speak")
    public String dontSpeak(String name)
    {
        Assert.isTrue(!StringUtils.isEmpty(name),"name must be not null");
        return "shut up! "+name+"!";
    }
}

5、访问http://localhost:8080/swagger-ui.html

6、可以看到，生成了两个Controller的文档，而在实际的开发过程中可能dont-speak并不想在接口文档中显示，我们可以在配置类中做修改，自定义规则。

import com.google.common.base.Predicate;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import static com.google.common.base.Predicates.or;
import static springfox.documentation.builders.PathSelectors.regex;

@Configuration
@EnableSwagger2
@ComponentScan(basePackages = {"swagger2.demo"})
@EnableWebMvc
public class Swagger2Config implements WebMvcConfigurer{
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .paths(paths())
                .build();
    }

    private Predicate<String> paths() {
//        Predicate<String> paths=or(regex("/hi.*|/test.*"));
        Predicate<String> paths=or(regex("/hi.hello"));
        return paths;
    }

    private ApiInfo apiInfo() {
        Contact contact = new Contact("Rolay", "https://www.cnblogs.com/rolayblog/", "pengbenleihehe@outlook.com");
        return new ApiInfoBuilder()
                .title("spring boot swagger2")
                .termsOfServiceUrl("https://www.cnblogs.com/rolayblog/")
                .description("接口文档示例")
                .contact(contact)
                .version("1")
                .build();

    }
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/**")
                .addResourceLocations("classpath:/static/");

        registry.addResourceHandler("swagger-ui.html")
                .addResourceLocations("classpath:/META-INF/resources/");

        registry.addResourceHandler("/webjars/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/");
    }

}

可以看到规则使用正则表达式来匹配，可以根据自己的要求来修改。