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内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 使用Java实现自动调整Excel行高和列宽

    使用Java实现自动调整Excel行高和列宽

    在处理 Excel 文件时,自动调整行高和列宽是一项常见的需求,本文将介绍如何使用 Java 来自动调整 Excel 文件中的行高和列宽,文中的示例代码讲解详细,感兴趣的小伙伴可以了解下
    2026-01-01
  • SpringBoot3集成ElasticSearch的方法详解

    SpringBoot3集成ElasticSearch的方法详解

    Elasticsearch是一个分布式、RESTful风格的搜索和数据分析引擎,适用于各种数据类型,数字、文本、地理位置、结构化数据、非结构化数据,本文给大家详解介绍了SpringBoot3集成ElasticSearch的方法,需要的朋友可以参考下
    2023-08-08
  • SpringBoot整合aws的示例代码

    SpringBoot整合aws的示例代码

    本文通过实例代码给大家介绍SpringBoot整合aws的全过程,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧
    2021-12-12
  • jvm添加自定义dns实现过程示例

    jvm添加自定义dns实现过程示例

    这篇文章主要为大家介绍了jvm添加自定义dns实现过程示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-08-08
  • Java中的异步非阻塞AIO模型详解

    Java中的异步非阻塞AIO模型详解

    这篇文章主要介绍了Java中的异步非阻塞AIO模型详解,AIO需要操作系统的支持,在linux内核2.6版本中加入了对真正异步IO的支持,java从jdk1.7开始支持AIO,本文提供了部分实现代码,需要的朋友可以参考下
    2023-09-09
  • @Slf4j 如何实现日志输入到外部文件

    @Slf4j 如何实现日志输入到外部文件

    这篇文章主要介绍了@Slf4j 如何实现日志输入到外部文件,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-12-12
  • 使用Log4j2代码方式配置实现线程级动态控制

    使用Log4j2代码方式配置实现线程级动态控制

    这篇文章主要介绍了使用Log4j2代码方式配置实现线程级动态控制,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-12-12
  • 详解Java读取Jar中资源文件及示例代码

    详解Java读取Jar中资源文件及示例代码

    这篇文章主要介绍了详解Java读取Jar中资源文件及实现代码的相关资料,在开发java项目的时候,经常会用到jar包,这里就说下如何读取,需要的朋友可以参考下
    2017-07-07
  • Mybatis-Plus同时使用逻辑删除和唯一索引的问题及解决办法(报数据重复Duplicate entry的问题)

    Mybatis-Plus同时使用逻辑删除和唯一索引的问题及解决办法(报数据重复Duplicate entry的

    在开发中,我们经常会有逻辑删除和唯一索引同时使用的情况,但当使用mybatis plus时,如果同时使用逻辑删除和唯一索引,会报数据重复Duplicate entry的问题,如何解决这个问题呢,小编给大家分享Mybatis-Plus同时使用逻辑删除和唯一索引的问题及解决办法,一起看看吧
    2023-11-11
  • hadoop的wordcount实例代码

    hadoop的wordcount实例代码

    这篇文章主要介绍了hadoop的wordcount实例代码,分享了相关代码示例,小编觉得还是挺不错的,具有一定借鉴价值,需要的朋友可以参考下
    2018-02-02

最新评论