springboot3整合knife4j(swagger增强)

        springboot升级到3后之前的knife4j配置就要变了一下了

1.导入依赖

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

        <version>4.1.0</version>
</dependency>

2.创建配置文件

import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Contact;
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 springShopOpenAPI() {
        return new OpenAPI()
                // 接口文档标题
                .info(
                        new Info().title("接口文档")
                        // 接口文档简介
                        .description("Knife4j OpenApi3的接口文档")
                        // 接口文档版本
                        .version("v1.0")
                        // 开发者联系方式
                        .contact(new Contact().name("").email(""))
                );
    }
}

3.controller上注解变了

@Tag(name = "首页")
public class HomeController {

        controller方法上的注解 

@Operation(summary = "获取xxx")
public Result<xxx> getxxx(){

4.实体类应用的注解也变了

@Data
@Schema(name = "XXX")
public class XXXVO{

    @Id
    @Schema(description = "")
    private Integer id ;

    /** 父级id */
    @Schema(description = "父级id")
    private Integer pid ;
}
  • 11
    点赞
  • 13
    收藏
    觉得还不错? 一键收藏
  • 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、付费专栏及课程。

余额充值