记录在springboot项目中导入swagger框架,以及遇见的问题

swagger在springboot项目中的使用,
1,引入配置类

package com.br.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;

/**
 * swagger配置类
 *
 */
@Configuration
@EnableSwagger2
public class Swagger2Config {
	
	@Bean
    public Docket demoApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.bri.controller"))
                .paths(PathSelectors.any())
                .build()
                .apiInfo(apiInfo());

    }


	private ApiInfo apiInfo() {
		return new ApiInfoBuilder()
				.title("挽歌")
				.description("傲慢与偏见,http://www.baidu.com")
				.termsOfServiceUrl("http://www.baidu.com")
				.version("1.0")
				.build();
	}
}

2,在pom.xml文件中引入相关依赖如下

<!--swagger相关依赖  -->
          <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.7.0</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.7.0</version>
        </dependency>

3,访问http://ip:端口/swagger-ui.html

@Api 的description 即将被弃用,因此网上搜索了它的替代者tags但是出现了在swagger-ui界面点不开方法的问题
之前用的2.6.1版本,改为2.7.0版本,并且重新启动项目,刷新swagger-ui,方法就可以正常点开了

后期开发过程中用到了拦截器,此时出现错误 “swagger No mapping for GET /swagger-ui.html”,
查找资料后解决办法如下,在原来的拦截器中重写addResourceHandlers方法

package com.example.demo.config;

import com.example.demo.util.MyInterceptor;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
@EnableWebMvc
public class InterceptorConfig implements WebMvcConfigurer {




        /**
         * 在这里添加自己定义的拦截器
         * @param registry
         */
        @Override
        public void addInterceptors(InterceptorRegistry registry) {
            registry.addInterceptor(new MyInterceptor())
                    // 只拦截test路径
                    .addPathPatterns("/user/**")
                    // 不拦截pass路径
                    .excludePathPatterns("/pass/**");
        }

    //解决拦截器拦截swagger请求的问题
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("swagger-ui.html")
                .addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/");
    }

}