Springboot+Swagger2 三步构建简单优雅的API

一、依赖

<!--swagger依赖-->
<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger2</artifactId>
   <version>2.6.1</version>
</dependency>

<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger-ui</artifactId>
   <version>2.6.1</version>
</dependency>

二、配置

@Configuration
@EnableSwagger2
@Profile("dev") //只在开发环境开启
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.experience.controller"))
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("使用Swagger2构建简单优雅的API文档")
                .description("推荐RestFul风格")
                .termsOfServiceUrl("https://www.jianshu.com/u/564aed3405f5")
                .version("2.0")
                .build();
    }
}

提一嘴，Swagger支持在Controller上使用@ApiOperation、@ApiImplicitParam进行API的详细标注，但是为了避免代码侵入，最好不要进行以上操作。

三、Filter开放拦截

根据不同的过滤器，分别按照既定格式开放下方的url

registry.excludePathPatterns("/swagger-resources/**", 
                             "/webjars/**", 
                             "/v2/**",
                             "/swagger-ui.html/**");

然后启动项目，访问http://localhost:8080/swagger-ui.html即可（端口根据自己的项目自行调整）

如果还是有url被拦截，打开浏览器——F12——Network，F5一下查看哪些url被拦了，然后根据被拦截的url前缀调整开放。