springboot3整合knife4j 4.4.0记录,拦截器放行路径配置

1、引入依赖

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

2、在application.xml中进行配置,需要修改packages-to-scan,其他的默认即可

# springdoc-openapi项目配置
springdoc:
  swagger-ui:
    path: /swagger-ui.html
    tags-sorter: alpha
    operations-sorter: alpha
  api-docs:
    path: /v3/api-docs
  group-configs:
    - group: 'default'
      paths-to-match: '/**'
      # 需要修改的是这部分,改为自己的controller所在的位置
      packages-to-scan: com.xiaominfo.knife4j.demo.web
# knife4j的增强配置,不需要增强可以不配
knife4j:
  enable: true
  setting:
    language: zh_cn

3、knife4j配置类,对接口文档首页进行一些配置,不配置也可运行。

import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Info;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class Knife4jConfig {
    @Bean
    public OpenAPI customOpenAPI() {

        return new OpenAPI()
                .info(new Info()
                        .title("接口文档")
                        .version("1.0")
                        .description("接口文档")
                );
    }

}

4、上述是一个基本的配置步骤了,但是我的系统中会有登录拦截器,所以在一开始没有在拦截器配置放行路径的时候会一直报错401,配置代码如下:

@Configuration
public class WebConfig implements WebMvcConfigurer {
    @Autowired
    private LoginInterceptor loginInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 配置拦截器放行路径 
        registry.addInterceptor(loginInterceptor).excludePathPatterns("/doc.html", "/webjars/**", "/v3/api-docs/**", "/swagger-ui.html");
    }

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        // 配置拦截器访问静态资源
        registry.addResourceHandler("doc.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/favicon.ico").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
    }
}

  • 2
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
你好!要将Spring Boot 3与Knife4j 4.0.0集成,你可以按照以下步骤进行操作: 1. 首先,在你的Spring Boot项目中添加Knife4j的依赖。在pom.xml文件中添加以下依赖项: ```xml <dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>knife4j-spring-boot-starter</artifactId> <version>4.0.0</version> </dependency> ``` 2. 接下来,你需要创建一个配置类来配置Knife4j。在你的项目中创建一个名为`SwaggerConfig`(或者你自己喜欢的名字)的类,并添加`@Configuration`和`@EnableKnife4j`注解,如下所示: ```java @Configuration @EnableKnife4j public class SwaggerConfig { // 配置内容 } ``` 3. 在配置类中,你可以根据需要对Knife4j进行更多的自定义设置。以下是一些常用的配置选项: - 配置接口文档的标题、描述等信息: ```java @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) // 其他配置项 .select() .apis(RequestHandlerSelectors.basePackage("com.example.controller")) .paths(PathSelectors.any()) .build(); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("API文档") .description("这是一个示例API文档") .version("1.0.0") .build(); } ``` - 配置接口文档的访问路径: ```java @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .pathMapping("/") // 其他配置项 .select() .apis(RequestHandlerSelectors.basePackage("com.example.controller")) .paths(PathSelectors.any()) .build(); } ``` - 配置接口文档的安全认证: ```java @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .securitySchemes(Lists.newArrayList(apiKey())) .securityContexts(Lists.newArrayList(securityContext())) // 其他配置项 .select() .apis(RequestHandlerSelectors.basePackage("com.example.controller")) .paths(PathSelectors.any()) .build(); } private ApiKey apiKey() { return new ApiKey("token", "token", "header"); } private SecurityContext securityContext() { return SecurityContext.builder() .securityReferences(defaultAuth()) .forPaths(PathSelectors.regex("^(?!auth).*$")) .build(); } private List<SecurityReference> defaultAuth() { AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything"); AuthorizationScope[] authorizationScopes = new AuthorizationScope[1]; authorizationScopes[0] = authorizationScope; return Lists.newArrayList(new SecurityReference("token", authorizationScopes)); } ``` 4. 配置完成后,你可以启动你的Spring Boot应用程序,并访问`http://localhost:8080/doc.html`(根据你的配置进行相应调整)来查看生成的接口文档。 希望以上步骤对你有帮助!如果还有其他问题,请随时提问。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值