springboot3整合knife4j详细图文教程(swagger增强)

 更新时间:2024年03月11日 09:13:31   作者: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内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Jmeter如何将每次测试的结果保存到文件中

    Jmeter如何将每次测试的结果保存到文件中

    这篇文章主要介绍了Jmeter如何将每次测试的结果保存到文件中的问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-03-03
  • springboot如何集成Swagger2

    springboot如何集成Swagger2

    这篇文章主要介绍了springboot集成Swagger2的方法,帮助大家更好的理解和使用springboot框架,感兴趣的朋友可以了解下
    2020-12-12
  • springboot构造树形结构数据并查询的方法

    springboot构造树形结构数据并查询的方法

    本文主要介绍了springboot怎样构造树形结构数据并查询,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-11-11
  • Java如何通过jstack命令查询日志

    Java如何通过jstack命令查询日志

    在分析线上问题时常使用到jstack <PID>命令将当时Java应用程序的线程堆栈dump出来,面对jstack 日志,我们如何查看?下面小编给大家介绍下Java如何通过jstack命令查询日志,感兴趣的朋友一起看看吧
    2023-03-03
  • mybatis如何实现saveOrUpdate

    mybatis如何实现saveOrUpdate

    这篇文章主要介绍了mybatis如何实现saveOrUpdate问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-02-02
  • SpringBoot通过请求对象获取输入流无数据

    SpringBoot通过请求对象获取输入流无数据

    这篇文章主要介绍了使用SpringBoot通过请求对象获取输入流无数据,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-03-03
  • springboot vue测试平台接口定义前后端新增功能实现

    springboot vue测试平台接口定义前后端新增功能实现

    这篇文章主要介绍了springboot vue测试平台接口定义前后端新增功能实现,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-05-05
  • JDBC连接mysql乱码异常问题处理总结

    JDBC连接mysql乱码异常问题处理总结

    这篇文章主要介绍了JDBC连接mysql乱码异常问题处理的办法和思路,有需要的朋友参考学习下。
    2017-12-12
  • Maven 多模块父子工程的实现(含Spring Boot示例)

    Maven 多模块父子工程的实现(含Spring Boot示例)

    这篇文章主要介绍了Maven 多模块父子工程的实现(含Spring Boot示例),文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-04-04
  • 解决Netty解码http请求获取URL乱码问题

    解决Netty解码http请求获取URL乱码问题

    这篇文章主要介绍了解决Netty解码http请求获取URL乱码问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-06-06

最新评论