springboot3整合knife4j详细图文教程(swagger增强)
作者：LB_bei
开发api提供对应的接口规范进行联调或并行开发,api文档管理必不可少,常用的Knife4j基于swagger(依赖已经compile),可以进行管理,下面这篇文章主要给大家介绍了关于springboot3整合knife4j的相关资料,需要的朋友可以参考下
前言
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 ;
}总结
到此这篇关于springboot3整合knife4j的文章就介绍到这了,更多相关springboot3整合knife4j内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！