springBoot 集成knife4j

        1.导入依赖

   <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-spring-boot-starter</artifactId>
            <version>2.0.7</version>
        </dependency>

2.配置swgger2

@Slf4j
@Configuration
@EnableSwagger2WebMvc
public class SwaggerConfig implements WebMvcConfigurer {

    @Value("${spring.application.name}")
    private String applicationName;

    @Bean
    public Docket docket() {
        // 指定使用Swagger2规范
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(new ApiInfoBuilder()
                        // 简介(支持Markdown语法)
                        .description("描述信息xxxxx")
                        // 服务地址
                        .termsOfServiceUrl("http://localhost.com/")
                        // 作者及联系信息
                        .contact(new Contact("作者", "访问地址", "邮箱"))
                        // api版本
                        .version("1.0.0")
                        .build())
                //分组名称(微服务项目可以用微服务名分组)
                .groupName(applicationName)
                .select()
                // 定位api
                .apis(
                        RequestHandlerSelectors.basePackage("com.qy.controller")
                                .or(RequestHandlerSelectors.withClassAnnotation(RestController.class)
                                       //.or(RequestHandlerSelectors.withClassAnnotation(Controller.class))
                                )
                )
                .paths(PathSelectors.any())
                .build();
    }
    
}

3.拦截器放行资源

 @Override
    public void addInterceptors(InterceptorRegistry registry) {


        // 对swagger的请求不进行拦截
        String[] excludePatterns = new String[]{"/swagger-resources/**", "/webjars/**", "/v2/**", "/swagger-ui.html/**",
                "/api", "/api-docs", "/api-docs/**", "/doc.html/**"};
        registry.addInterceptor(jwtInterceptor())
                // 拦截所有请求
                .addPathPatterns("/**")
                // 排除指定请求
                .excludePathPatterns("/verification/**")
                .excludePathPatterns(excludePatterns);

    }

4.yml中开启knife4j

knife4j:
  enable: true

5.日志打印文档地址

@Component
@Slf4j
public class ServerConfig implements ApplicationListener<WebServerInitializedEvent> {

    private int serverPort;

    public int getServerPort() {
        return serverPort;
    }

    @Override
    public void onApplicationEvent(WebServerInitializedEvent webServerInitializedEvent) {

        try {
            InetAddress localHost = Inet4Address.getLocalHost();
            this.serverPort = webServerInitializedEvent.getWebServer().getPort();
            log.info("项目启动成功,接口文档地址:"+"http://"+localHost.getHostAddress()+":"+serverPort+"/doc.html");
        } catch (UnknownHostException e) {
            throw new RuntimeException(e);
        }
    }
}

补充,如果拦截器还是拦截接口文档请求,可以在拦截器中通过,request.getRequestURI(); 获取拦截的路径,并对其进行放行

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 1
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值